IPageLayout Interface (ArcObjects .NET 10.6 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > IP > IPageLayout Interface (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (Carto)  

IPageLayout Interface

Provides access to members that control the Page Layout. Note: the IPageLayout interface has been superseded byIPageLayout3. Please consider using the more recent version.

Product Availability

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

Members

Name Description
Read/write property AlignToMargins Indicates if graphics will be aligned to the margins or to each other.
Method FocusNextMapFrame Focus the next map.
Method FocusPreviousMapFrame Focus the previous map.
Read-only property HorizontalSnapGuides The horizontal snapping guides.
Read-only property Page The page.
Method ReplaceMaps Replace the maps in the data frames with the specified maps. If there are more maps than frames, new frames are created. If there are fewer frames than maps, extra frames are cleared.
Read-only property RulerSettings The ruler settings.
Read-only property SnapGrid The snapping grid.
Read-only property VerticalSnapGuides The vertical snapping guides.
Read-only property ZoomPercent The current zoom percent. 100 means 1:1. 200 means twice normal size, etc.
Method ZoomToPercent Magnify the page by a certain percentage. 100 means actual size. 200 means twice normal size, etc.
Method ZoomToWhole Fit the whole page in the window.
Method ZoomToWidth Fit the width of the page to the screen.

CoClasses that implement IPageLayout

CoClasses and Classes Description
PageLayout Page Layout class contains maps and map surrounds.

Remarks

The IPageLayout interface is the primary interface implemented by the ArcMap PageLayout object.

The PageLayout object is very similar to the Map object. Both are views, meaning they take control of the main application window; both are also graphics containers, meaning they can store graphical elements. If there is no map activated in layout view (IMxDocument::ActivatedView), all new graphic elements are added to the PageLayout. If a Map is activated, graphic elements are added to the focus map (IMxDocument::FocusMap).

Use this interface to access the RulerSettings, the SnapGrid, the SnapGuides, and the Page objects created and maintained by the PageLayout.

IPageLayout also has methods for zooming the view and changing the focus map.

See also the help for IPage, IRulerSettings, ISnapGrid, ISnapGuides and the examples in the Carto library overview.

.NET Snippets

Get PageLayout from ArcMap | Add North Arrow | Add Scale Bar | Add Legend

.NET Related Topics

How to create map grids | Publisher | Working with map elements | Working with map surrounds | Working with PageLayout elements