Class WmfImage

Namespace

Aspose.Imaging.FileFormats.Wmf

Assembly

Aspose.Imaging.dll

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, IDisposable, IObjectWithBounds, IObjectWithSizeF

Inheritance

object

DisposableObject

DataStreamSupporter

Image

VectorImage

MetaImage

WmfImage

Implements

IDisposable

IObjectWithBounds

IObjectWithSizeF

Inherited Members

MetaImage.GetMissedFonts()

MetaImage.Crop(int, int, int, int)

MetaImage.GetCanNotSaveMessage(ImageOptionsBase)

MetaImage.Records

VectorImage.GetEmbeddedImages()

VectorImage.RemoveBackground()

VectorImage.RemoveBackground(RemoveBackgroundSettings)

VectorImage.SizeF

VectorImage.WidthF

VectorImage.HeightF

Image.CanLoad(string)

Image.CanLoad(string, LoadOptions)

Image.CanLoad(Stream)

Image.CanLoad(Stream, LoadOptions)

Image.Create(ImageOptionsBase, int, int)

Image.Create(Image[])

Image.Create(Image[], bool)

Image.GetFileFormat(string)

Image.GetFileFormat(Stream)

Image.GetFittingRectangle(Rectangle, int, int)

Image.GetFittingRectangle(Rectangle, int[], int, int)

Image.Load(string, LoadOptions)

Image.Load(string)

Image.Load(Stream, LoadOptions)

Image.Load(Stream)

Image.GetProportionalWidth(int, int, int)

Image.GetProportionalHeight(int, int, int)

Image.RemoveMetadata()

Image.CanSave(ImageOptionsBase)

Image.Resize(int, int)

Image.GetOriginalOptions()

Image.ResizeWidthProportionally(int)

Image.ResizeHeightProportionally(int)

Image.ResizeWidthProportionally(int, ResizeType)

Image.ResizeHeightProportionally(int, ResizeType)

Image.ResizeWidthProportionally(int, ImageResizeSettings)

Image.ResizeHeightProportionally(int, ImageResizeSettings)

Image.Save()

Image.Save(string)

Image.Save(string, ImageOptionsBase)

Image.Save(string, ImageOptionsBase, Rectangle)

Image.Save(Stream, ImageOptionsBase)

Image.Save(Stream, ImageOptionsBase, Rectangle)

Image.GetSerializedStream(ImageOptionsBase, Rectangle, out int)

Image.UpdateContainer(Image)

Image.GetFitRectangle(Rectangle)

Image.GetImage2Export(ImageOptionsBase, Rectangle, IImageExporter)

Image.GetFitRectangle(Rectangle, int[])

Image.OnPaletteChanged(IColorPalette, IColorPalette)

Image.OnPaletteChanging(IColorPalette, IColorPalette)

Image.ReleaseManagedResources()

Image.Bounds

Image.Container

Image.Palette

Image.UsePalette

Image.Size

Image.InterruptMonitor

Image.BufferSizeHint

Image.AutoAdjustPalette

Image.HasBackgroundColor

Image.BackgroundColor

DataStreamSupporter.timeout

DataStreamSupporter.Save(Stream)

DataStreamSupporter.Save(string, bool)

DataStreamSupporter.OnDataStreamContainerChanging(StreamContainer)

DataStreamSupporter.DataStreamContainer

DisposableObject.Dispose()

DisposableObject.ReleaseUnmanagedResources()

DisposableObject.VerifyNotDisposed()

DisposableObject.Disposed

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

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.

public WmfImage()

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.

public WmfImage(int width, int height)

Parameters

width int

The width.

height int

The height.

Properties

BitsPerPixel

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.

public override int BitsPerPixel { get; }

Property Value

int

The image bits per pixel count.

Exceptions

NotImplementedException

FileFormat

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.

public override FileFormat FileFormat { get; }

Property Value

FileFormat

FrameBounds

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.

public Rectangle FrameBounds { get; }

Property Value

Rectangle

The frame bounds.

Height

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.

public override int Height { get; }

Property Value

int

The image height.

Exceptions

NotImplementedException

Inch

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.

public int Inch { get; set; }

Property Value

int

The inch.

IsCached

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.

public override bool IsCached { get; }

Property Value

bool

true if object's data is cached; otherwise, false.

Exceptions

NotImplementedException

Width

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.

public override int Width { get; }

Property Value

int

The image width.

Exceptions

NotImplementedException

Methods

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.

public int AddRecord(WmfObject record)

Parameters

record WmfObject

The record.

Returns

int

Number of record.

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.

public override void CacheData()

Exceptions

NotImplementedException

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.

public override void Crop(Rectangle rectangle)

Parameters

rectangle Rectangle

The rectangle.

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.

public override ImageOptionsBase GetDefaultOptions(object[] args)

Parameters

args object[]

The arguments.

Returns

ImageOptionsBase

Default options

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.

public string GetPostScript()

Returns

string

The post script

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.

public override string[] GetUsedFonts()

Returns

string[]

The font list

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.

public override void Resize(int newWidth, int newHeight, ImageResizeSettings settings)

Parameters

newWidth int

The new width.

newHeight int

The new height.

settings ImageResizeSettings

The resize settings.

Exceptions

NotImplementedException

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.

public override void Resize(int newWidth, int newHeight, ResizeType resizeType)

Parameters

newWidth int

The new width.

newHeight int

The new height.

resizeType ResizeType

The resize type.

Exceptions

NotImplementedException

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.

public override void ResizeCanvas(Rectangle newRectangle)

Parameters

newRectangle Rectangle

The new rectangle.

Exceptions

NotImplementedException

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.

public override void RotateFlip(RotateFlipType rotateFlipType)

Parameters

rotateFlipType RotateFlipType

Type of the rotate flip.

Exceptions

NotImplementedException

SaveData(Stream)

Saves the data.

protected override void SaveData(Stream stream)

Parameters

stream Stream

The stream to save data to.

Exceptions

NotImplementedException

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.

public override void SetPalette(IColorPalette palette, bool updateColors)

Parameters

palette IColorPalette

The palette to set.

updateColors bool

if set to true colors will be updated according to the new palette; otherwise color indexes remain unchanged. Note that unchanged indexes may crash the image on loading if some indexes have no corresponding palette entries.

Exceptions

NotImplementedException