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


ISnappingEnvironment.Enabled Property (ArcObjects .NET 10.5 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > Controls > ESRI ArcGIS Controls > Interfaces > IS > ISnappingEnvironment Interface > ISnappingEnvironment.Enabled Property (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Controls)  

ISnappingEnvironment.Enabled Property

Toggles snapping on/off.

[Visual Basic .NET]
Public Property Enabled As Boolean

[C#]
public bool Enabled {get; set;}

[C++]
HRESULT get_Enabled(
  VARIANT_BOOL* Snapping
);

[C++]
HRESULT put_Enabled(
  VARIANT_BOOL Snapping
);

[C++]

Parameters
Snapping [out, retval]
  Snapping is a parameter of type VARIANT_BOOL
Snapping [in]
  Snapping is a parameter of type VARIANT_BOOL

Product Availability

Available with ArcGIS Engine.

Remarks

The Enabled property determines whether the snapping environment is active.  If enabled, tools that utilize the mouse movement will return valid ISnappingResult references.  Because this is setting is shared across all tools and applications, it is not recommended that individual tools modify this setting.

See Also

ISnappingEnvironment Interface