LayoutSnapMode Enumeration

In This Topic

Specifies the available snap modes for a Layout.

Syntax

C#
Visual Basic (Declaration)

public enum LayoutSnapMode : System.Enum, System.IComparable, System.IConvertible, System.IFormattable, System.ISpanFormattable

Public Enum LayoutSnapMode 
   Inherits System.Enum
   Implements System.IComparable, System.IConvertible, System.IFormattable, System.ISpanFormattable

Members

Member	Description
Element	Snap to layout tangent.
Guide	Snap to layout guide.
Margins	Snap to layout print margins.
Page	Snap to layout page.

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);

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         ArcGIS.Desktop.Layouts.LayoutSnapMode

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

ArcGIS.Desktop.Layouts Namespace

Send feedback