 |
This document is archived and information here might be outdated. Recommended version. |
IMap.ClipGeometry Property (ArcObjects .NET 10.5 SDK)
|
This document is archived and information here might be outdated. Recommended version. |
| ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > IM > IMap Interface > IMap.ClipGeometry Property (ArcObjects .NET 10.5 SDK) |
A shape that layers in the map are clipped to.
[Visual Basic .NET] Public Property ClipGeometry As IGeometry
[C#] public IGeometry ClipGeometry {get; set;}
[C++]
HRESULT get_ClipGeometry(
IGeometry** ClipGeometry
);
[C++]
HRESULT put_ClipGeometry(
IGeometry* ClipGeometry
);
[C++]
Parameters ClipGeometry [out, retval]
ClipGeometry is a parameter of type IGeometry ClipGeometry [in]
ClipGeometry is a parameter of type IGeometry
Use the ClipGeometry property to shape the area the Map is drawn in. For example, if you had a map of the United States that contained many layers, you could set the Map's ClipGeometry equal to the geometry of a particular state thereby telling the map to only draw the map data falling within the particular state's area.
The scripts below demonstrate this.
In the ArcMap user interface, the same functionality is available on the map's data frame properties page. Right-click on a map in the table of contents and select Properties. Select the Data Frame tab and look at 'Clip to Shape'. Under 'Specify a Shape', select 'Outline of Data Graphics'. You can also specify a 'Custom Extent' or use the 'Outline of Features'.
The ClipBorder property puts a border around the cut out.
By default there is no clip geometry and no clip border.