Back to Devexpress

DockingOptions.SnapMode Property

windowsforms-devexpress-dot-xtrabars-dot-docking-dot-dockingoptions-3db47a59.md

latest2.5 KB
Original Source

DockingOptions.SnapMode Property

Gets or sets whether or not dock panels can stick to each other, parent forms or screen edges.

Namespace : DevExpress.XtraBars.Docking

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[XtraSerializableProperty]
public virtual SnapMode SnapMode { get; set; }
vb
<XtraSerializableProperty>
Public Overridable Property SnapMode As SnapMode

Property Value

TypeDescription
DevExpress.Utils.Controls.SnapMode

A DevExpress.Utils.Controls.SnapMode enumerator value that specifies whether or not dock panels can stick to each other, parent forms or screen edges.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to SnapMode
DockManager

.DockingOptions .SnapMode

|

Remarks

The SnapMode property accepts one or multiple values of the SnapMode enumerator. Each value allows dock panels to snap to specific targets when end-users drag these panels at runtime.

  • OwnerControl - dock panels snap to a parent control (not a form) that owns this DockManager component.
  • OwnerForm - dock panels snap to the owner form’s bounds.
  • Screens - dock panels snap to screen edges.
  • SnapForms - dock panels snap to each other and sticky windows.
  • All - dock panels snap to any available target mentioned above.
  • None - dock panels do not snap.

See the Snap Window Behavior article to learn how to implement window snapping for controls that do not support it out-of-the-box.

See Also

DockingOptions Class

DockingOptions Members

DevExpress.XtraBars.Docking Namespace