com.esri.arcgis.output
Class EmfExporter

java.lang.Object
  com.esri.arcgis.output.EmfExporter

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IEmfExporter, IExporter, IExporterPriority, IOutputCleanup, ISupportErrorInfo, Serializable

public class EmfExporter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IEmfExporter, IExporter, IExporterPriority, ISupportErrorInfo, IOutputCleanup

Superseded by ExportEMF. Class used to export maps to Windows Enhanced Metafile (EMF) format.

Superseded By

ExportEMF

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

EmfExporter()
Constructs a EmfExporter using ArcGIS Engine.

EmfExporter(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EmfExporter theEmfExporter = (EmfExporter) obj;

Method Summary

void	cleanup() Cleanup should clean all temporary files, free used memory, etc...
boolean	equals(Object o) Compare this object with another
void	finishExporting() Shuts down the Exporter.
static String	getClsid() getClsid.
String	getDescription() A description string to embed in the file.
String	getExportFileName() The Export File Name.
String	getFileExtension() File Extension associated with Exporter.
String	getFilter() Filter String used in the CFileDialog class.
int	getHENHMETAFILE() Handle to in-memory metafile.
String	getName() The Name of the Exporter.
IEnvelope	getPixelBounds() The Pixel Bounds of the Exporter.
int	getPriority() Exporter's priority - the order of appearance in the user interface.
short	getResolution() The Resolution of the Exporter.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isClipToGraphicExtent() Indicates if the Output will be clipped to the Graphics Extent.
boolean	isInMemory() Indicates if the metafile will be written to memory.
void	setClipToGraphicExtent(boolean clipToGraphicsExtent) Indicates if the Output will be clipped to the Graphics Extent.
void	setDescription(String pDescription) A description string to embed in the file.
void	setExportFileName(String fileName) The Export File Name.
void	setIsInMemory(boolean pIsInMemory) Indicates if the metafile will be written to memory.
void	setPixelBounds(IEnvelope pixelBounds) The Pixel Bounds of the Exporter.
void	setResolution(short res) The Resolution of the Exporter.
int	startExporting() Initializes the Exporter.
int	takeHENHMETAFILE() Returns the handle to the in-memory metafile.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

EmfExporter

public EmfExporter()
            throws IOException,
                   UnknownHostException

Constructs a EmfExporter using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

EmfExporter

public EmfExporter(Object obj)
            throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EmfExporter theEmfExporter = (EmfExporter) obj;

Construct a EmfExporter using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to EmfExporter.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setIsInMemory

public void setIsInMemory(boolean pIsInMemory)
                   throws IOException,
                          AutomationException

Indicates if the metafile will be written to memory.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIsInMemory in interface IEmfExporter

Parameters:

pIsInMemory - The pIsInMemory (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInMemory

public boolean isInMemory()
                   throws IOException,
                          AutomationException

Indicates if the metafile will be written to memory.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isInMemory in interface IEmfExporter

Returns:

The pIsInMemory

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHENHMETAFILE

public int getHENHMETAFILE()
                    throws IOException,
                           AutomationException

Handle to in-memory metafile. Valid only after ReleaseDC has been called.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHENHMETAFILE in interface IEmfExporter

Returns:

The pHandle (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

takeHENHMETAFILE

public int takeHENHMETAFILE()
                     throws IOException,
                            AutomationException

Returns the handle to the in-memory metafile. Valid only after ReleaseDC has been called. Ownership of the handle is transferred to the client who must call DeleteEnhMetafile on the returned handle. Subsequent calls to this routine will return 0.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

takeHENHMETAFILE in interface IEmfExporter

Returns:

The pHandle (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String pDescription)
                    throws IOException,
                           AutomationException

A description string to embed in the file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDescription in interface IEmfExporter

Parameters:

pDescription - The pDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

A description string to embed in the file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDescription in interface IEmfExporter

Returns:

The pDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The Name of the Exporter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IExporter

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilter

public String getFilter()
                 throws IOException,
                        AutomationException

Filter String used in the CFileDialog class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFilter in interface IExporter

Returns:

The filter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileExtension

public String getFileExtension()
                        throws IOException,
                               AutomationException

File Extension associated with Exporter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFileExtension in interface IExporter

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPixelBounds

public void setPixelBounds(IEnvelope pixelBounds)
                    throws IOException,
                           AutomationException

The Pixel Bounds of the Exporter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPixelBounds in interface IExporter

Parameters:

pixelBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelBounds

public IEnvelope getPixelBounds()
                         throws IOException,
                                AutomationException

The Pixel Bounds of the Exporter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPixelBounds in interface IExporter

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExportFileName

public void setExportFileName(String fileName)
                       throws IOException,
                              AutomationException

The Export File Name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExportFileName in interface IExporter

Parameters:

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExportFileName

public String getExportFileName()
                         throws IOException,
                                AutomationException

The Export File Name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExportFileName in interface IExporter

Returns:

The fileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResolution

public short getResolution()
                    throws IOException,
                           AutomationException

The Resolution of the Exporter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getResolution in interface IExporter

Returns:

The res

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResolution

public void setResolution(short res)
                   throws IOException,
                          AutomationException

The Resolution of the Exporter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setResolution in interface IExporter

Parameters:

res - The res (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isClipToGraphicExtent

public boolean isClipToGraphicExtent()
                              throws IOException,
                                     AutomationException

Indicates if the Output will be clipped to the Graphics Extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isClipToGraphicExtent in interface IExporter

Returns:

The clipToGraphicsExtent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClipToGraphicExtent

public void setClipToGraphicExtent(boolean clipToGraphicsExtent)
                            throws IOException,
                                   AutomationException

Indicates if the Output will be clipped to the Graphics Extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setClipToGraphicExtent in interface IExporter

Parameters:

clipToGraphicsExtent - The clipToGraphicsExtent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startExporting

public int startExporting()
                   throws IOException,
                          AutomationException

Initializes the Exporter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

startExporting in interface IExporter

Returns:

The hDC (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

finishExporting

public void finishExporting()
                     throws IOException,
                            AutomationException

Shuts down the Exporter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

finishExporting in interface IExporter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPriority

public int getPriority()
                throws IOException,
                       AutomationException

Exporter's priority - the order of appearance in the user interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPriority in interface IExporterPriority

Returns:

The pPriority

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cleanup

public void cleanup()
             throws IOException,
                    AutomationException

Cleanup should clean all temporary files, free used memory, etc...

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

cleanup in interface IOutputCleanup

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.