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

IMap.ClipBorder Property (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > IM > IMap Interface > IMap.ClipBorder Property
ArcGIS Developer Help

IMap.ClipBorder Property

An optional border drawn around ClipGeometry.

[Visual Basic .NET]
Public Property ClipBorder As IBorder
public IBorder ClipBorder {get; set;}
HRESULT get_ClipBorder(
  IBorder** Border
HRESULT put_ClipBorder(
  IBorder* Border
Border [out, retval]

Border is a parameter of type IBorder** Border [in]
Border is a parameter of type IBorder*

Product Availability

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


If a ClipGeometry has been set, you have the option of drawing a border around the clipped map.  Use the ClipBorder propety to specify the type of border drawn.

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.

By default there is no clip geometry or clip border.

See Also

IMap Interface | IMap.ClipGeometry Property