SetSnapModes Method (LayoutSnapping)

In This Topic

Sets the given snapping modes.

Syntax

Visual Basic (Declaration)
C#

Public Shared Sub SetSnapModes( _
   ByVal modes As IEnumerable(Of LayoutSnapMode) _
)

public static void SetSnapModes( 
   IEnumerable<LayoutSnapMode> modes
)

Parameters

modes: a collection of LayoutSnapMode parameters

Remarks

This method disables the current snapping modes and enables the given snapping modes. It is intended to efficiently set one or more snapping modes.

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.

Reference

LayoutSnapping Class
LayoutSnapping Members

Send feedback