com.esri.arcgis.display
Interface IGraphicsOutline

All Superinterfaces:
Serializable
All Known Implementing Classes:
IGraphicsOutlineProxy, Representation, RepresentationGraphics, RepresentationMarker

public interface IGraphicsOutline
extends Serializable

Provides access to methods dealing with the outline of a graphics.

Product Availability

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


Method Summary
 IGeometry getAllOutlineParts(int type, int option, double buffer, IEnvelope clipEnvelope)
          Returns the entire drawing outline of a graphics.
 boolean hitTest(IPoint point, double tolerance)
          Tests if a point is located on the graphics outline.
 IGeometry nextOutlinePart()
          Returns the next drawing outline part.
 void reset(int type, int option, double buffer, IEnvelope clipEnvelope)
          Resets the collection of drawing outline parts to the beginning, before calling NextOutlinePart.
 

Method Detail

hitTest

boolean hitTest(IPoint point,
                double tolerance)
                throws IOException,
                       AutomationException
Tests if a point is located on the graphics outline.

Product Availability

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

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

getAllOutlineParts

IGeometry getAllOutlineParts(int type,
                             int option,
                             double buffer,
                             IEnvelope clipEnvelope)
                             throws IOException,
                                    AutomationException
Returns the entire drawing outline of a graphics.

Product Availability

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

Parameters:
type - A com.esri.arcgis.display.esriOutlineType constant (in)
option - A com.esri.arcgis.display.esriOutlineOption constant (in)
buffer - The buffer (in)
clipEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
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.

reset

void reset(int type,
           int option,
           double buffer,
           IEnvelope clipEnvelope)
           throws IOException,
                  AutomationException
Resets the collection of drawing outline parts to the beginning, before calling NextOutlinePart. To be used when drawing outline of a graphics is accessed part by part.

Product Availability

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

Parameters:
type - A com.esri.arcgis.display.esriOutlineType constant (in)
option - A com.esri.arcgis.display.esriOutlineOption constant (in)
buffer - The buffer (in)
clipEnvelope - 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.

nextOutlinePart

IGeometry nextOutlinePart()
                          throws IOException,
                                 AutomationException
Returns the next drawing outline part. It is necessary to call the Reset method before iterating with the NextOutlinePart method.

Product Availability

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

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.