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


IHookHelper.PageLayout Property (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Controls)  

IHookHelper.PageLayout Property

Page layout of hooked control or application.

[Visual Basic .NET]
Public ReadOnly Property PageLayout As IPageLayout
[C#]
public IPageLayout PageLayout {get;}
[C++]
HRESULT get_PageLayout(
  IPageLayout** ppPageLayout
);
[C++]

Parameters ppPageLayout [out, retval]
ppPageLayout is a parameter of type IPageLayout

Product Availability

Available with ArcGIS Engine.

Description

The PageLayout of the hook passed to the ICommand::OnCreate event. The Pagelayout is returned regardless of whether the hook is a PageLayoutControl, ToolbarControl (with a 'buddy' PageLayoutControl) or ArcMap.

If the hook is a MapControl the property will return nothing as PageLayout objects are not supported.

Errors Returned

1059 800A0423: The supplied hook is not a valid object. 

1060 800A0424: The supplied hook is not valid. 

1061 800A0425: IARPageLayout::get_InternalObject failed. 

See Also

IHookHelper Interface