com.aspose.drawing.imaging

Class Metafile

java.lang.Object

com.aspose.drawing.Image

com.aspose.drawing.imaging.Metafile

All Implemented Interfaces:

com.aspose.ms.System.IDisposable

public final class Metafile
extends Image

Defines a graphic metafile. A metafile contains records that describe a sequence of graphics operations that can be recorded (constructed) and played back (displayed). This class is not inheritable.

Nested Class Summary

Nested classes/interfaces inherited from class com.aspose.drawing.Image

Image.GetThumbnailImageAbort

Constructor Summary

Constructors

Constructor and Description
Metafile(byte[] henhmetafile, boolean deleteEmf) Initializes a new instance of the Metafile class from the specified handle.
Metafile(byte[] referenceHdc, int emfType) Initializes a new instance of the Metafile class from the specified handle to a device context and an EmfType enumeration that specifies the format of the Metafile.
Metafile(InputStream stream) Initializes a new instance of the Metafile class from the specified data stream.
Metafile(InputStream stream, byte[] referenceHdc) Initializes a new instance of the Metafile class from the specified data stream and a Windows handle to a device context.
Metafile(InputStream stream, byte[] referenceHdc, int type) Initializes a new instance of the Metafile class from the specified data stream, a Windows handle to a device context, and an EmfType enumeration that specifies the format of the Metafile.
Metafile(InputStream stream, byte[] referenceHdc, RectangleF frameRect, int frameUnit, int type) Initializes a new instance of the Metafile class from the specified data stream, a Windows handle to a device context, and an EmfType enumeration that specifies the format of the Metafile.
Metafile(com.aspose.ms.System.IO.Stream stream, int type) Initializes a new instance of the Metafile class from the specified data stream and a Windows handle to a device context.
Metafile(String filename) Initializes a new instance of the Metafile class from the specified file name.
Metafile(String filename, byte[] referenceHdc) Initializes a new instance of the Metafile class from the specified file name.

Method Summary

Modifier and Type	Method and Description
UUID[]	getFrameDimensionsList() Gets an array of GUIDs that represent the dimensions of frames within this Image.
int	getHeight() Gets the height, in pixels, of this Metafile.
com.aspose.ms.System.IntPtr	getHenhmetafile() Returns a Windows handle to an enhanced Metafile.
MetafileHeader	getMetafileHeader() Returns the MetafileHeader associated with this Metafile.
static MetafileHeader	getMetafileHeader(InputStream stream) Returns the MetafileHeader associated with the specified Metafile.
static MetafileHeader	getMetafileHeader(String fileName) Returns the MetafileHeader associated with the specified Metafile.
ColorPalette	getPalette() Gets or sets the color palette used for this Image.
int	getPixelFormat() Gets the pixel format for this Image.
int[]	getPropertyIdList() Gets IDs of the property items stored in this Image.
PropertyItem	getPropertyItem(int propid) Gets the specified property item from this Image.
PropertyItem[]	getPropertyItems() Gets all the property items (pieces of metadata) stored in this Image.
ImageFormat	getRawFormat() Gets the file format of this Image.
int	getWidth() Gets the width, in pixels, of this Metafile.
void	playRecord(int recordType, int flags, int dataSize, byte[] dataArray) Plays an individual metafile record.
void	removePropertyItem(int propid) Removes the specified property item from this Image.
void	rotateFlip(int rotateFlipType) This method rotates, flips, or rotates and flips the Image.
void	setPalette(ColorPalette value) Gets or sets the color palette used for this Image.
void	setPropertyItem(PropertyItem propitem) Stores a property item (piece of metadata) in this Image.

Methods inherited from class com.aspose.drawing.Image

deepClone, dispose, fromFile, fromHbitmap, fromStream, fromStream, getBounds, getFlags, getFrameCount, getHorizontalResolution, getPhysicalDimension, getPixelFormatSize, getSize, getTag, getThumbnailImage, getVerticalResolution, isAlphaPixelFormat, save, save, save, save, save, saveAdd, saveAdd, selectActiveFrame, setTag

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Metafile

public Metafile(byte[] henhmetafile,
                boolean deleteEmf)

Initializes a new instance of the Metafile class from the specified handle.

Parameters:

henhmetafile - A handle to an enhanced metafile.

deleteEmf - true to delete the enhanced metafile handle when the Metafile is deleted; otherwise, false.

Metafile

public Metafile(byte[] referenceHdc,
                int emfType)

Initializes a new instance of the Metafile class from the specified handle to a device context and an EmfType enumeration that specifies the format of the Metafile.

Parameters:

referenceHdc - The handle to a device context.

emfType - An EmfType that specifies the format of the Metafile.

Metafile

public Metafile(String filename)

Initializes a new instance of the Metafile class from the specified file name.

Parameters:

filename - A String that represents the file name from which to create the new Metafile.

Metafile

public Metafile(String filename,
                byte[] referenceHdc)

Initializes a new instance of the Metafile class from the specified file name.

Parameters:

filename - A String that represents the file name from which to create the new Metafile.

referenceHdc - A Windows handle to a device context.

Metafile

public Metafile(InputStream stream)

Initializes a new instance of the Metafile class from the specified data stream.

Parameters:

stream - The InputStream from which to create the new Metafile.

Metafile

public Metafile(InputStream stream,
                byte[] referenceHdc)

Initializes a new instance of the Metafile class from the specified data stream and a Windows handle to a device context. />.

Parameters:

