WmfImage

Inheritance: java.lang.Object, com.aspose.imaging.DisposableObject, com.aspose.imaging.DataStreamSupporter, com.aspose.imaging.Image, com.aspose.imaging.VectorImage, com.aspose.imaging.fileformats.emf.MetaImage

public class WmfImage extends MetaImage

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.

Constructors

Constructor	Description
WmfImage()	Create a new instance of the WmfImage class, initializing it for further manipulation and processing of Windows Metafile (WMF) image data.
WmfImage(int width, int height)	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.

Methods

Method	Description
isCached()	Retrieve a boolean value indicating whether the object’s data is currently cached, eliminating the need for additional data reading operations.
getBitsPerPixel()	Retrieve the count of bits per pixel for the image, indicating the level of color depth or granularity.
getWidth()	Access the width of the image, indicating the number of pixels along its horizontal axis.
getHeight()	Access the image’s height, representing the number of pixels along its vertical axis.
getInch()	Access or modify the inch property, representing a unit of measurement typically used for specifying physical dimensions in print or display contexts.
setInch(int value)	Access or modify the inch property, representing a unit of measurement typically used for specifying physical dimensions in print or display contexts.
getFileFormat()	Access the file format value associated with the image, providing information about the format in which the image is stored.
getFrameBounds()	Access the bounds of the frame, indicating its position and dimensions within the image.
cacheData()	Efficiently cache the data, eliminating the need for additional loading from the underlying `DataStreamSupporter.DataStreamContainer`(DataStreamSupporter.getDataStreamContainer).
resize(int newWidth, int newHeight, 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.
resize(int newWidth, int newHeight, ImageResizeSettings settings)	Adjust the size of the image based on specified settings, enabling precise control over dimensions, aspect ratio, and scaling behavior.
rotateFlip(int rotateFlipType)	Perform rotation, flipping, or a combination of both operations on the image.
setPalette(IColorPalette palette, boolean updateColors)	Apply a specified palette to the image, enabling customization of color representation.
getUsedFonts()	Retrieve the list of fonts used within the metafile, providing insight into the font resources utilized in the image.
getDefaultOptions(Object[] args)	Retrieve the default options associated with the image, providing access to predefined settings or configurations.
crop(Rectangle rectangle)	Crop the image to the specified rectangle, retaining only the selected region while discarding the rest.
resizeCanvas(Rectangle newRectangle)	Resize the canvas of the image, adjusting its dimensions while retaining the image content.
addRecord(WmfObject record)	Incorporate the specified record object into the image, enriching its content with additional data or metadata.
getPostScript()	Access the PostScript data associated with the image, providing detailed information about its structure or content.

Example: The following example shows how to convert a compressed images (*.

The following example shows how to convert a compressed images (.emz,.wmz, *.svgz) to raster format

String[] files = new String[]{ "example.emz", "example.wmz", "example.svgz" };
String baseFolder = "D:\\Compressed\\";
for(String file : files)
{
    String inputFile = (baseFolder + file);
    String outFile = inputFile + ".png";
    try (com.aspose.imaging.Image image = com.aspose.imaging.Image.load(inputFile))
    {
        final com.aspose.imaging.imageoptions.VectorRasterizationOptions vectorRasterizationOptions = 
                (com.aspose.imaging.imageoptions.VectorRasterizationOptions) image.getDefaultOptions(new Object[]{Color.getWhite(), image.getWidth(), image.getHeight()});
        image.save(outFile, new com.aspose.imaging.imageoptions.PngOptions()
        {{
            setVectorRasterizationOptions(vectorRasterizationOptions);
        }});
    }
}

Example: The following example shows how to convert a wmz images to wmf format

String file = "example.wmz";
String baseFolder = "D:\\Compressed\\";
String inputFile = baseFolder + file;
String outFile = inputFile + ".wmf";
try (final com.aspose.imaging.Image image = com.aspose.imaging.Image.load(inputFile))
{
    final com.aspose.imaging.imageoptions.VectorRasterizationOptions vectorRasterizationOptions = new com.aspose.imaging.imageoptions.WmfRasterizationOptions()
    {{
        setPageSize(com.aspose.imaging.Size.to_SizeF(image.getSize()));
    }};
                
    image.save(outFile, new com.aspose.imaging.imageoptions.WmfOptions()
    {{
        setVectorRasterizationOptions(vectorRasterizationOptions);
    }});
}

Example: The following example shows how to convert a wmf images to wmz format

String file = "castle.wmf";
String baseFolder = "D:\\Compressed\\";
String inputFile = baseFolder + file;
String outFile = inputFile + ".wmz";
try (com.aspose.imaging.Image image = com.aspose.imaging.Image.load(inputFile))
{
    com.aspose.imaging.imageoptions.VectorRasterizationOptions vectorRasterizationOptions = new com.aspose.imaging.imageoptions.WmfRasterizationOptions();
    vectorRasterizationOptions.setPageSize(com.aspose.imaging.Size.to_SizeF(image.getSize()));
    com.aspose.imaging.imageoptions.WmfOptions options = new com.aspose.imaging.imageoptions.WmfOptions();
    options.setVectorRasterizationOptions(vectorRasterizationOptions);
    options.setCompress(true);
    image.save(outFile, options);
}

WmfImage()

public 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 width, int height)

public WmfImage(int width, int height)

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.

Parameters:

Parameter	Type	Description
width	int	The width.
height	int	The height.

isCached()

public boolean 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.

Returns: boolean

getBitsPerPixel()

public int getBitsPerPixel()

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.

Returns: int

getWidth()

public int getWidth()

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.

Returns: int - The image width in pixels.

getHeight()

public int getHeight()

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.

Returns: int - The image height in pixels.

getInch()

public int getInch()

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.

Returns: int

setInch(int value)

public void setInch(int value)

Parameters:

Parameter	Type	Description
value	int

getFileFormat()

public long getFileFormat()

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.

Returns: long

getFrameBounds()

public final Rectangle getFrameBounds()

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.

Returns: Rectangle - the frame bounds.

cacheData()

public void cacheData()

Efficiently cache the data, eliminating the need for additional loading from the underlying DataStreamSupporter.DataStreamContainer(DataStreamSupporter.getDataStreamContainer). Utilize this method to optimize performance and minimize resource usage within your application by storing and accessing local data cache.

Example: This example shows how to load a WMF image from a file and list all of its records.

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

// Using Aspose.Imaging.Image.Load is a unified way to load all types of images including WMF.
com.aspose.imaging.fileformats.wmf.WmfImage wmfImage = (com.aspose.imaging.fileformats.wmf.WmfImage) com.aspose.imaging.Image.load(dir + "test.wmf");
try {
    // Cache data to load all records.
    wmfImage.cacheData();
    System.out.println("The total number of records: " + wmfImage.getRecords().size());

    // The key is a record type, the value is number of records of that type in the WMF image.
    java.util.HashMap<Class, Integer> types = new java.util.HashMap<>();

    // Gather statistics
    for (Object obj : wmfImage.getRecords()) {
        com.aspose.imaging.fileformats.wmf.objects.WmfObject wmfObj = (com.aspose.imaging.fileformats.wmf.objects.WmfObject) obj;

        Class objType = wmfObj.getClass();
        if (!types.containsKey(objType)) {
            types.put(objType, 1);
        } else {
            int n = types.get(objType);
            types.put(objType, n + 1);
        }
    }

    // Print statistics
    System.out.println("Record Type                              Count");
    System.out.println("----------------------------------------------");
    for (java.util.Map.Entry<Class, Integer> entry : types.entrySet()) {
        String objectType = entry.getKey().getSimpleName();
        int numberOfEntrances = entry.getValue();

        // Align output with spaces
        int alignmentPos = 40;
        char[] chars = new char[alignmentPos - objectType.length()];
        java.util.Arrays.fill(chars, ' ');
        String gap = new String(chars);

        System.out.println(objectType + ":" + gap + numberOfEntrances);
    }
} finally {
    wmfImage.dispose();
}

//The output may look like this:
//The total number of records: 613
//Record Type                              Count
//----------------------------------------------
//WmfSetBkMode:                            1
//WmfSetTextAlign:                         1
//WmfSetRop2:                              1
//WmfSetWindowOrg:                         1
//WmfSetWindowExt:                         1
//WmfCreateBrushInDirect:                  119
//WmfSelectObject:                         240
//WmfCreatePenInDirect:                    119
//WmfSetPolyFillMode:                      1
//WmfPolyPolygon:                          114
//WmfPolyLine:                             7
//WmfSetTextColor:                         2
//WmfCreateFontInDirect:                   2
//WmfExtTextOut:                           2
//WmfDibStrechBlt:                         1
//WmfEof:                                  1

resize(int newWidth, int newHeight, int resizeType)

public void resize(int newWidth, int newHeight, 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.

Parameters:

Parameter	Type	Description
newWidth	int	The new width.
newHeight	int	The new height.
resizeType	int	The resize type.

Example: This example loads a WMF image and resizes it using various resizing methods.

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

com.aspose.imaging.fileformats.wmf.WmfImage image = (com.aspose.imaging.fileformats.wmf.WmfImage) com.aspose.imaging.Image.load(dir + "sample.wmf");
try {
    // Scale up by 2 times using Nearest Neighbour resampling.
    image.resize(image.getWidth() * 2, image.getHeight() * 2, com.aspose.imaging.ResizeType.NearestNeighbourResample);
} finally {
    image.dispose();
}

image = (com.aspose.imaging.fileformats.wmf.WmfImage) com.aspose.imaging.Image.load(dir + "sample.wmf");
try {
    // Scale down by 2 times using Nearest Neighbour resampling.
    image.resize(image.getWidth() / 2, image.getHeight() / 2, com.aspose.imaging.ResizeType.NearestNeighbourResample);
} finally {
    image.dispose();
}

image = (com.aspose.imaging.fileformats.wmf.WmfImage) com.aspose.imaging.Image.load(dir + "sample.wmf");
try {
    // Scale up by 2 times using Bilinear resampling.
    image.resize(image.getWidth() * 2, image.getHeight() * 2, com.aspose.imaging.ResizeType.BilinearResample);
} finally {
    image.dispose();
}

image = (com.aspose.imaging.fileformats.wmf.WmfImage) com.aspose.imaging.Image.load(dir + "sample.wmf");
try {
    // Scale down by 2 times using Bilinear resampling.
    image.resize(image.getWidth() / 2, image.getHeight() / 2, com.aspose.imaging.ResizeType.BilinearResample);
} finally {
    image.dispose();
}

resize(int newWidth, int newHeight, ImageResizeSettings settings)

public void resize(int newWidth, int newHeight, ImageResizeSettings settings)

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.

Parameters:

Parameter	Type	Description
newWidth	int	The new width.
newHeight	int	The new height.
settings	ImageResizeSettings	The resize settings.

rotateFlip(int rotateFlipType)

public void rotateFlip(int 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.

Parameters:

Parameter	Type	Description
rotateFlipType	int	Type of the rotation and flipping.

setPalette(IColorPalette palette, boolean updateColors)

public void setPalette(IColorPalette palette, boolean updateColors)

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.

Parameters:

Parameter	Type	Description
palette	IColorPalette	The palette to set.
updateColors	boolean	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.

getUsedFonts()

public String[] 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.

Returns: java.lang.String[] - The font list

getDefaultOptions(Object[] args)

public ImageOptionsBase getDefaultOptions(Object[] args)

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.

Parameters:

Parameter	Type	Description
args	java.lang.Object[]	The arguments.

Returns: ImageOptionsBase - Default options

crop(Rectangle rectangle)

public void crop(Rectangle 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.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle.

resizeCanvas(Rectangle newRectangle)

public void resizeCanvas(Rectangle newRectangle)

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.

Parameters:

Parameter	Type	Description
newRectangle	Rectangle	The new rectangle.

addRecord(WmfObject record)

public int addRecord(WmfObject record)

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.

Parameters:

Parameter	Type	Description
record	WmfObject	The record.

Returns: int - Number of record.

getPostScript()

public final String 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.

Returns: java.lang.String - The post script

WmfRenderMode