Share via


IScrollSnapPointsInfo.GetRegularSnapPoints Method

Definition

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

public:
 float GetRegularSnapPoints(Orientation orientation, SnapPointsAlignment alignment, [Out] float & offset);
float GetRegularSnapPoints(Orientation const& orientation, SnapPointsAlignment const& alignment, [Out] float & offset);
public float GetRegularSnapPoints(Orientation orientation, SnapPointsAlignment alignment, out float offset);
Public Function GetRegularSnapPoints (orientation As Orientation, alignment As SnapPointsAlignment, ByRef offset As Single) As Single

Parameters

orientation
Orientation

The orientation/dimension for the desired snap point set.

alignment
SnapPointsAlignment

The alignment to use when applying the snap points.

offset
Single

float

Out parameter. The offset of the first snap point.

Returns

Single

float

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

Applies to