I​Scroll​Snap​Points​Info I​Scroll​Snap​Points​Info I​Scroll​Snap​Points​Info Interface

Definition

Describes snap point behavior for objects that contain and present items.

public : interface IScrollSnapPointsInfopublic interface IScrollSnapPointsInfoPublic Interface IScrollSnapPointsInfo
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

AreHorizontalSnapPointsRegular AreHorizontalSnapPointsRegular AreHorizontalSnapPointsRegular

Gets a value that indicates whether the horizontal snap points for the container are equidistant from each other.

public : PlatForm::Boolean AreHorizontalSnapPointsRegular { get; }public bool AreHorizontalSnapPointsRegular { get; }Public ReadOnly Property AreHorizontalSnapPointsRegular As bool
Value
PlatForm::Boolean bool bool

true if the horizontal snap points for the container are equidistant from each other; otherwise, false.

Attributes

AreVerticalSnapPointsRegular AreVerticalSnapPointsRegular AreVerticalSnapPointsRegular

Gets a value that indicates whether the vertical snap points for the container are equidistant from each other.

public : PlatForm::Boolean AreVerticalSnapPointsRegular { get; }public bool AreVerticalSnapPointsRegular { get; }Public ReadOnly Property AreVerticalSnapPointsRegular As bool
Value
PlatForm::Boolean bool bool

true if the vertical snap points for the container are equidistant from each other; otherwise, false.

Attributes

Methods

GetIrregularSnapPoints(Orientation, SnapPointsAlignment) GetIrregularSnapPoints(Orientation, SnapPointsAlignment) GetIrregularSnapPoints(Orientation, SnapPointsAlignment)

Returns the set of distances between irregular snap points for a specified orientation and alignment.

public : IVectorView<float> GetIrregularSnapPoints(Orientation orientation, SnapPointsAlignment alignment)public IReadOnlyList<float> GetIrregularSnapPoints(Orientation orientation, SnapPointsAlignment alignment)Public Function GetIrregularSnapPoints(orientation As Orientation, alignment As SnapPointsAlignment) As IReadOnlyList( Of float )
Parameters
orientation
Orientation Orientation Orientation

The orientation/dimension for the desired snap point set.

alignment
SnapPointsAlignment SnapPointsAlignment SnapPointsAlignment

The alignment to use when applying the snap points.

Returns
IVectorView<float> IReadOnlyList<float> IReadOnlyList<float>

The read-only collection of snap point distances. Returns an empty collection when no snap points are present.

Attributes

GetRegularSnapPoints(Orientation, SnapPointsAlignment, Single) GetRegularSnapPoints(Orientation, SnapPointsAlignment, Single) GetRegularSnapPoints(Orientation, SnapPointsAlignment, Single)

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

public : float GetRegularSnapPoints(Orientation orientation, SnapPointsAlignment alignment, float offset)public float GetRegularSnapPoints(Orientation orientation, SnapPointsAlignment alignment, Single offset)Public Function GetRegularSnapPoints(orientation As Orientation, alignment As SnapPointsAlignment, offset As Single) As float
Parameters
orientation
Orientation Orientation Orientation

The orientation/dimension for the desired snap point set.

alignment
SnapPointsAlignment SnapPointsAlignment SnapPointsAlignment

The alignment to use when applying the snap points.

offset
float Single Single

Out parameter. The offset of the first snap point.

Returns
float float float

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

Attributes

Events

HorizontalSnapPointsChanged HorizontalSnapPointsChanged HorizontalSnapPointsChanged

Occurs when the measurements for horizontal snap points change.

public : abstract event EventHandler HorizontalSnapPointsChangedpublic abstract event EventHandler HorizontalSnapPointsChangedPublic MustInherit Event HorizontalSnapPointsChanged
Attributes

VerticalSnapPointsChanged VerticalSnapPointsChanged VerticalSnapPointsChanged

Occurs when the measurements for vertical snap points change.

public : abstract event EventHandler VerticalSnapPointsChangedpublic abstract event EventHandler VerticalSnapPointsChangedPublic MustInherit Event VerticalSnapPointsChanged
Attributes