com.esri.arcgis.carto
Interface ISnapGuides

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ISnapGuidesProxy, SnapGuides

public interface ISnapGuides
extends java.io.Serializable

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

Description: 'Provides access to members that control the Snapping guides.' 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	IID31e081ab_cb02_11d1_876c_0000f8751720
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addGuide(double pos) Adds a guide at the specified position.
void	draw(IDisplay display, boolean isHorizontal) Draw a fine line showing exactly where objects will snap.
void	drawHighlight(IDisplay display, boolean isHorizontal) Draw a highlight around the snap line for a nice visual effect.
int	getDrawLevel() Level where guides are drawn.
double	getGuide(int idx) The nth guide.
int	getGuideCount() The number of guides.
boolean	isAreVisible() Indicates if snapping guides are visible.
void	removeAllGuides() Removes all the guides.
void	removeGuide(int idx) Removes the nth guide.
void	setAreVisible(boolean areVisible) Indicates if snapping guides are visible.
void	setDrawLevel(int drawLevel) Level where guides are drawn.
void	setGuide(int idx, double pos) The nth guide.

Field Detail

IID31e081ab_cb02_11d1_876c_0000f8751720

static final int IID31e081ab_cb02_11d1_876c_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

isAreVisible

boolean isAreVisible()
                     throws java.io.IOException,
                            AutomationException

Indicates if snapping guides are visible.

Returns:

The areVisible

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAreVisible

void setAreVisible(boolean areVisible)
                   throws java.io.IOException,
                          AutomationException

Indicates if snapping guides are visible.

Parameters:

areVisible - The areVisible (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDrawLevel

int getDrawLevel()
                 throws java.io.IOException,
                        AutomationException

Level where guides are drawn.

Returns:

A com.esri.arcgis.carto.esriViewDrawPhase constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrawLevel

void setDrawLevel(int drawLevel)
                  throws java.io.IOException,
                         AutomationException

Level where guides are drawn.

Parameters:

drawLevel - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGuideCount

int getGuideCount()
                  throws java.io.IOException,
                         AutomationException

The number of guides.

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGuide

void setGuide(int idx,
              double pos)
              throws java.io.IOException,
                     AutomationException

The nth guide. The position is specified in page units.

Parameters:

idx - The idx (in)

pos - The pos (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGuide

double getGuide(int idx)
                throws java.io.IOException,
                       AutomationException

The nth guide. The position is specified in page units.

Parameters:

idx - The idx (in)

Returns:

The pos

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addGuide

void addGuide(double pos)
              throws java.io.IOException,
                     AutomationException

Adds a guide at the specified position. The position is specified in page units.

Parameters:

pos - The pos (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeGuide

void removeGuide(int idx)
                 throws java.io.IOException,
                        AutomationException

Removes the nth guide.

Parameters:

idx - The idx (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllGuides

void removeAllGuides()
                     throws java.io.IOException,
                            AutomationException

Removes all the guides.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display,
          boolean isHorizontal)
          throws java.io.IOException,
                 AutomationException

Draw a fine line showing exactly where objects will snap.

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay (in)

isHorizontal - The isHorizontal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawHighlight

void drawHighlight(IDisplay display,
                   boolean isHorizontal)
                   throws java.io.IOException,
                          AutomationException

Draw a highlight around the snap line for a nice visual effect.

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay (in)

isHorizontal - The isHorizontal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.