ArcObjects Library Reference (Controls)

IPageLayoutControl.FullExtent Property

Rectangular shape that encloses the PageLayout.

[Visual Basic .NET]
Public Property FullExtent As IEnvelope

[C#]
public IEnvelope FullExtent {get; set;}

[C++]
HRESULT get_FullExtent(
  IEnvelope** FullExtent
);

[C++]
HRESULT put_FullExtent(
  IEnvelope* FullExtent
);

[C++]
Parameters
FullExtent [out, retval]
  FullExtent is a parameter of type IEnvelope
FullExtent [in]
  FullExtent is a parameter of type IEnvelope

Product Availability

Available with ArcGIS Engine.

Description

Returns or sets an envelope object which by default is the PageLayout's page size expanded by a factor of 1.9 and which is automatically set whenever the page size changes. Setting the FullExtent triggers the IPageLayoutControlEvents::OnFullExtentUpated event.

Errors Returned

1015 800A03F7: The supplied envelope represents is an invalid extent

Remarks

The FullExtent property is a shortcut to IActiveView::FullExtent which is in turn a shortcut to IDisplayTransformation::Bounds. Setting the FullExtent property will not affect the Extent property.

[C#]

To set the Extent to view the whole of the PageLayout use one of the following:

//Set Extent to the whole Page expanded by a factor of 1.9
axPageLayoutControl1.Extent = axPageLayoutControl1.FullExtent;

//Set Extent to the whole Page
axPageLayoutControl1.ZoomToWholePage();

[Visual Basic .NET]