com.esri.arcgis.carto
Interface ISnapGuides

All Superinterfaces:
Serializable
All Known Implementing Classes:
SnapGuides

public interface ISnapGuides
extends Serializable

Provides access to members that control the Snapping guides.

Remarks

You can use guides in the page layout view to align elements on the page.

The PageLayout object has two SnapGuides objects, one for managing horizontal guides, and one for managing vertical guides. Use IPageLayout::VerticalSnapGuides or IPageLayout::HorizontalSnapguides to obtain a reference to the desired SnapGuides object.

Each SnapGuides object manages an internal collection of individual guides. Use ISnapGuides to add a new guide, remove a guide, and turn the visibility of the guides on or off.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


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.
 

Method Detail

isAreVisible

boolean isAreVisible()
                     throws IOException,
                            AutomationException
Indicates if snapping guides are visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setAreVisible

void setAreVisible(boolean areVisible)
                   throws IOException,
                          AutomationException
Indicates if snapping guides are visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDrawLevel

int getDrawLevel()
                 throws IOException,
                        AutomationException
Level where guides are drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriViewDrawPhase constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDrawLevel

void setDrawLevel(int drawLevel)
                  throws IOException,
                         AutomationException
Level where guides are drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
drawLevel - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGuideCount

int getGuideCount()
                  throws IOException,
                         AutomationException
The number of guides.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setGuide

void setGuide(int idx,
              double pos)
              throws IOException,
                     AutomationException
The nth guide. The position is specified in page units.

Product Availability

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

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

getGuide

double getGuide(int idx)
                throws IOException,
                       AutomationException
The nth guide. The position is specified in page units.

Product Availability

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

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

addGuide

void addGuide(double pos)
              throws IOException,
                     AutomationException
Adds a guide at the specified position. The position is specified in page units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

removeGuide

void removeGuide(int idx)
                 throws IOException,
                        AutomationException
Removes the nth guide.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

removeAllGuides

void removeAllGuides()
                     throws IOException,
                            AutomationException
Removes all the guides.

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(IDisplay display,
          boolean isHorizontal)
          throws IOException,
                 AutomationException
Draw a fine line showing exactly where objects will snap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

drawHighlight

void drawHighlight(IDisplay display,
                   boolean isHorizontal)
                   throws IOException,
                          AutomationException
Draw a highlight around the snap line for a nice visual effect.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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