com.esri.arcgis.output
Interface IExportImage

All Superinterfaces:
Serializable
All Known Implementing Classes:
ExportBMP, ExportGIF, ExportJPEG, ExportPNG, ExportTIFF

public interface IExportImage
extends Serializable

Provides access to members that control the Image Export.

Product Availability

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


Method Summary
 IColor getBackgroundColor()
          The background color of the Image.
 int getHeight()
          The height of the Image.
 int getImageType()
          Export Image Type.
 int getWidth()
          The width of the Image.
 void setBackgroundColor(IColor ppBackgroundColor)
          The background color of the Image.
 void setHeight(int pHeight)
          The height of the Image.
 void setImageType(int pimageType)
          Export Image Type.
 void setWidth(int pWidth)
          The width of the Image.
 

Method Detail

setImageType

void setImageType(int pimageType)
                  throws IOException,
                         AutomationException
Export Image Type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pimageType - A com.esri.arcgis.output.esriExportImageType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImageType

int getImageType()
                 throws IOException,
                        AutomationException
Export Image Type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.output.esriExportImageType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

void setBackgroundColor(IColor ppBackgroundColor)
                        throws IOException,
                               AutomationException
The background color of the Image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
ppBackgroundColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException
The background color of the Image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWidth

void setWidth(int pWidth)
              throws IOException,
                     AutomationException
The width of the Image. If width is zero, screen width is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pWidth - The pWidth (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

int getWidth()
             throws IOException,
                    AutomationException
The width of the Image. If width is zero, screen width is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pWidth
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHeight

void setHeight(int pHeight)
               throws IOException,
                      AutomationException
The height of the Image. If height is zero, screen height is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pHeight - The pHeight (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeight

int getHeight()
              throws IOException,
                     AutomationException
The height of the Image. If height is zero, screen height is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pHeight
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.