EmfImage (Aspose Imaging for Java 22.6 API Documentation)

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
        
        com.aspose.imaging.fileformats.emf.EmfImage

All Implemented Interfaces:: IObjectWithSizeF, IObjectWithBounds, com.aspose.internal.progressmanagement.IProgressEventHandler, com.aspose.internal.progressmanagement.IProgressInformer, com.aspose.ms.System.IDisposable, Closeable, AutoCloseable

public final class EmfImage
extends MetaImage

EMF file format image.

Code example:

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

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

// Using Aspose.Imaging.Image.Load is a unified way to load all types of images including EMF.
com.aspose.imaging.fileformats.emf.EmfImage emfImage = (com.aspose.imaging.fileformats.emf.EmfImage) com.aspose.imaging.Image.load(dir + "test.emf");
try {
    com.aspose.imaging.imageoptions.SvgOptions saveOptions = new com.aspose.imaging.imageoptions.SvgOptions();

    // Text will be converted to shapes.
    saveOptions.setTextAsShapes(true);

    com.aspose.imaging.imageoptions.EmfRasterizationOptions rasterizationOptions = new com.aspose.imaging.imageoptions.EmfRasterizationOptions();

    // The background color of the drawing surface.
    rasterizationOptions.setBackgroundColor(com.aspose.imaging.Color.getWhiteSmoke());

    // The page size.
    rasterizationOptions.setPageSize(new com.aspose.imaging.SizeF(emfImage.getWidth(), emfImage.getHeight()));

    // If embedded emf exists, then render emf; otherwise render wmf.
    rasterizationOptions.setRenderMode(com.aspose.imaging.fileformats.emf.EmfRenderMode.Auto);

    // Set the horizontal margin
    rasterizationOptions.setBorderX(50);

    // Set the vertical margin
    rasterizationOptions.setBorderY(50);

    saveOptions.setVectorRasterizationOptions(rasterizationOptions);

    emfImage.save(dir + "test.output.svg", saveOptions);
} finally {
    emfImage.dispose();
}

Constructor Summary

Constructors
Constructor and Description
`EmfImage()` Initializes a new instance of the `EmfImage` class.
`EmfImage(int width, int height)` Initializes a new instance of the `EmfImage` class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cacheData()` Caches the data and ensures no additional data loading will be performed from the underlying `DataStreamSupporter.DataStreamContainer`.
`void`	`crop(Rectangle rectangle)` Crops the specified rectangle.
`int`	`getBitsPerPixel()` Gets the image bits per pixel count this parameter is not applicable to vector images
`ImageOptionsBase`	`getDefaultOptions(Object[] args)` Gets the default options.
`long`	`getFileFormat()` Gets a value of file format
`EmfMetafileHeader`	`getHeader()` Gets or sets the header record
`int`	`getHeight()` Gets the image height.
`MetaObjectList`	`getRecords()` Gets or sets the records.
`String[]`	`getUsedFonts()` Returns the list of font which used inside metafile.
`int`	`getWidth()` Gets the image width.
`boolean`	`isCached()` Gets a value indicating whether object's data is cached currently and no data reading is required.
`void`	`resize(int newWidth, int newHeight, ImageResizeSettings settings)` Resizes the image.
`void`	`resize(int newWidth, int newHeight, int resizeType)` Resizes the image.
`void`	`resizeCanvas(Rectangle newRectangle)` Resizes the canvas.
`void`	`rotateFlip(int rotateFlipType)` Rotates, flips, or rotates and flips the image.
`void`	`setHeader(EmfMetafileHeader value)` Gets or sets the header record
`void`	`setPalette(IColorPalette palette, boolean updateColors)` Sets the image palette.
`void`	`setRecords(MetaObjectList value)` Gets or sets the records.

Methods inherited from class com.aspose.imaging.fileformats.emf.MetaImage
crop, getMissedFonts

Methods inherited from class com.aspose.imaging.VectorImage
getEmbeddedImages, getHeightF, getSizeF, getWidthF

Methods inherited from class com.aspose.imaging.Image
canLoad, canLoad, canLoad, canLoad, canSave, create, create, create, getBackgroundColor, getBounds, getBufferSizeHint, getContainer, getFileFormat, getFileFormat, getFittingRectangle, getFittingRectangle, getInterruptMonitor, getOriginalOptions, getPalette, getProgressEventHandler, getProgressEventHandlerInfo, getProportionalHeight, getProportionalWidth, getSize, hasBackgroundColor, isAutoAdjustPalette, isUsePalette, load, load, load, load, load, load, resize, resizeHeightProportionally, resizeHeightProportionally, resizeHeightProportionally, resizeWidthProportionally, resizeWidthProportionally, resizeWidthProportionally, save, save, save, save, save, save, save, save, setAutoAdjustPalette, setBackgroundColor, setBackgroundColor, setBufferSizeHint, setInterruptMonitor, setPalette

Methods inherited from class com.aspose.imaging.DataStreamSupporter
getDataStreamContainer, save, save, save

Methods inherited from class com.aspose.imaging.DisposableObject
close, dispose, getDisposed

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- EmfImage
```
public EmfImage()
```
  Initializes a new instance of the EmfImage class.
- EmfImage
```
public EmfImage(int width,
                int height)
