ArcObjects Library Reference (PublisherControls)  

IARPageLayout Interface

Provides access to members that control the ARPageLayout.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Description

The IARPageLayout interface is a starting point for navigating around the page, setting the page properties and accessing any map's contained within the page.

Members

Description
Read-only property ARMap The map at the specified index.
Read-only property ARMapCount The number of maps in the page layout's map collection.
Read-only property CanRedoExtent Indicates if there is a page layout extent that can be redone.
Read-only property CanUndoExtent Indicates if there is a page layout extent that can be undone.
Method CenterAt Moves the center of the page layout to the specified point.
Read/write property CustomProperty A property to associate data with an object.
Read/write property FocusARMap The current focus map that the current tool acts upon.
Method GetExtent The visible extent of the page layout.
Read-only property HasTitle Indicates if the page layout has a title that can be changed.
Read-only property Height The height of the page.
Method HitTestMap Returns the first map present in the page layout at the specified coordinates. If there isn't a map or the coordinates are not over a map, nothing will be returned.
Read-only property InternalObject The internal ArcObjects IPageLayout object.
Read-only property MapExtentType The extent type of the specified map.
Read/write property PageUnits The units of the page and all associated coordinates.
Method Pan Pans the page layout by a factor in a specified direction.
Method RedoExtent Redo the next page layout extent in the stack.
Method Refresh Redraws the page layout display area.
Method SetExtent Sets the visible extent of the page layout.
Read/write property Title The title in the page layout. Not all page layouts have a title that can be changed, use the HasTitle method to check this.
Method ToPagePoint Converts a point in device coordinates (typically pixels) to coordinates in page units.
Method UndoExtent Undo to the previous page layout extent in the stack.
Read-only property Width The width of the page.
Method ZoomIn Zooms in on the page layout by a factor.
Method ZoomOut Zooms out on the page layout by a factor.
Read-only property ZoomPercent The zoom percent (100 means 1:1, 200 means twice the normal size).
Method ZoomToPercent Magnifies the page by a percentage (100 means actual size, 200 means twice the normal size).
Method ZoomToWholePage Zooms to the whole page.
Method ZoomToWidth Fits the width of the page into the page layout display area.

CoClasses that implement IARPageLayout

CoClasses and Classes Description
ARPageLayout The ARPageLayout container for the display of a page.