com.esri.arcgis.carto
Interface IPageLayoutSnap

All Superinterfaces:
IGraphicSnap, Serializable
All Known Implementing Classes:
GridSnap, GuideSnap, MarginSnap, RulerSnap

public interface IPageLayoutSnap
extends IGraphicSnap, Serializable

Provides access to members that control snap agents that are used with PageLayout.

Remarks

This interface is used to tie the snap agents to the PageLayout object. If this property is not set, the graphic snap agents will not work properly.

Because IPageLayoutSnap inherits from IGraphicSnap, all the methods on IGraphicSnap are directly available on IPageLayoutSnap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void setPageLayout(IPageLayout rhs1)
          The PageLayout that this snap agent is associated with.
 
Methods inherited from interface com.esri.arcgis.carto.IGraphicSnap
getName, snapX, snapY
 

Method Detail

setPageLayout

void setPageLayout(IPageLayout rhs1)
                   throws IOException,
                          AutomationException
The PageLayout that this snap agent is associated with.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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