FromWmf(IntPtr,int,int,RasterColor) Method

Summary

Converts a Windows Metafile (WMF) into a LEADTOOLS Leadtools.RasterImage object.

Syntax

C++

public static RasterImage FromWmf( 
   IntPtr hwmf, 
   int width, 
   int height, 
   RasterColor backColor 
)

Public Overloads Shared Function FromWmf( _ 
   ByVal hwmf As IntPtr, _ 
   ByVal width As Integer, _ 
   ByVal height As Integer, _ 
   ByVal backColor As RasterColor _ 
) As RasterImage

public: 
static RasterImage^ FromWmf(  
   IntPtr hwmf, 
   int width, 
   int height, 
   RasterColor backColor 
)

Parameters

hwmf
Handle to the WMF to be converted.

width
Amount by which to scale the metafile's original width.

height
Amount by which to scale the metafile's original height.

backColor
The color to use to fill the image area before painting the metafile objects.

Return Value

The newly created Leadtools.RasterImage object.

Remarks

Some metafiles do not have a background color, and hence, when the metafile is used to create a Leadtools.RasterImage object, the area not covered by the metafile objects will contain the default image background color (black). To create a raster image from a metafile like this with a specific background color, set the desired background color in the backColor parameter.

When this method is completed, there are two copies of the drawing in memory: the new Leadtools.RasterImage object and the original WMF. Freeing one will not affect the other.

The metafile can be loaded at the original dimension or scaled by using the width and height parameters.

If width == 0 and height == 0 - the metafile is loaded at the size present in the file.

If width == 0 and height > 0 - the metafile is stretched so that it has the height height (preserving the aspect ratio).

If width > 0 and height == 0 - the metafile is stretched so that it has the width width (preserving the aspect ratio).

If width > 0 and height > 0 - the metafile is stretched so that it has the width width and height height (the aspect ratio is ignored).

This method does not support signed images.

For more information refer to RasterImage and GDI/GDI+.

Example

For an example, refer to FromWmf(IntPtr, int, int).

Requirements

Target Platforms