ArcObjects Library Reference  (Controls)    

PageLayoutControl CoClass

ESRI PageLayoutControl

Product Availability

Available with ArcGIS Engine.

Description

The PageLayoutControl encapsulates the PageLayout CoClass and provides additional properties, methods and events for: managing the general appearance, display properties and page properties of the control; adding and finding elements within the control; loading map documents into the control; dropping data onto the control from other applications; and printing.

Extended Error Information

Use the ISupportErrorInfo method InterfaceSupportsErrorInfo to determine if the object supports extended error information. If the object supports extended error info, VC++ developers should use the OLE/COM IErrorInfo interface to access the ErrorInfo object. Visual Basic developers should use the global error object Err to retrieve this extended error information.

Interfaces

Interfaces Description
IConnectionPointContainer Supports connection points for connectable objects.
IMxdContents (esriCarto) Provides access to members to pass data into and out off a MXD map document file. Coclasses that implement this interface can limited the implementation to one property if required.
IPageLayoutControl Provides access to members that control the PageLayoutControl.
IPageLayoutControl2 Provides access to members that control the PageLayoutControl.
IPageLayoutControl3 Provides access to members that control the PageLayoutControl.
IPageLayoutControlDefault Provides access to members that control the PageLayoutControl.
IPersist Defines the single method GetClassID, which is designed to supply the CLSID of an object that can be stored persistently in the system. IPersist is the base interface for three other interfaces: IPersistStorage, IPersistStream, and IPersistFile.
IPersistStreamInit Supports initialized stream-based persistence, regardless of whatever else the object does.
ISupportErrorInfo Indicates whether a specific interface can return Automation error objects.
ITOCBuddy Provides access to members that control the TOC buddy.
IToolbarBuddy Provides access to members that control the ToolbarControl buddy.

Event Interfaces

Interfaces Description
IPageLayoutControlEvents (default) Provides access to events that occur with user interaction to the PageLayoutControl.
ITOCBuddyEvents Provides access to events that notify the TOC of a change.

Remarks

The PageLayoutControl uses a ScreenDisplay as the display object for drawing and will therefore react to the same keyboard and mouse actions as the ScreenDisplay object. 

There is no need to declare the PageLayoutControl 's outbound interface as described below in most development environments, because the interface is automaticlly implemented.

[Visual Basic 6.0]

To create a PageLayoutControl programmatically use the following code:

Dim pPageLayoutControl As esriControls.IPageLayoutControl2 
Set pPageLayoutControl = CreateObject("esriControls.PageLayoutControl")

Working with Events

[Visual Basic 6.0]

When working with PageLayoutControl's default outbound interface in Visual Basic 6 declare variables as follows:

Private WithEvents pPageLayoutControl as PageLayoutControl

When implementing ITOCBuddyEvents declare variables as follows:

Private WithEvents pMapControl as MapControl