Back to Devexpress

XtraReport.SnappingMode Property

xtrareports-devexpress-dot-xtrareports-dot-ui-dot-xtrareport-296f7871.md

latest3.8 KB
Original Source

XtraReport.SnappingMode Property

Specifies the mode in which report elements are snapped to each other when they are resized or being relocated.

Namespace : DevExpress.XtraReports.UI

Assembly : DevExpress.XtraReports.v25.2.dll

NuGet Package : DevExpress.Reporting.Core

Declaration

csharp
[DefaultValue(SnappingMode.SnapLines)]
[SRCategory(ReportStringId.CatDesign)]
public SnappingMode SnappingMode { get; set; }
vb
<SRCategory(ReportStringId.CatDesign)>
<DefaultValue(SnappingMode.SnapLines)>
Public Property SnappingMode As SnappingMode

Property Value

TypeDefaultDescription
SnappingModeSnapLines

A SnappingMode enumeration value representing the snapping mode.

|

Available values:

NameDescription
None

No snapping is used.

| | SnapLines |

Represents the snapping mode, which aligns a report element using snap lines.

| | SnapToGrid |

Represents the snapping mode, which aligns a report element to the report snap grid.

| | SnapToGridAndSnapLines |

Represents the snapping mode, which aligns a report element to both the snap grid and snap lines.

|

Remarks

The SnappingMode property specifies the snapping mode used to align report elements to each other.

  • None - no snapping is used.
  • SnapLines - enables snapping to snap lines, which appear around the report control that is being moved or resized and indicates the distance to other report elements. Snap lines maintain the inner padding of report bands and outer margins of report controls specified by the Band.SnapLinePadding and XRControl.SnapLineMargin properties, respectively.
  • SnapToGrid - enables snapping to the snap grid whose dimensions are defined by the XtraReport.SnapGridSize property. To specify whether to draw the grid over the report surface, use the XtraReport.DrawGrid property.
  • SnapToGridAndSnapLines - enables snapping to both the snap grid and snap lines.

For more information, refer to Arrange Report Controls.

Note

You can set the SnappingMode property globally, so that all the newly created reports have this property set to the required value. For this purpose, use the Report Designer Options dialog available within the XtraReports menu.

See Also

Manipulate Report Controls

SnapLinePadding

SnapLineMargin

DrawGrid

SnapGridSize

XtraReport Class

XtraReport Members

DevExpress.XtraReports.UI Namespace