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


ISnappingResult.Description Property (ArcObjects .NET 10.4 SDK)
ArcObjects namespaces > Controls > ESRI ArcGIS Controls > Interfaces > IS > ISnappingResult Interface > ISnappingResult.Description Property (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (Controls)  

ISnappingResult.Description Property

Gets the description of the snap that occurred.

[Visual Basic .NET]
Public ReadOnly Property Description As String

[C#]
public string Description {get;}

[C++]
HRESULT get_Description(
  BSTR* desc
);

[C++]

Parameters
desc [out, retval]
  desc is a parameter of type BSTR

Product Availability

Available with ArcGIS Engine.

Remarks

The description contains information describing the nature of the snapping result returned.  The content of the description is determined by the value of ISnappingEnvironment.SnapTipType.  If the SnapTipType is set to display the layer name and snapping type, the description is returned in the following format: <layer name> : <snapping type>.   If the SnapTipType is set to return no tip, the description returned is an empty string.

See Also

ISnappingResult Interface