SvgImage Class
Represents SVG image class.
Inheritance Hierarchy

Namespace: Aspose.Imaging.FileFormats.Svg
Assembly: Aspose.Imaging (in Aspose.Imaging.dll) Version: 21.05
Syntax
public sealed class SvgImage : VectorImage

The SvgImage type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleSvgImage(Stream)
Initializes a new instance of the SvgImage class.
Public methodSvgImage(String)
Initializes a new instance of the SvgImage class.
Public methodSvgImage(Int32, Int32)
Initializes a new instance of the SvgImage class.
Public methodSvgImage(SvgOptions, Int32, Int32)
Initializes a new instance of the SvgImage class.
Properties
  NameDescription
Public propertyAutoAdjustPalette
Gets or sets a value indicating whether automatic adjust palette.
(Inherited from Image.)
Public propertyBackgroundColor
Gets or sets a value for the background color.
(Inherited from Image.)
Public propertyBitsPerPixel
Gets the image bits per pixel count this parameter is not applicable to vector images
(Overrides ImageBitsPerPixel.)
Public propertyBounds
Gets the image bounds.
(Inherited from Image.)
Public propertyBufferSizeHint
Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
(Inherited from Image.)
Public propertyContainer
Gets the Image container.
(Inherited from Image.)
Public propertyDataStreamContainer
Gets the object's data stream.
(Inherited from DataStreamSupporter.)
Public propertyDisposed
Gets a value indicating whether this instance is disposed.
(Inherited from DisposableObject.)
Public propertyFileFormat
Gets a value of file format
(Overrides ImageFileFormat.)
Public propertyHasBackgroundColor
Gets or sets a value indicating whether image has background color.
(Inherited from Image.)
Public propertyHeight
Gets the image height.
(Overrides VectorImageHeight.)
Public propertyHeightF
Gets the object height, in inches.
(Inherited from VectorImage.)
Public propertyInterruptMonitor
Gets or sets the interrupt monitor.
(Inherited from Image.)
Public propertyIsCached
Gets a value indicating whether object's data is cached currently and no data reading is required.
(Overrides DataStreamSupporterIsCached.)
Public propertyPalette
Gets or sets the color palette. The color palette is not used when pixels are represented directly.
(Inherited from Image.)
Public propertyCode exampleSize
Gets the image size.
(Inherited from Image.)
Public propertySizeF
Gets the object size, in inches.
(Inherited from VectorImage.)
Public propertyCode exampleUsePalette
Gets a value indicating whether the image palette is used.
(Inherited from Image.)
Public propertyWidth
Gets the image width.
(Overrides VectorImageWidth.)
Public propertyWidthF
Gets the object width, in inches.
(Inherited from VectorImage.)
Methods
  NameDescription
