ArcObjects Library Reference (Controls)

IPageLayoutControl2 Interface

Provides access to members that control the PageLayoutControl. Note: the IPageLayoutControl2 interface has been superseded byIPageLayoutControl3. Please consider using the more recent version.

Product Availability

Available with ArcGIS Engine.

Description

The IPageLayoutControl2 interface provides additional members for tasks related to the PageLayoutControl, such as setting a custom property and suppressing data redraw whilst the PageLayoutControl is being resized.

Members

	Name	Description
	AboutBox	Displays a dialog of information about the PageLayoutControl.
	ActiveView	The active view of the PageLayout contained by the PageLayoutControl.
	AddElement	Adds the supplied element to the PageLayout, with optional geometry, symbolization, name and Z order.
	Appearance	The appearance of the PageLayoutControl.
	BackColor	Background color of the PageLayoutControl.
	BorderStyle	The border style of the PageLayoutControl.
	CenterAt	Moves the center of the PageLayoutControl to the specified location.
	CheckMxFile	Checks the specified filename to see if it is a map document that can be loaded into the PageLayoutControl.
	CurrentTool	Current active tool for the PageLayoutControl. Set to nothing to clear the tool.
	CustomProperty	A property to associate data with a control.
	DocumentFilename	The filename of the last map document loaded into the control.
	Enabled	Indicates whether the PageLayoutControl can respond to user generated events.
	Extent	Current extent of the PageLayout in page units.
	FindElementByName	Find the first element with the supplied name, supply an occurrence parameter to find the second, third and so on.
	FromPagePoint	Converts a point on the page (in page units) to device co-ordinates (typically pixels).
	FullExtent	Rectangular shape that encloses the PageLayout.
	GraphicsContainer	The graphics container of the PageLayout object contained by the PageLayoutControl.
	hWnd	Handle to the window associated with the PageLayoutControl.
	KeyIntercept	A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.
	LoadMxFile	Loads the specified map document into the PageLayout contained by the PageLayoutControl.
	LocateFrontElement	Locates an element at the given page co-ordinates. If more than one element is at the location the element nearest the front is returned.
	MouseIcon	Custom mouse icon used if MousePointer is 99.
	MousePointer	The mouse pointer displayed over the PageLayoutControl.
	Object	A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.
	OleDropEnabled	Indicates if the PageLayoutControl will fire events when data is dragged over the control's window.
	Page	The Page associated with the PageLayout contained by the PageLayoutControl.
	PageLayout	The PageLayout contained by the PageLayoutControl.
	Pan	Tracks the mouse while panning the PageLayoutControl.
	Printer	The printer object used by the PageLayoutControl for printing.
	PrinterPageCount	The number of printer pages the PageLayout will cover.
	PrintPageLayout	Sends the specified range of pages on the printer.
	Refresh	Redraws the PageLayout, optionally just redraw specified phases or envelope.
	SuppressResizeDrawing	Suppress full redraw of control during resize operations.
	ToPagePoint	Converts device co-ordinates (typically pixels) to a point on the page (in page units).
	TrackCancel	The object used by the PageLayoutControl to check if drawing has been aborted.
	TrackRectangle	Rubber-bands a rectangle on the PageLayoutControl.
	ZoomToWholePage	Changes the extent of the PageLayout to show a whole page.

CoClasses that implement IPageLayoutControl2

CoClasses and Classes	Description
PageLayoutControl	Esri PageLayoutControl

[C#]

When querying interface to IPageLayoutControl2 in Visual Basic .NET or Visual C# .NET the Object property or container specific code must be used. This is because .NET contains the real control inside a wrapper object known as an host.

IPageLayoutControl2 pageLayoutControl=axPageLayoutControl1.Object as IPageLayoutControl2;

[Visual Basic .NET]

Dim pageLayoutControl As IPageLayoutControl2=AxPageLayoutControl1.Object

.NET Samples

Synchronized MapControl and PageLayoutControl application (Code Files: ControlsSynchronizer frmMain)