WmfImage

WmfImage class

Manipulate Microsoft Windows Metafile (WMF) images with our API, seamlessly handling both vector and bitmap data stored within variable-length records. Resize, rotate, and flip images with ease while setting custom image palettes. Convert WMF files to compressed WMZ formats or save them in raster image formats for versatile usage across platforms and applications.

public class WmfImage : MetaImage

Constructors

Name	Description
WmfImage()	Create a new instance of the `WmfImage` class, initializing it for further manipulation and processing of Windows Metafile (WMF) image data. This constructor provides a foundational object for working with WMF images, enabling seamless integration of WMF image handling capabilities into your application’s functionality.
WmfImage(int, int)	Instantiate a new instance of the `WmfImage` class with customizable width and height parameters, facilitating the creation of blank WMF images tailored to specific dimensions. Utilize this constructor to dynamically generate WMF images with precise dimensions, enabling flexible image creation and manipulation within your application.

Properties

Name	Description
AutoAdjustPalette { get; set; }	Gets or sets a value indicating whether automatic adjust palette.
virtual BackgroundColor { get; set; }	Gets or sets a value for the background color.
override BitsPerPixel { get; }	Retrieve the count of bits per pixel for the image, indicating the level of color depth or granularity. Utilize this property to determine the image’s color representation and precision, facilitating compatibility checks and color-related processing within your application.
Bounds { get; }	Gets the image bounds.
BufferSizeHint { get; set; }	Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
Container { get; }	Gets the `Image` container.
DataStreamContainer { get; }	Gets the object’s data stream.
Disposed { get; }	Gets a value indicating whether this instance is disposed.
override FileFormat { get; }	Access the file format value associated with the image, providing information about the format in which the image is stored. Utilize this property to determine the file format of the image, facilitating compatibility checks and format-specific processing within your application.
FrameBounds { get; }	Access the bounds of the frame, indicating its position and dimensions within the image. Utilize this property to retrieve detailed information about the frame’s spatial location, enabling precise manipulation and rendering within your application.
virtual HasBackgroundColor { get; set; }	Gets or sets a value indicating whether image has background color.
override Height { get; }	Access the image’s height, representing the number of pixels along its vertical axis. Utilize this property to ascertain the image’s spatial dimensions and aspect ratio, enabling accurate layout and rendering adjustments within your application.
virtual HeightF { get; }	Gets the object height, in inches.
Inch { get; set; }	Access or modify the inch property, representing a unit of measurement typically used for specifying physical dimensions in print or display contexts. Utilize this property to establish or retrieve inch values associated with the image, facilitating accurate representation of physical dimensions within your application.
InterruptMonitor { get; set; }	Gets or sets the interrupt monitor.
override IsCached { get; }	Retrieve a boolean value indicating whether the object’s data is currently cached, eliminating the need for additional data reading operations. Utilize this property to optimize performance by determining if the object’s data is readily available without the need for costly data retrieval processes within your application.
Palette { get; set; }	Gets or sets the color palette. The color palette is not used when pixels are represented directly.
virtual Records { get; set; }	Gets or sets the records.
Size { get; }	Gets the image size.
SizeF { get; }	Gets the object size, in inches.
virtual UsePalette { get; }	Gets a value indicating whether the image palette is used.
override Width { get; }	Access the width of the image, indicating the number of pixels along its horizontal axis. Utilize this property to determine the image’s spatial dimensions and aspect ratio, enabling precise layout and rendering adjustments within your application.
virtual WidthF { get; }	Gets the object width, in inches.

Methods

