com.esri.arcgis.output
Interface IDibExporter

All Superinterfaces:
Serializable
All Known Implementing Classes:
DibExporter

public interface IDibExporter
extends Serializable

Superseded by IExportBMP. Provides access to members that control the DIB (Windows Device Independent Bitmap) Exporter.

Superseded By

IExportBMP

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IColor getBackgroundColor()
          The background color of the DIB.
 short getBitsPerPixel()
          The color depth of the DIB.
 int getHDIB()
          Handle to in-memory DIB.
 short getHeight()
          The height of the DIB.
 short getWidth()
          The width of the DIB.
 boolean isInMemory()
          Indicates if the bitmap should be written to memory.
 void setBackgroundColor(IColor ppBackgroundColor)
          The background color of the DIB.
 void setBitsPerPixel(short pBitsPerPixel)
          The color depth of the DIB.
 void setHeight(short pHeight)
          The height of the DIB.
 void setIsInMemory(boolean pIsInMemory)
          Indicates if the bitmap should be written to memory.
 void setWidth(short pWidth)
          The width of the DIB.
 

Method Detail

setIsInMemory

void setIsInMemory(boolean pIsInMemory)
                   throws IOException,
                          AutomationException
Indicates if the bitmap should be written to memory. If false, it is written to a file specified by Path. If true, use HDIB to get the memory handle after ReleaseDC has been called.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isInMemory

boolean isInMemory()
                   throws IOException,
                          AutomationException
Indicates if the bitmap should be written to memory. If false, it is written to a file specified by Path. If true, use HDIB to get the memory handle after ReleaseDC has been called.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getHDIB

int getHDIB()
            throws IOException,
                   AutomationException
Handle to in-memory DIB. Valid only after ReleaseDC has been called.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pHandle (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBitsPerPixel

void setBitsPerPixel(short pBitsPerPixel)
                     throws IOException,
                            AutomationException
The color depth of the DIB.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBitsPerPixel

short getBitsPerPixel()
                      throws IOException,
                             AutomationException
The color depth of the DIB.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pBitsPerPixel
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 DIB.

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

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(short pWidth)
              throws IOException,
                     AutomationException
The width of the DIB. If width or height is zero, screen size 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

short getWidth()
               throws IOException,
                      AutomationException
The width of the DIB. If width or height is zero, screen size 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(short pHeight)
               throws IOException,
                      AutomationException
The height of the DIB. If width or height is zero, screen size 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

short getHeight()
                throws IOException,
                       AutomationException
The height of the DIB. If width or height is zero, screen size 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.