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


ITopologicalOperator5.ClipEx Method (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (Geometry)  

ITopologicalOperator5.ClipEx Method

Constructs the intersection of this geometry and the specified envelope.

[Visual Basic .NET]
Public Sub ClipEx ( _
    ByVal clipperEnvelope As IEnvelope, _
    ByVal bIncludeBoundary As Boolean _
)

[C#]
public void ClipEx (
    IEnvelope clipperEnvelope,
    bool bIncludeBoundary
);

[C++]
HRESULT ClipEx(
  IEnvelope* clipperEnvelope,
  VARIANT_BOOL bIncludeBoundary
);

[C++]

Parameters
clipperEnvelope 

  clipperEnvelope is a parameter of type IEnvelope*
bIncludeBoundary 

  bIncludeBoundary is a parameter of type bool

Product Availability

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

Description

The ClipEx method clips the geometry of the feature that is receiving the method call to the input clipperEnvelope, with the added option of whether you want to include segments lying on the boundary.

Remarks

ITopologicalOperator5 methods must be applied on high-level geometries only. High-Level geometries are point, multipoint, polyline and polygon. To use this interface with low-level geometries such as segments (Line, Circular Arc, Elliptic Arc, Bezier Curve), paths or rings, they must be wrapped into high-level geometry types.

See Also

ITopologicalOperator5 Interface