com.esri.arcgis.display
Interface IDraw

All Superinterfaces:
Serializable
All Known Implementing Classes:
ScreenDisplay, SimpleDisplay

public interface IDraw
extends Serializable

Provides access to members that control drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void draw(IGeometry geometry)
          Draws the specified shape.
 void finishDrawing()
          Complete drawing.
 IGeometry getClipRegion()
          Clipping region (polygon or envelope).
 Object getCustomProperty()
          Custom property.
 void setCustomProperty(Object customProperty)
          Custom property.
 void setSymbol(ISymbol sym)
          Sets the symbol used for drawing.
 void startDrawing(int hDC, short cacheID)
          Prepares the display for drawing.
 

Method Detail

startDrawing

void startDrawing(int hDC,
                  short cacheID)
                  throws IOException,
                         AutomationException
Prepares the display for drawing. Specify the device context and the cache to draw to (normally esriNoScreenCache).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
hDC - The hDC (A COM typedef) (in)
cacheID - The cacheID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

finishDrawing

void finishDrawing()
                   throws IOException,
                          AutomationException
Complete drawing.

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.

draw

void draw(IGeometry geometry)
          throws IOException,
                 AutomationException
Draws the specified shape.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSymbol

void setSymbol(ISymbol sym)
               throws IOException,
                      AutomationException
Sets the symbol used for drawing. Four different symbols can be specified simultaneously: Marker, Line, Fill, Text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCustomProperty

Object getCustomProperty()
                         throws IOException,
                                AutomationException
Custom property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCustomProperty

void setCustomProperty(Object customProperty)
                       throws IOException,
                              AutomationException
Custom property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getClipRegion

IGeometry getClipRegion()
                        throws IOException,
                               AutomationException
Clipping region (polygon or envelope). Use after StartDrawing and before FinishDrawing.

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.IGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.