This document is archived and information here might be outdated. Recommended version. |
Provides access to members that control the PageLayoutControl.
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.
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. | |
AutoKeyboardScrolling | Indicates whether keyboard scrolling is enabled. | |
AutoMouseWheel | Indicates whether the mouse wheel is enabled. | |
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. |
Classes | Description |
---|---|
PageLayoutControl | Esri PageLayoutControl |
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;
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