SnapPointsAlignment Enum

  • Reference

Definition

Namespace:
Windows.UI.Xaml.Controls.Primitives
Edit

Defines constants that specify options for snap point alignment relative to an edge. Which edge depends on the orientation of the object where the alignment is applied.

public enum class SnapPointsAlignment
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
enum class SnapPointsAlignment
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public enum SnapPointsAlignment
Public Enum SnapPointsAlignment
<object property="enumMemberName" />
Inheritance
Enum
SnapPointsAlignment
Attributes
ContractVersionAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Fields

Center 1

Use snap points that are centered in the orientation.
Far 2

Use snap points grouped farther from the orientation edge.
Near 0

Use snap points grouped closer to the orientation edge.

Remarks

This enumeration is used as a value by ScrollViewer.HorizontalSnapPointsAlignment and ScrollViewer.VerticalSnapPointsAlignment. It's also used as a parameter type for IScrollSnapPointsInfo.GetIrregularSnapPoints and IScrollSnapPointsInfo.GetRegularSnapPoints, and implementations of those methods on types, such as StackPanel.GetIrregularSnapPoints.

For a vertically oriented element, Near is the top and Far is the bottom. For a horizontally oriented element, Near is left and Far is right.

To learn more about the swipe gesture and panning, see the "Panning behaviors" section of Guidelines for panning.

Applies to

See also