ArcGIS Pro 3.7 API Reference Guide
ArcGIS.Desktop.Layouts Namespace / LayoutSnapping Class / SetSnapMode Method
Example

In This Topic
    SetSnapMode Method (LayoutSnapping)
    In This Topic

    Sets the state of a single LayoutSnapMode.

    Syntax
    Public Shared Sub SetSnapMode( _
       ByVal mode As LayoutSnapMode, _
       ByVal value As Boolean _
    ) 
    public static void SetSnapMode( 
       LayoutSnapMode mode,
       bool value
    )

    Parameters

    mode
    value
    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 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.0 or higher.
    See Also