stream - A InputStream that contains the data for this Metafile.

referenceHdc - A Windows handle to a device context of the Metafile object.

Metafile

public Metafile(com.aspose.ms.System.IO.Stream stream,
                int type)

Initializes a new instance of the Metafile class from the specified data stream and a Windows handle to a device context. />.

Parameters:

stream - A InputStream that contains the data for this Metafile.

type - must be int 1.

Metafile

public Metafile(InputStream stream,
                byte[] referenceHdc,
                int type)

Initializes a new instance of the Metafile class from the specified data stream, a Windows handle to a device context, and an EmfType enumeration that specifies the format of the Metafile.

Parameters:

stream - A InputStream that contains the data for this Metafile.

referenceHdc - A Windows handle to a device context.

type - An EmfType that specifies the format of the Metafile.

Metafile

public Metafile(InputStream stream,
                byte[] referenceHdc,
                RectangleF frameRect,
                int frameUnit,
                int type)

Initializes a new instance of the Metafile class from the specified data stream, a Windows handle to a device context, and an EmfType enumeration that specifies the format of the Metafile.

Parameters:

stream - A InputStream that contains the data for this Metafile.

referenceHdc - A Windows handle to a device context.

frameRect - A Rectangle that represents the rectangle that bounds the new Metafile.

frameUnit - A MetafileFrameUnit that specifies the unit of measure for frameRect.

type - An EmfType that specifies the format of the Metafile.

Method Detail

getWidth

public int getWidth()

Gets the width, in pixels, of this Metafile.

Specified by:

getWidth in class Image

getHeight

public int getHeight()

Gets the height, in pixels, of this Metafile.

Specified by:

getHeight in class Image

Returns:

the height, in pixels, of this Metafile.

getRawFormat

public ImageFormat getRawFormat()

Gets the file format of this Image.

Specified by:

getRawFormat in class Image

Returns:

The ImageFormat that represents the file format of this Image.

getPixelFormat

public int getPixelFormat()

Gets the pixel format for this Image.

Specified by:

getPixelFormat in class Image

Returns:

A PixelFormat(Image.getPixelFormat()) that represents the pixel format for this Image.

getPalette

public ColorPalette getPalette()

Gets or sets the color palette used for this Image.

Specified by:

getPalette in class Image

Returns:

A ColorPalette that represents the color palette used for this Image.

setPalette

public void setPalette(ColorPalette value)

Gets or sets the color palette used for this Image.

Specified by:

setPalette in class Image

getFrameDimensionsList

public UUID[] getFrameDimensionsList()

Gets an array of GUIDs that represent the dimensions of frames within this Image.

Overrides:

getFrameDimensionsList in class Image

Returns:

An array of GUIDs that specify the dimensions of frames within this Image from most significant to least significant.

getPropertyIdList

public int[] getPropertyIdList()

Gets IDs of the property items stored in this Image.

Specified by:

getPropertyIdList in class Image

Returns:

An array of the property IDs, one for each property item stored in this image.

getPropertyItems

public PropertyItem[] getPropertyItems()

Gets all the property items (pieces of metadata) stored in this Image.

Specified by:

getPropertyItems in class Image

Returns:

An array of PropertyItem objects, one for each property item stored in the image.

getMetafileHeader

public static MetafileHeader getMetafileHeader(InputStream stream)

Returns the MetafileHeader associated with the specified Metafile.

Parameters:

stream - A InputStream containing the Metafile for which a header is retrieved.

Returns:

The MetafileHeader associated with the specified Metafile.

getMetafileHeader

public static MetafileHeader getMetafileHeader(String fileName)

Returns the MetafileHeader associated with the specified Metafile.

Parameters:

fileName - A String containing the name of the Metafile for which a header is retrieved.

Returns:

The MetafileHeader associated with the specified Metafile.

rotateFlip

public void rotateFlip(int rotateFlipType)

This method rotates, flips, or rotates and flips the Image.

Specified by:

rotateFlip in class Image

Parameters:

rotateFlipType - A RotateFlipType member that specifies the type of rotation and flip to apply to the image.

getHenhmetafile

public com.aspose.ms.System.IntPtr getHenhmetafile()

Returns a Windows handle to an enhanced Metafile.

Returns:

A Windows handle to this enhanced Metafile.

playRecord

public void playRecord(int recordType,
                       int flags,
                       int dataSize,
                       byte[] dataArray)

Plays an individual metafile record.

Parameters:

recordType - Element of the EmfPlusRecordType that specifies the type of metafile record being played.

flags - A set of flags that specify attributes of the record.

dataSize - The number of bytes in the record data.

dataArray - An array of bytes that contains the record data.

getMetafileHeader

public MetafileHeader getMetafileHeader()

Returns the MetafileHeader associated with this Metafile.

Returns:

The MetafileHeader associated with this Metafile.

getPropertyItem

public PropertyItem getPropertyItem(int propid)

Gets the specified property item from this Image.

Specified by:

getPropertyItem in class Image

Parameters:

propid - The ID of the property item to get.

Returns:

The PropertyItem this method gets.

removePropertyItem

public void removePropertyItem(int propid)

Removes the specified property item from this Image.

Specified by:

removePropertyItem in class Image

Parameters:

propid - The ID of the property item to remove.

setPropertyItem

public void setPropertyItem(PropertyItem propitem)

Stores a property item (piece of metadata) in this Image.

Specified by:

setPropertyItem in class Image

Parameters:

propitem - The PropertyItem to be stored.