Clip(Layer,Int64,Geometry,ClipMode) Method

In This Topic

Clip a feature with a geometry.

Syntax

C#
Visual Basic (Declaration)

public void Clip( 
   Layer layer,
   long oid,
   Geometry clippingGeometry,
   ClipMode clipMode
)

Public Overloads Sub Clip( _
   ByVal layer As Layer, _
   ByVal oid As Long, _
   ByVal clippingGeometry As Geometry, _
   Optional ByVal clipMode As ClipMode _
)

Parameters

layer: The layer of the feature to be clipped.
oid: The oid of the feature to be clipped.
clippingGeometry: The clipping geometry to clip the feature.
clipMode: (Optional) Determines the clipping behavior. (default value = ClipMode.PreserveArea)

Remarks

Clip intersects a feature with a geometry. The resulting geometry is determined by the clipFeatureOptions.

Example

Edit Operation Clip Features

var clipFeatures = new EditOperation() { Name = "Clip Features" };
clipFeatures.Clip(featureLayer, oid, clipPoly, ClipMode.PreserveArea);
//Execute to execute the operation
//Must be called within QueuedTask.Run
if (!clipFeatures.IsEmpty)
{
  var result = clipFeatures.Execute(); //Execute and ExecuteAsync will return true if the operation was successful and false if not
}

//or use async flavor
//await clipFeatures.ExecuteAsync();

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

EditOperation Class
EditOperation Members
Overload List

Send feedback