ArcGIS Pro 3.2 API Reference Guide
ArcGIS.Desktop.Layouts Namespace / LayoutSnapping Class / GetSnapMode Method
Example

In This Topic
    GetSnapMode Method (LayoutSnapping)
    In This Topic
    Gets the state of a single LayoutSnapMode.
    Syntax
    public static bool GetSnapMode( 
       LayoutSnapMode mode
    )
    Public Shared Function GetSnapMode( _
       ByVal mode As LayoutSnapMode _
    ) As Boolean

    Parameters

    mode
    Example
    Configure Snapping - Application SnapModes
    // sets only the Guide snapping mode 
    ArcGIS.Desktop.Layouts.LayoutSnapping.SetSnapModes(new[] { LayoutSnapMode.Guide });
    // sets only Element and Page snapping modes
    ArcGIS.Desktop.Layouts.LayoutSnapping.SetSnapModes(new[] { LayoutSnapMode.Element, LayoutSnapMode.Page }); 
    
    // clear all snap modes
    ArcGIS.Desktop.Layouts.LayoutSnapping.SetSnapModes(null);
    
    
    // set snap modes one at a time
    ArcGIS.Desktop.Layouts.LayoutSnapping.SetSnapMode(LayoutSnapMode.Margins, true);
    ArcGIS.Desktop.Layouts.LayoutSnapping.SetSnapMode(LayoutSnapMode.Guide, true);
    /// LayoutSnapping.SetSnapModes(new[]{ LayoutSnapMode.Guide }); // sets only the Guide snapping mode 
    
    // get current snap modes
    var snapModes = ArcGIS.Desktop.Layouts.LayoutSnapping.SnapModes;
    
    // get state of a specific snap mode
    bool isOn = ArcGIS.Desktop.Layouts.LayoutSnapping.GetSnapMode(LayoutSnapMode.Guide);
    
    Requirements

    Target Platforms: Windows 11, Windows 10

    ArcGIS Pro version: 3 or higher.
    See Also