Windows Dev Center

IScrollSnapPointsInfo.GetRegularSnapPoints method

Gets the distance between regular snap points for a specified orientation and alignment.

Syntax


float GetRegularSnapPoints(
  Orientation orientation, 
  SnapPointsAlignment alignment, 
  out float offset
)

Parameters

orientation

Type: Orientation

The orientation/dimension for the desired snap point set.

alignment

Type: SnapPointsAlignment

The alignment to use when applying the snap points.

offset (out parameter)

Type: System.Single [.NET] | float32 [C++]

Out parameter. The offset of the first snap point.

Return value

Type: System.Single [.NET] | float32 [C++]

The distance between the equidistant snap points. Returns 0 when no snap points are present.

Requirements (device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.UI.Xaml.Controls.Primitives
Windows::UI::Xaml::Controls::Primitives [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (operating system)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Controls.Primitives
Windows::UI::Xaml::Controls::Primitives [C++]

Metadata

Windows.winmd

See also

IScrollSnapPointsInfo

 

 

Show:
© 2015 Microsoft