This document is archived and information here might be outdated.  Recommended version.


IPageLayoutControlDefault Interface (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Controls > ESRI ArcGIS Controls > Interfaces > IP > IPageLayoutControlDefault Interface
ArcGIS Developer Help

IPageLayoutControlDefault Interface

Provides access to members that control the PageLayoutControl.

Product Availability

Available with ArcGIS Engine.

Description

The IPageLayoutControlDefault interface is the default dispatch interface that most development environments will automatically expose. For example, placing the PageLayoutControl in a container will typically generate an object called PageLayoutControl1. The properties and methods available directly on this object correspond to this interface, together with container specific properties and methods.

The IPageLayoutControlDefault interface is a 'pure' dispatch interface, so can be extended with new properties and methods at future releases of ArcGIS. The methods and properties are identical to the highest numbered main interface on the PageLayoutControl. For example, IPageLayoutControlDefault is equivalent to IPageLayoutControl2, but at future releases this could become IPageLayoutControl3. By using the IPageLayoutControlDefault interface you are guaranteed to always have access to the latest PageLayoutControl. 

There is a small performance overhead in making calls through to a pure dispatch interface, but to avoid this you can QI to a specific interface. In some development environments it is not possible to QI directly on the control to other COM interfaces, because the control is contained within a wrapper object. Use the Object property to get the real control before performing the QI.

Members

Name Description
Method AboutBox Displays a dialog of information about the PageLayoutControl.
Read-only property ActiveView The active view of the PageLayout contained by the PageLayoutControl.
Method AddElement Adds the supplied element to the PageLayout, with optional geometry, symbolization, name and Z order.
Read/write property Appearance The appearance of the PageLayoutControl.
Read/write property AutoKeyboardScrolling Indicates whether keyboard scrolling is enabled.
Read/write property AutoMouseWheel Indicates whether the mouse wheel is enabled.
Read/write property BackColor Background color of the PageLayoutControl.
Read/write property BorderStyle The border style of the PageLayoutControl.
Method CenterAt Moves the center of the PageLayoutControl to the specified location.
Method CheckMxFile Checks the specified filename to see if it is a map document that can be loaded into the PageLayoutControl.
Read/write property CurrentTool Current active tool for the PageLayoutControl. Set to nothing to clear the tool.
Read/write property CustomProperty A property to associate data with a control.
Read/write property DocumentFilename The filename of the last map document loaded into the control.
Read/write property Enabled Indicates whether the PageLayoutControl can respond to user generated events.
Read/write property Extent Current extent of the PageLayout in page units.
Method FindElementByName Find the first element with the supplied name, supply an occurrence parameter to find the second, third and so on.
Method FromPagePoint Converts a point on the page (in page units) to device co-ordinates (typically pixels).
Read/write property FullExtent Rectangular shape that encloses the PageLayout.
Read-only property GraphicsContainer The graphics container of the PageLayout object contained by the PageLayoutControl.
Read-only property hWnd Handle to the window associated with the PageLayoutControl.
Read/write property 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.
Method LoadMxFile Loads the specified map document into the PageLayout contained by the PageLayoutControl.
Method 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.
Read/write property MouseIcon Custom mouse icon used if MousePointer is 99.
Read/write property MousePointer The mouse pointer displayed over the PageLayoutControl.
Read-only property 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.
Read/write property OleDropEnabled Indicates if the PageLayoutControl will fire events when data is dragged over the control's window.
Read-only property Page The Page associated with the PageLayout contained by the PageLayoutControl.
Read/write property PageLayout The PageLayout contained by the PageLayoutControl.
Method Pan Tracks the mouse while panning the PageLayoutControl.
Read/write property Printer The printer object used by the PageLayoutControl for printing.
Read-only property PrinterPageCount The number of printer pages the PageLayout will cover.
Method PrintPageLayout Sends the specified range of pages on the printer.
Method Refresh Redraws the PageLayout, optionally just redraw specified phases or envelope.
Method SuppressResizeDrawing Suppress full redraw of control during resize operations.
Method ToPagePoint Converts device co-ordinates (typically pixels) to a point on the page (in page units).
Read/write property TrackCancel The object used by the PageLayoutControl to check if drawing has been aborted.
Method TrackRectangle Rubber-bands a rectangle on the PageLayoutControl.
Method ZoomToWholePage Changes the extent of the PageLayout to show a whole page.

Classes that implement IPageLayoutControlDefault

Classes Description
PageLayoutControl Esri PageLayoutControl
[C#]

When querying interface to IPageLayoutControlDefault 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.

IPageLayoutControlDefault pageLayoutControl = axPageLayoutControl1.Object as IPageLayoutControlDefault;

[Visual Basic .NET]

When querying interface to IPageLayoutControlDefault 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.

Dim pageLayoutControl As IPageLayoutControlDefault = AxPageLayoutControl1.Object