```
  Initializes a new instance of the EmfImage class.
  
  Parameters:
  
  width - The width.
  
  height - The height.

Method Detail

getHeader
```
public EmfMetafileHeader getHeader()
```
Gets or sets the header record

setHeader

public void setHeader(EmfMetafileHeader value)

Gets or sets the header record

isCached
```
public boolean isCached()
```
Gets a value indicating whether object's data is cached currently and no data reading is required.
Value: true if object's data is cached; otherwise, false.

Specified by:

isCached in class DataStreamSupporter

Returns:

a value indicating whether object's data is cached currently and no data reading is required.

getRecords
```
public MetaObjectList getRecords()
```
Gets or sets the records.
Value: The records.

Overrides:

getRecords in class MetaImage

Returns:

The records.

setRecords
```
public void setRecords(MetaObjectList value)
```
Gets or sets the records.
Value: The records.

Overrides:

setRecords in class MetaImage

Parameters:

value - The records.

getFileFormat
```
public long getFileFormat()
```
Gets a value of file format

Overrides:

getFileFormat in class Image

See Also:

FileFormat

getBitsPerPixel
```
public int getBitsPerPixel()
```
Gets the image bits per pixel count this parameter is not applicable to vector images

Specified by:

getBitsPerPixel in class Image

Returns:

The image bits per pixel count.

Throws:

com.aspose.ms.System.NotImplementedException - Not valid for vector images Value: The image bits per pixel count.

getWidth
```
public int getWidth()
```
Gets the image width.
Value: The image width.

Specified by:

getWidth in interface IObjectWithBounds

Overrides:

getWidth in class VectorImage

Returns:

the image width.

getHeight
```
public int getHeight()
```
Gets the image height.
Value: The image height.

Specified by:

getHeight in interface IObjectWithBounds

Overrides:

getHeight in class VectorImage

Returns:

the image height.

cacheData

public void cacheData()

Caches the data and ensures no additional data loading will be performed from the underlying DataStreamSupporter.DataStreamContainer.

Specified by:

cacheData in class DataStreamSupporter

Code example:

This example shows how to load a EMF 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.emf.EmfImage emfImage = (com.aspose.imaging.fileformats.emf.EmfImage) com.aspose.imaging.Image.load(dir + "test.emf");
try {
    // Cache data to load all records.
    emfImage.cacheData();
    System.out.println("The total number of records: " + emfImage.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 : emfImage.getRecords()) {
        com.aspose.imaging.fileformats.emf.emf.records.EmfRecord record = (com.aspose.imaging.fileformats.emf.emf.records.EmfRecord) obj;

        Class objType = record.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 {
    emfImage.dispose();
}

//The output may look like this:
//The total number of records: 1188
//Record Type                              Count
//----------------------------------------------
//EmfMetafileHeader:                       1
//EmfSetBkMode:                            1
//EmfSetTextAlign:                         1
//EmfSetRop2:                              1
//EmfSetWorldTransform:                    1
//EmfExtSelectClipRgn:                     1
//EmfCreateBrushIndirect:                  113
//EmfSelectObject:                         240
//EmfCreatePen:                            116
//EmfSetPolyFillMode:                      1
//EmfBeginPath:                            120
//EmfMoveToEx:                             122
//EmfPolyBezierTo16:                       36
//EmfLineTo:                               172
//EmfCloseFigure:                          14
//EmfEndPath:                              120
//EmfStrokeAndFillPath:                    113
//EmfStrokePath:                           7
//EmfSetTextColor:                         2
//EmfExtCreateFontIndirectW:               2
//EmfExtTextOutW:                          2
//EmfStretchBlt:                           1
//EmfEof:                                  1

getUsedFonts
```
public String[] getUsedFonts()
```
Returns the list of font which used inside metafile.

Specified by:

getUsedFonts in class MetaImage

Returns:

The font list

crop
```
public void crop(Rectangle rectangle)
```
Crops the specified rectangle.

Overrides:

crop in class MetaImage

Parameters:

rectangle - The rectangle.

resizeCanvas
```
public void resizeCanvas(Rectangle newRectangle)
```
Resizes the canvas.

Specified by:

resizeCanvas in class MetaImage

Parameters:

newRectangle - The new rectangle.

resize
```
public void resize(int newWidth,
                   int newHeight,
                   int resizeType)
