ArcGIS Pro 3.4 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / Snapping Class / SetOptions Method
a SnappingOptions object that was obtained using GetOptions
Example

In This Topic
    SetOptions Method
    In This Topic
    Sets the snapping options for the specified map. This method must be called on the MCT. Use QueuedTask.Run.
    Syntax
    public static void SetOptions( 
       Map map,
       SnappingOptions options
    )
    Public Shared Sub SetOptions( _
       ByVal map As Map, _
       ByVal options As SnappingOptions _
    ) 

    Parameters

    map
    options
    a SnappingOptions object that was obtained using GetOptions
    Exceptions
    ExceptionDescription
    if either of options or map is null
    if the XYTolerance or ZTolerance is negative, NaN or infinite
    This method or property must be called within the lambda passed to QueuedTask.Run.
    Example
    Snap Options
    //Set snapping options via get/set options
    var snapOptions = ArcGIS.Desktop.Mapping.Snapping.GetOptions(myMap);
    //At 2.x - snapOptions.SnapToSketchEnabled = true;
    snapOptions.IsSnapToSketchEnabled = true;
    snapOptions.XYTolerance = 100;
    //At 2.x - snapOptions.ZToleranceEnabled = true;
    snapOptions.IsZToleranceEnabled = true;
    snapOptions.ZTolerance = 0.6;
    
    //turn on snap tip display parts
    snapOptions.SnapTipDisplayParts = (int)SnapTipDisplayPart.SnapTipDisplayLayer + (int)SnapTipDisplayPart.SnapTipDisplayType;
    
    //turn off all snaptips
    //snapOptions.SnapTipDisplayParts = (int)SnapTipDisplayPart.SnapTipDisplayNone;
    
    //turn on layer display only
    //snapOptions.SnapTipDisplayParts = (int)SnapTipDisplayPart.SnapTipDisplayLayer;
    
    //At 2.x - snapOptions.GeometricFeedbackColor = ColorFactory.Instance.RedRGB;
    snapOptions.SnapTipColor = ColorFactory.Instance.RedRGB;
    
    ArcGIS.Desktop.Mapping.Snapping.SetOptions(myMap, snapOptions);
    
    Requirements

    Target Platforms: Windows 11, Windows 10

    ArcGIS Pro version: 3 or higher.
    See Also