com.esri.arcgis.carto
Interface IGraphicSnapEnvironment

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
GraphicSnapEnvironment, IGraphicSnapEnvironmentProxy, PageLayout

public interface IGraphicSnapEnvironment
extends java.io.Serializable

COM Interface 'IGraphicSnapEnvironment'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the Collection of snap agents used for snapping graphics.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID56fd87f6_ddce_11d1_8778_0000f8751720
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addSnapAgent(IGraphicSnap snapAgent)
          Add a new snap agent to the environment.
 void clearSnapAgents()
          Remove all snap agents.
 void deleteSnapAgent(IGraphicSnap snapAgent)
          Remove specified snap agent from the environment.
 IGraphicSnap getSnapAgent(int index)
          The snap agent at the specified index.
 int getSnapAgentCount()
          The number of snap agents.
 IArray getSnapAgentOrder()
          An array of IDs indicating how agents should be ordered.
 double getSnapTolerance()
          The snap tolerance in page units.
 void setSnapAgentOrder(IArray guids)
          An array of IDs indicating how agents should be ordered.
 void setSnapTolerance(double tol)
          The snap tolerance in page units.
 void snapShape(IGeometry shape)
          Snap the shape using the agents in the environment.
 

Field Detail

IID56fd87f6_ddce_11d1_8778_0000f8751720

static final int IID56fd87f6_ddce_11d1_8778_0000f8751720
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

snapShape

void snapShape(IGeometry shape)
               throws java.io.IOException,
                      AutomationException
Snap the shape using the agents in the environment.

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

getSnapTolerance

double getSnapTolerance()
                        throws java.io.IOException,
                               AutomationException
The snap tolerance in page units.

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

setSnapTolerance

void setSnapTolerance(double tol)
                      throws java.io.IOException,
                             AutomationException
The snap tolerance in page units.

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

setSnapAgentOrder

void setSnapAgentOrder(IArray guids)
                       throws java.io.IOException,
                              AutomationException
An array of IDs indicating how agents should be ordered.

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

getSnapAgentOrder

IArray getSnapAgentOrder()
                         throws java.io.IOException,
                                AutomationException
An array of IDs indicating how agents should be ordered.

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

getSnapAgentCount

int getSnapAgentCount()
                      throws java.io.IOException,
                             AutomationException
The number of snap agents.

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

getSnapAgent

IGraphicSnap getSnapAgent(int index)
                          throws java.io.IOException,
                                 AutomationException
The snap agent at the specified index. The index argument is zero based.

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.carto.IGraphicSnap
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearSnapAgents

void clearSnapAgents()
                     throws java.io.IOException,
                            AutomationException
Remove all snap agents.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addSnapAgent

void addSnapAgent(IGraphicSnap snapAgent)
                  throws java.io.IOException,
                         AutomationException
Add a new snap agent to the environment.

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

deleteSnapAgent

void deleteSnapAgent(IGraphicSnap snapAgent)
                     throws java.io.IOException,
                            AutomationException
Remove specified snap agent from the environment.

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