SetClipGeometry Method

Set map clipping to the provided clip polygon. This method must be called on the MCT. Use QueuedTask.Run

Syntax

public void SetClipGeometry( 
   Polygon clipPolygon,
   CIMLineSymbol border
)

Public Sub SetClipGeometry( _
   ByVal clipPolygon As Polygon, _
   ByVal border As CIMLineSymbol _
)

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentNullException	clipPolygon cannot be null

Remarks

If the clip polygon is not in the spatial reference of the map it will be projected. Clipping will be set to ArcGIS.Core.CIM.ClippingMode.CustomShape. If the border symbol is null then the existing ArcGIS.Core.CIM.CIMMap.ClippingAreaBorderSymbol will be used. If ClippingAreaBorderSymbol is also null then a default line symbol will be assigned.

Requirements

Target Platforms: Windows 11, Windows 10, Windows 8.1