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


IDisplay.ClipGeometry Property (ArcObjects .NET 10.7 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Display > ESRI.ArcGIS.Display > Interfaces > ID > IDisplay Interface > IDisplay.ClipGeometry Property
ArcGIS Developer Help

IDisplay.ClipGeometry Property

User-specified clip shape. This shape is merged with the invalid region to arrive at the actual clip region. Must be specified before StartDrawing.

[Visual Basic .NET]
Public Property ClipGeometry As IGeometry
[C#]
public IGeometry ClipGeometry {get; set;}
[C++]
HRESULT get_ClipGeometry(
  IGeometry** Geometry
);
[C++]
HRESULT put_ClipGeometry(
  IGeometry* Geometry
);
[C++]
Parameters
Geometry [out, retval]

Geometry is a parameter of type IGeometry** Geometry [in]
Geometry is a parameter of type IGeometry*

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Remarks

Use the ClipGeometry  property to shape the area data is drawn in.  For example, if you had a map of the United States that contained many layers, you could set the ClipGeometry property on the focus Map's ScreenDisplay object equal to the geometry of a particular state thereby telling the map to only draw the data falling within the particular state's area.  The ClipGeometry is used to cookie-cut all data before it is drawn.

See IMap::ClipGeometry for a more information and a sample.

See Also

IDisplay Interface