Public methodCacheData
Caches the data and ensures no additional data loading will be performed from the underlying DataStreamContainer.
(Overrides DataStreamSupporterCacheData.)
Public methodCode exampleCanSave
Determines whether image can be saved to the specified file format represented by the passed save options.
(Inherited from Image.)
Public methodCode exampleDispose
Disposes the current instance.
(Inherited from DisposableObject.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetDefaultOptions
Gets the default options.
(Overrides ImageGetDefaultOptions(Object).)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetOriginalOptions
Gets the options based on the original file settings. This can be helpful to keep bit-depth and other parameters of the original image unchanged. For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the Save(String) method, the output PNG image with 8-bit per pixel will be produced. To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them to the Save(String, ImageOptionsBase) method as the second parameter.
(Inherited from Image.)
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Public methodCode exampleResize(Int32, Int32)
Resizes the image. The default LeftTopToLeftTop is used.
(Inherited from Image.)
Public methodResize(Int32, Int32, ImageResizeSettings)
Resizes the image.
(Overrides ImageResize(Int32, Int32, ImageResizeSettings).)
Public methodResize(Int32, Int32, ResizeType)
Resizes the image.
(Overrides ImageResize(Int32, Int32, ResizeType).)
Public methodResizeHeightProportionally(Int32)
Resizes the height proportionally.
(Inherited from Image.)
Public methodResizeHeightProportionally(Int32, ImageResizeSettings)
Resizes the height proportionally.
(Inherited from Image.)
Public methodCode exampleResizeHeightProportionally(Int32, ResizeType)
Resizes the height proportionally.
(Inherited from Image.)
Public methodResizeWidthProportionally(Int32)
Resizes the width proportionally.
(Inherited from Image.)
Public methodResizeWidthProportionally(Int32, ImageResizeSettings)
Resizes the width proportionally.
(Inherited from Image.)
Public methodCode exampleResizeWidthProportionally(Int32, ResizeType)
Resizes the width proportionally.
(Inherited from Image.)
Public methodRotateFlip
Rotates, flips, or rotates and flips the image.
(Overrides ImageRotateFlip(RotateFlipType).)
Public methodCode exampleSave
Saves the image data to the underlying stream.
(Inherited from Image.)
Public methodSave(Stream)
Saves the object's data to the specified stream.
(Inherited from DataStreamSupporter.)
Public methodSave(String)
Saves the object's data to the specified file location.
(Inherited from DataStreamSupporter.)
Public methodSave(String, Boolean)
Saves the object's data to the specified file location.
(Inherited from DataStreamSupporter.)
Public methodCode exampleSave(Stream, ImageOptionsBase)
Saves the image's data to the specified stream in the specified file format according to save options.
(Inherited from Image.)
Public methodCode exampleSave(String, ImageOptionsBase)
Saves the object's data to the specified file location in the specified file format according to save options.
(Inherited from Image.)
Public methodCode exampleSave(Stream, ImageOptionsBase, Rectangle)
Saves the image's data to the specified stream in the specified file format according to save options.
(Inherited from Image.)
Public methodCode exampleSave(String, ImageOptionsBase, Rectangle)
Saves the object's data to the specified file location in the specified file format according to save options.
(Inherited from Image.)
Public methodSetPalette
Sets the image palette.
(Overrides ImageSetPalette(IColorPalette, Boolean).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Examples
The following example shows how to convert a svgz images to svg fromat
[C#]

string file = "example.svgz";
string baseFolder = System.IO.Path.Combine("D:", "Compressed");
string inputFile = System.IO.Path.Combine(baseFolder, file);
string outFile = inputFile + ".svg";
using (Aspose.Imaging.Image image = Aspose.Imaging.Image.Load(inputFile))
{
    Aspose.Imaging.ImageOptions.VectorRasterizationOptions vectorRasterizationOptions = new Aspose.Imaging.ImageOptions.SvgRasterizationOptions() { PageSize = image.Size};
    image.Save(outFile, new Aspose.Imaging.ImageOptions.SvgOptions() {VectorRasterizationOptions = vectorRasterizationOptions});
}
Examples
The following example shows how to convert a svg images to svgz fromat
[C#]

string file = "juanmontoya_lingerie.svg";
string baseFolder = System.IO.Path.Combine("D:", "Compressed");
string inputFile = System.IO.Path.Combine(baseFolder, file);
string outFile = inputFile + ".svgz";
using (Aspose.Imaging.Image image = Aspose.Imaging.Image.Load(inputFile))
{
    Aspose.Imaging.ImageOptions.VectorRasterizationOptions vectorRasterizationOptions = new Aspose.Imaging.ImageOptions.SvgRasterizationOptions() { PageSize = image.Size};
    image.Save(outFile, new Aspose.Imaging.ImageOptions.SvgOptions() {VectorRasterizationOptions = vectorRasterizationOptions, Compress = true});
}
Examples
This example shows how to load an SVG image from a file stream and rasterize it to PNG.
[C#]

string dir = "c:\\temp\\";

// Load an SVG image from a file stream.
using (System.IO.Stream stream = System.IO.File.OpenRead(dir + "test.svg"))
using (Aspose.Imaging.FileFormats.Svg.SvgImage svgImage = new Aspose.Imaging.FileFormats.Svg.SvgImage(stream))
{
    // In order to rasterize SVG we need to specify rasterization options.
    Aspose.Imaging.ImageOptions.SvgRasterizationOptions rasterizationOptions = new Aspose.Imaging.ImageOptions.SvgRasterizationOptions();
    Aspose.Imaging.ImageOptions.PngOptions saveOptions = new Aspose.Imaging.ImageOptions.PngOptions();
    saveOptions.VectorRasterizationOptions = rasterizationOptions;

    svgImage.Save(dir + "test.output.png", saveOptions);
}
Examples
The following example shows how to convert a compressed images (*.emz,*.wmz, *.svgz) to raster fromat
[C#]

string[] files = new[] {"example.emz", "example.wmz", "example.svgz"};
string baseFolder = System.IO.Path.Combine("D:","Compressed");
foreach (var file in files)
{
    string inputFile = System.IO.Path.Combine(baseFolder, file);
    string outFile = inputFile + ".png";
    using (Aspose.Imaging.Image image = Aspose.Imaging.Image.Load(inputFile))
    {
        Aspose.Imaging.ImageOptions.VectorRasterizationOptions vectorRasterizationOptions = (Aspose.Imaging.ImageOptions.VectorRasterizationOptions)image.GetDefaultOptions(new object[] { Color.White, image.Width, image.Height });
        image.Save(outFile, new Aspose.Imaging.ImageOptions.PngOptions(){VectorRasterizationOptions = vectorRasterizationOptions});
    }
}
See Also