```
Resizes the image.

Specified by:

resize in class Image

Parameters:

newWidth - The new width.

newHeight - The new height.

resizeType - The resize type.

Throws:

com.aspose.ms.System.NotImplementedException - Not implemented.

com.aspose.ms.System.NotImplementedException - Not implemented.

resize
```
public void resize(int newWidth,
                   int newHeight,
                   ImageResizeSettings settings)
```
Resizes the image.

Specified by:

resize in class Image

Parameters:

newWidth - The new width.

newHeight - The new height.

settings - The resize settings.

Throws:

com.aspose.ms.System.NotImplementedException - Not implemented.

rotateFlip
```
public void rotateFlip(int rotateFlipType)
```
Rotates, flips, or rotates and flips the image.

Specified by:

rotateFlip in class Image

Parameters:

rotateFlipType - Type of the rotating flip.

Throws:

com.aspose.ms.System.NotImplementedException - Not implemented.

setPalette
```
public void setPalette(IColorPalette palette,
                       boolean updateColors)
```
Sets the image palette.

Specified by:

setPalette in class Image

Parameters:

palette - The palette to set.

updateColors - 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.

Throws:

com.aspose.ms.System.NotImplementedException - Not valid for vector images

getDefaultOptions
```
public ImageOptionsBase getDefaultOptions(Object[] args)
```
Gets the default options.

Overrides:

getDefaultOptions in class Image

Parameters:

args - The arguments.

Returns:

Default options

Class EmfImage

Constructor Summary

Method Summary

Methods inherited from class com.aspose.imaging.fileformats.emf.MetaImage

Methods inherited from class com.aspose.imaging.VectorImage

Methods inherited from class com.aspose.imaging.Image

Methods inherited from class com.aspose.imaging.DataStreamSupporter

Methods inherited from class com.aspose.imaging.DisposableObject

Methods inherited from class java.lang.Object

Constructor Detail

EmfImage

EmfImage

Method Detail

getHeader

setHeader

isCached

getRecords

setRecords

getFileFormat

getBitsPerPixel

getWidth

getHeight

cacheData

getUsedFonts

crop

resizeCanvas

resize

resize

rotateFlip

setPalette

getDefaultOptions