IScrollSnapPointsInfo IScrollSnapPointsInfo IScrollSnapPointsInfo Interface

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

Syntax

Declaration

public interface IScrollSnapPointsInfopublic interface IScrollSnapPointsInfoPublic Interface IScrollSnapPointsInfo

Properties summary

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

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

Methods summary

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

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

Events summary

Occurs when the measurements for horizontal snap points change.

Occurs when the measurements for vertical snap points change.

Properties

  • AreHorizontalSnapPointsRegular
    AreHorizontalSnapPointsRegular
    AreHorizontalSnapPointsRegular
    AreHorizontalSnapPointsRegular

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

    public bool AreHorizontalSnapPointsRegular { get; }public bool AreHorizontalSnapPointsRegular { get; }Public ReadOnly Property AreHorizontalSnapPointsRegular As boolpublic bool AreHorizontalSnapPointsRegular { get; }

    Property Value

    • bool
      bool
      bool

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

  • AreVerticalSnapPointsRegular
    AreVerticalSnapPointsRegular
    AreVerticalSnapPointsRegular
    AreVerticalSnapPointsRegular

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

    public bool AreVerticalSnapPointsRegular { get; }public bool AreVerticalSnapPointsRegular { get; }Public ReadOnly Property AreVerticalSnapPointsRegular As boolpublic bool AreVerticalSnapPointsRegular { get; }

    Property Value

    • bool
      bool
      bool

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

Methods

  • GetIrregularSnapPoints(Orientation, SnapPointsAlignment)
    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 IVectorView<float> GetIrregularSnapPoints(Orientation orientation, SnapPointsAlignment alignment)Public Function GetIrregularSnapPoints(orientation As Orientation, alignment As SnapPointsAlignment) As IVectorView( Of float )public IVectorView<float> GetIrregularSnapPoints(Orientation orientation, SnapPointsAlignment alignment)

    Parameters

    Returns

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

  • GetRegularSnapPoints(Orientation, SnapPointsAlignment, Single)
    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, Single offset)public float GetRegularSnapPoints(Orientation orientation, SnapPointsAlignment alignment, Single offset)Public Function GetRegularSnapPoints(orientation As Orientation, alignment As SnapPointsAlignment, offset As Single) As floatpublic float GetRegularSnapPoints(Orientation orientation, SnapPointsAlignment alignment, Single offset)

    Parameters

    Returns

    • float
      float
      float

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

Events

  • HorizontalSnapPointsChanged
    HorizontalSnapPointsChanged
    HorizontalSnapPointsChanged
    HorizontalSnapPointsChanged

    Occurs when the measurements for horizontal snap points change.

    public abstract event EventHandler HorizontalSnapPointsChangedpublic abstract event EventHandler HorizontalSnapPointsChangedPublic MustInherit Event HorizontalSnapPointsChangedpublic abstract event EventHandler HorizontalSnapPointsChanged
  • VerticalSnapPointsChanged
    VerticalSnapPointsChanged
    VerticalSnapPointsChanged
    VerticalSnapPointsChanged

    Occurs when the measurements for vertical snap points change.

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

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.GuidAttribute
Windows.Foundation.Metadata.WebHostHiddenAttribute

Details

Assembly

Windows.UI.Xaml.Controls.Primitives.dll