com.esri.arcgis.carto
Interface ISnapGrid

All Superinterfaces:

Serializable

All Known Implementing Classes:

SnapGrid

public interface ISnapGrid
extends Serializable

Provides access to members that control the Snapping grid.

Remarks

The layout view supports a snap grid, which is a grid of reference points on the layout used to help position elements. The grid may be used as a visual indicator of size and position, or it may be used to snap elements into position.
The primary interface on the SnapGrid object is ISnapGrid. Use this interface to change the grid’s horizontal and vertical spacing and control whether or not the grid is visible.

Product Availability

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

Method Summary

void	draw(IDisplay display, IPage page) Draw the grid.
double	getHorizontalSpacing() The horizontal distance between grid points.
double	getVerticalSpacing() The vertical distance between grid points.
boolean	isVisible() Indicates if the snapping grid is visible.
void	setHorizontalSpacing(double spacing) The horizontal distance between grid points.
void	setIsVisible(boolean isVisible) Indicates if the snapping grid is visible.
void	setVerticalSpacing(double spacing) The vertical distance between grid points.

Method Detail

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the snapping grid is visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The isVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsVisible

void setIsVisible(boolean isVisible)
                  throws IOException,
                         AutomationException

Indicates if the snapping grid is visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

isVisible - The isVisible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHorizontalSpacing

double getHorizontalSpacing()
                            throws IOException,
                                   AutomationException

The horizontal distance between grid points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The spacing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontalSpacing

void setHorizontalSpacing(double spacing)
                          throws IOException,
                                 AutomationException

The horizontal distance between grid points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

spacing - The spacing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerticalSpacing

double getVerticalSpacing()
                          throws IOException,
                                 AutomationException

The vertical distance between grid points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The spacing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalSpacing

void setVerticalSpacing(double spacing)
                        throws IOException,
                               AutomationException

The vertical distance between grid points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

spacing - The spacing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display,
          IPage page)
          throws IOException,
                 AutomationException

Draw the grid.

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)

page - A reference to a com.esri.arcgis.carto.IPage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.