com.esri.arcgis.output
Interface IExporter

All Superinterfaces:

Serializable

All Known Implementing Classes:

AIExporter, DibExporter, EmfExporter, JpegExporter, PDFExporter, PsExporter, TiffExporter

public interface IExporter
extends Serializable

Superseded by IExport. Provides access to members that control the Base Exporter.

Superseded By

IExport

Product Availability

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

Method Summary

void	finishExporting() Shuts down the Exporter.
String	getExportFileName() The Export File Name.
String	getFileExtension() File Extension associated with Exporter.
String	getFilter() Filter String used in the CFileDialog class.
String	getName() The Name of the Exporter.
IEnvelope	getPixelBounds() The Pixel Bounds of the Exporter.
short	getResolution() The Resolution of the Exporter.
boolean	isClipToGraphicExtent() Indicates if the Output will be clipped to the Graphics Extent.
void	setClipToGraphicExtent(boolean clipToGraphicsExtent) Indicates if the Output will be clipped to the Graphics Extent.
void	setExportFileName(String fileName) The Export File Name.
void	setPixelBounds(IEnvelope pixelBounds) The Pixel Bounds of the Exporter.
void	setResolution(short res) The Resolution of the Exporter.
int	startExporting() Initializes the Exporter.

Method Detail

getName

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilter

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

Returns:

The filter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileExtension

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPixelBounds

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

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

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

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

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

Parameters:

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExportFileName

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

Returns:

The fileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResolution

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

Returns:

The res

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResolution

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

Parameters:

res - The res (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isClipToGraphicExtent

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

Returns:

The clipToGraphicsExtent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClipToGraphicExtent

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

Parameters:

clipToGraphicsExtent - The clipToGraphicsExtent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startExporting

int startExporting()
                   throws IOException,
                          AutomationException

Initializes the Exporter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The hDC (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

finishExporting

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.