Name	Description
AddRecord(WmfObject)	Incorporate the specified record object into the image, enriching its content with additional data or metadata. Utilize this method to seamlessly integrate record objects into the image, facilitating comprehensive data storage and organization within your application.
override CacheData()	Efficiently cache the data, eliminating the need for additional loading from the underlying `DataStreamContainer`. Utilize this method to optimize performance and minimize resource usage within your application by storing and accessing local data cache.
CanSave(ImageOptionsBase)	Determines whether image can be saved to the specified file format represented by the passed save options.
override Crop(Rectangle)	Crop the image to the specified rectangle, retaining only the selected region while discarding the rest. Integrate this method into your image processing workflow to extract specific areas of interest and customize the composition of the image within your application.
virtual Crop(int, int, int, int)	Crop image with shifts.
Dispose()	Disposes the current instance.
override GetDefaultOptions(object[])	Retrieve the default options associated with the image, providing access to predefined settings or configurations. Utilize this method to access default settings for image processing operations, facilitating consistency and convenience within your application’s functionality.
virtual GetEmbeddedImages()	Gets the embedded images.
GetMissedFonts()	Returns the list of fonts which used inside metafile but not found.
virtual GetOriginalOptions()	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` 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` method as the second parameter.
GetPostScript()	Access the PostScript data associated with the image, providing detailed information about its structure or content. Utilize this method to retrieve PostScript data for further analysis or processing within your application, enabling advanced functionality related to PostScript rendering or manipulation.
virtual GetSerializedStream(ImageOptionsBase, Rectangle, out int)	Converts to aps.
override GetUsedFonts()	Retrieve the list of fonts used within the metafile, providing insight into the font resources utilized in the image. Utilize this method to analyze font usage and ensure font availability for rendering or further processing within your application.
RemoveBackground()	Removes the background.
RemoveBackground(RemoveBackgroundSettings)	Removes the background.
Resize(int, int)	Resizes the image. The default NearestNeighbourResample is used.
override Resize(int, int, ImageResizeSettings)	Adjust the size of the image based on specified settings, enabling precise control over dimensions, aspect ratio, and scaling behavior. Integrate this method into your image processing workflow to achieve customized resizing operations tailored to the specific requirements of your application.
override Resize(int, int, ResizeType)	Resize the image with the specified resizing type, allowing for flexible adjustment of dimensions while preserving aspect ratio or applying specific scaling algorithms. Integrate this method into your image processing workflow to achieve precise resizing operations tailored to your application’s requirements.
override ResizeCanvas(Rectangle)	Resize the canvas of the image, adjusting its dimensions while retaining the image content. Utilize this method to modify the size of the canvas without altering the content, facilitating layout adjustments and composition changes within your application.
ResizeHeightProportionally(int)	Resizes the height proportionally. The default NearestNeighbourResample is used.
virtual ResizeHeightProportionally(int, ImageResizeSettings)	Resizes the height proportionally.
virtual ResizeHeightProportionally(int, ResizeType)	Resizes the height proportionally.
ResizeWidthProportionally(int)	Resizes the width proportionally. The default NearestNeighbourResample is used.
virtual ResizeWidthProportionally(int, ImageResizeSettings)	Resizes the width proportionally.
virtual ResizeWidthProportionally(int, ResizeType)	Resizes the width proportionally.
override RotateFlip(RotateFlipType)	Perform rotation, flipping, or a combination of both operations on the image. Integrate this method into your image processing workflow to achieve precise manipulation of image orientation and alignment within your application.
Save()	Saves the image data to the underlying stream.
Save(Stream)	Saves the object’s data to the specified stream.
override Save(string)	Saves the image to the specified file location.
Save(Stream, ImageOptionsBase)	Saves the image’s data to the specified stream in the specified file format according to save options.
virtual Save(string, bool)	Saves the object’s data to the specified file location.
virtual Save(string, ImageOptionsBase)	Saves the object’s data to the specified file location in the specified file format according to save options.
virtual Save(Stream, ImageOptionsBase, Rectangle)	Saves the image’s data to the specified stream in the specified file format according to save options.
virtual Save(string, ImageOptionsBase, Rectangle)	Saves the object’s data to the specified file location in the specified file format according to save options.
override SetPalette(IColorPalette, bool)	Apply a specified palette to the image, enabling customization of color representation. Utilize this method to enhance visual rendering and achieve specific color effects within your application.

Examples

The following example shows how to convert a wmz images to wmf fromat

[C#]

string file = "example.wmz";
string baseFolder = System.IO.Path.Combine("D:", "Compressed");
string inputFile = System.IO.Path.Combine(baseFolder, file);
string outFile = inputFile + ".wmf";
using (Aspose.Imaging.Image image = Aspose.Imaging.Image.Load(inputFile))
{
    Aspose.Imaging.ImageOptions.VectorRasterizationOptions vectorRasterizationOptions = new Aspose.Imaging.ImageOptions.WmfRasterizationOptions() { PageSize = image.Size};
    image.Save(outFile, new Aspose.Imaging.ImageOptions.WmfOptions() {VectorRasterizationOptions = vectorRasterizationOptions});
}

The following example shows how to convert a wmf images to wmz fromat

[C#]

string file = "castle.wmf";
string baseFolder = System.IO.Path.Combine("D:", "Compressed");
string inputFile = System.IO.Path.Combine(baseFolder, file);
string outFile = inputFile + ".wmz";
using (Aspose.Imaging.Image image = Aspose.Imaging.Image.Load(inputFile))
{
    Aspose.Imaging.ImageOptions.VectorRasterizationOptions vectorRasterizationOptions = new Aspose.Imaging.ImageOptions.WmfRasterizationOptions() { PageSize = image.Size};
    image.Save(outFile, new Aspose.Imaging.ImageOptions.WmfOptions() {VectorRasterizationOptions = vectorRasterizationOptions, Compress = true});
}

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});
    }
}

This example shows how to load a WMF image from a file and convert it to SVG using WmfRasterizationOptions.

[C#]

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

// Using Aspose.Imaging.Image.Load is a unified way to load all types of images including WMF.
using (Aspose.Imaging.FileFormats.Wmf.WmfImage wmfImage = (Aspose.Imaging.FileFormats.Wmf.WmfImage)Aspose.Imaging.Image.Load(dir + "test.wmf"))
{
    Aspose.Imaging.ImageOptions.SvgOptions saveOptions = new Aspose.Imaging.ImageOptions.SvgOptions();
        
    // Text will be converted to shapes.
    saveOptions.TextAsShapes = true;

    Aspose.Imaging.ImageOptions.WmfRasterizationOptions rasterizationOptions = new Aspose.Imaging.ImageOptions.WmfRasterizationOptions();

    // The background color of the drawing surface.
    rasterizationOptions.BackgroundColor = Aspose.Imaging.Color.WhiteSmoke;

    // The page size.
    rasterizationOptions.PageSize = wmfImage.Size;

    // If embedded emf exists, then render emf; otherwise render wmf.
    rasterizationOptions.RenderMode = Aspose.Imaging.FileFormats.Wmf.WmfRenderMode.Auto;

    saveOptions.VectorRasterizationOptions = rasterizationOptions;

    wmfImage.Save(dir + "test.output.svg", saveOptions);
}