OrientedVirtualizingPanel OrientedVirtualizingPanel OrientedVirtualizingPanel OrientedVirtualizingPanel Class

Definition

Adds infrastructure (provides base class) for virtualizing layout containers that support spatial cues, such as VirtualizingStackPanel and WrapGrid.

public : class OrientedVirtualizingPanel : VirtualizingPanel, IInsertionPanel, IOrientedVirtualizingPanel, IScrollSnapPointsInfopublic class OrientedVirtualizingPanel : VirtualizingPanel, IInsertionPanel, IOrientedVirtualizingPanel, IScrollSnapPointsInfoPublic Class OrientedVirtualizingPanel Inherits VirtualizingPanel Implements IInsertionPanel, IOrientedVirtualizingPanel, IScrollSnapPointsInfo// This API is not available in Javascript.
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Inherited Members

Inherited properties

Inherited events

Inherited methods

Remarks

OrientedVirtualizingPanel derived classes

OrientedVirtualizingPanel is the parent class for VirtualizingStackPanel and WrapGrid.

Properties

AreHorizontalSnapPointsRegular AreHorizontalSnapPointsRegular AreHorizontalSnapPointsRegular AreHorizontalSnapPointsRegular

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

public : PlatForm::Boolean AreHorizontalSnapPointsRegular { get; }public bool AreHorizontalSnapPointsRegular { get; }Public ReadOnly Property AreHorizontalSnapPointsRegular As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

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

AreVerticalSnapPointsRegular AreVerticalSnapPointsRegular AreVerticalSnapPointsRegular AreVerticalSnapPointsRegular

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

public : PlatForm::Boolean AreVerticalSnapPointsRegular { get; }public bool AreVerticalSnapPointsRegular { get; }Public ReadOnly Property AreVerticalSnapPointsRegular As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

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

CanHorizontallyScroll CanHorizontallyScroll CanHorizontallyScroll CanHorizontallyScroll

Gets or sets a value that determines how the OrientedVirtualizingPanel measures space for child elements for possible scrolling in the horizontal dimension.

public : PlatForm::Boolean CanHorizontallyScroll { get; set; }public bool CanHorizontallyScroll { get; set; }Public ReadWrite Property CanHorizontallyScroll As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

true to support a potentially infinite horizontal layout dimension. false to restrict to available size.

Remarks

Note

This property is not intended to be set in XAML. You can set the panel's Orientation property in XAML and optionally change the ScrollViewer.HorizontalScrollBarVisibility or ScrollViewer.VerticalScrollBarVisibility to change how scrolling works. This property can be changed in code. In some cases you will need to use VisualTreeHelper to access the panel.

CanVerticallyScroll CanVerticallyScroll CanVerticallyScroll CanVerticallyScroll

Gets or sets a value that determines how the OrientedVirtualizingPanel measures space for child elements for possible scrolling in the vertical dimension.

public : PlatForm::Boolean CanVerticallyScroll { get; set; }public bool CanVerticallyScroll { get; set; }Public ReadWrite Property CanVerticallyScroll As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

true to support a potentially infinite vertical layout dimension. false to restrict to available size.

Remarks

Note

This property is not intended to be set inXAML. You can set the panel's Orientation property in XAML and optionally change the ScrollViewer.HorizontalScrollBarVisibility or ScrollViewer.VerticalScrollBarVisibility to change how scrolling works. This property can be changed in code. In some cases you will need to use VisualTreeHelper to access the panel.

ExtentHeight ExtentHeight ExtentHeight ExtentHeight

Gets the vertical size of the panel extent.

public : double ExtentHeight { get; }public double ExtentHeight { get; }Public ReadOnly Property ExtentHeight As double// This API is not available in Javascript.
Value
double double double double

A value in pixels.

ExtentWidth ExtentWidth ExtentWidth ExtentWidth

Gets the horizontal size of the panel extent.

public : double ExtentWidth { get; }public double ExtentWidth { get; }Public ReadOnly Property ExtentWidth As double// This API is not available in Javascript.
Value
double double double double

A value in pixels.

HorizontalOffset HorizontalOffset HorizontalOffset HorizontalOffset

Gets the horizontal offset of the scrolled content.

public : double HorizontalOffset { get; }public double HorizontalOffset { get; }Public ReadOnly Property HorizontalOffset As double// This API is not available in Javascript.
Value
double double double double

A value in pixels.

Remarks

To change the horizontal offset, call SetHorizontalOffset.

ScrollOwner ScrollOwner ScrollOwner ScrollOwner

Gets or sets a reference to a ScrollViewer that is the scroll host or scroll owner for scrolling behavior of the OrientedVirtualizingPanel.

public : PlatForm::Object ScrollOwner { get; set; }public object ScrollOwner { get; set; }Public ReadWrite Property ScrollOwner As object// This API is not available in Javascript.
Value
PlatForm::Object object object object

The scroll host or scroll owner for scrolling behavior.

VerticalOffset VerticalOffset VerticalOffset VerticalOffset

Gets the vertical offset of the scrolled content.

public : double VerticalOffset { get; }public double VerticalOffset { get; }Public ReadOnly Property VerticalOffset As double// This API is not available in Javascript.
Value
double double double double

A value in pixels.

Remarks

To change the vertical offset, call SetVerticalOffset.

ViewportHeight ViewportHeight ViewportHeight ViewportHeight

Gets the vertical size of the viewport or content area.

public : double ViewportHeight { get; }public double ViewportHeight { get; }Public ReadOnly Property ViewportHeight As double// This API is not available in Javascript.
Value
double double double double

A value in pixels.

ViewportWidth ViewportWidth ViewportWidth ViewportWidth

Gets the horizontal size of the viewport or content area.

public : double ViewportWidth { get; }public double ViewportWidth { get; }Public ReadOnly Property ViewportWidth As double// This API is not available in Javascript.
Value
double double double double

A value in pixels.

Methods

GetInsertionIndexes(Point, Int32, Int32) GetInsertionIndexes(Point, Int32, Int32) GetInsertionIndexes(Point, Int32, Int32) GetInsertionIndexes(Point, Int32, Int32)

Returns the index values of the items that the specified point is between.

public : void GetInsertionIndexes(Point position, int first, int second)public void GetInsertionIndexes(Point position, Int32 first, Int32 second)Public Function GetInsertionIndexes(position As Point, first As Int32, second As Int32) As void// This API is not available in Javascript.
Parameters
position
Point Point Point Point

The point for which to get insertion indexes.

first
int Int32 Int32 Int32

The index of the item before the specified point.

second
int Int32 Int32 Int32

The index of the item after the specified point.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

Available starting in Windows 10, version 1607.

Call this method when handling a DragOver event to return the indices of the two items between which the DragOver is happening and where a potential drop and insertion would happen.

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 IReadOnlyList<float> GetIrregularSnapPoints(Orientation orientation, SnapPointsAlignment alignment)Public Function GetIrregularSnapPoints(orientation As Orientation, alignment As SnapPointsAlignment) As IReadOnlyList( Of float )// This API is not available in Javascript.
Parameters
orientation
Orientation Orientation Orientation Orientation

The orientation for the desired snap point set.

alignment
SnapPointsAlignment SnapPointsAlignment SnapPointsAlignment SnapPointsAlignment

The alignment to use when applying the snap points.

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

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, 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// This API is not available in Javascript.
Parameters
orientation
Orientation Orientation Orientation Orientation

The orientation for the desired snap point set.

alignment
SnapPointsAlignment SnapPointsAlignment SnapPointsAlignment SnapPointsAlignment

The alignment to use when applying the snap points.

offset
float Single Single Single

Out parameter. The offset of the first snap point.

Returns
float float float float

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

LineDown() LineDown() LineDown() LineDown()

Scrolls content by one line toward the bottom.

public : void LineDown()public void LineDown()Public Function LineDown() As void// This API is not available in Javascript.

Remarks

This implementation calls SetVerticalOffset using a value for "line" of 16 pixels, which comes from a default ScrollViewer.

LineLeft() LineLeft() LineLeft() LineLeft()

Scrolls content by one line toward the left.

public : void LineLeft()public void LineLeft()Public Function LineLeft() As void// This API is not available in Javascript.

Remarks

This implementation calls SetHorizontalOffset using a value for "line" of 16 pixels, which comes from a default ScrollViewer.

LineRight() LineRight() LineRight() LineRight()

Scrolls content by one line toward the right.

public : void LineRight()public void LineRight()Public Function LineRight() As void// This API is not available in Javascript.

Remarks

This implementation calls SetHorizontalOffset using a value for "line" of 16 pixels, which comes from a default ScrollViewer.

LineUp() LineUp() LineUp() LineUp()

Scrolls content by one line toward the top.

public : void LineUp()public void LineUp()Public Function LineUp() As void// This API is not available in Javascript.

Remarks

This implementation calls SetVerticalOffset using a value for "line" of 16 pixels, which comes from a default ScrollViewer.

MakeVisible(UIElement, Rect) MakeVisible(UIElement, Rect) MakeVisible(UIElement, Rect) MakeVisible(UIElement, Rect)

Changes existing offsets in order to make the provided element visible in the viewport, and returns a Rect measurement of the area.

public : Rect MakeVisible(UIElement visual, Rect rectangle)public Rect MakeVisible(UIElement visual, Rect rectangle)Public Function MakeVisible(visual As UIElement, rectangle As Rect) As Rect// This API is not available in Javascript.
Parameters
visual
UIElement UIElement UIElement UIElement

The element to make visible.

rectangle
Rect Rect Rect Rect

A rectangle representing the element's coordinate space.

Returns

A rectangle representing the input rectangleRect transformed using the OrientedVirtualizingPanel coordinate space after scrolling happens.

MouseWheelDown() MouseWheelDown() MouseWheelDown() MouseWheelDown()

Scrolls content by one mouse-wheel click toward the bottom.

public : void MouseWheelDown()public void MouseWheelDown()Public Function MouseWheelDown() As void// This API is not available in Javascript.

Remarks

This implementation calls SetVerticalOffset using a default value for "mouse-wheel click" of 48 pixels (3 lines), which comes from a default ScrollViewer.

MouseWheelLeft() MouseWheelLeft() MouseWheelLeft() MouseWheelLeft()

Scrolls content by one mouse-wheel click toward the left.

public : void MouseWheelLeft()public void MouseWheelLeft()Public Function MouseWheelLeft() As void// This API is not available in Javascript.

Remarks

This calls SetHorizontalOffset using a default value for "mouse-wheel click" of 48 pixels (3 lines), which comes from a default ScrollViewer.

MouseWheelRight() MouseWheelRight() MouseWheelRight() MouseWheelRight()

Scrolls content by one mouse-wheel click toward the right.

public : void MouseWheelRight()public void MouseWheelRight()Public Function MouseWheelRight() As void// This API is not available in Javascript.

Remarks

This implementation calls SetHorizontalOffset using a default value for "mouse-wheel click" of 48 pixels (3 lines), which comes from a default ScrollViewer.

MouseWheelUp() MouseWheelUp() MouseWheelUp() MouseWheelUp()

Scrolls content by one mouse-wheel click toward the top.

public : void MouseWheelUp()public void MouseWheelUp()Public Function MouseWheelUp() As void// This API is not available in Javascript.

Remarks

This implementation calls SetVerticalOffset using a default value for "mouse-wheel click" of 48 pixels (3 lines), which comes from a default ScrollViewer.

PageDown() PageDown() PageDown() PageDown()

Scrolls content by one page toward the bottom.

public : void PageDown()public void PageDown()Public Function PageDown() As void// This API is not available in Javascript.

Remarks

This implementation calls SetVerticalOffset using a value for "page" that is same as the ViewportHeight.

PageLeft() PageLeft() PageLeft() PageLeft()

Scrolls content by one page toward the left.

public : void PageLeft()public void PageLeft()Public Function PageLeft() As void// This API is not available in Javascript.

Remarks

This implementation calls SetHorizontalOffset using a value for "page" that is same as the ViewportWidth.

PageRight() PageRight() PageRight() PageRight()

Scrolls content by one page toward the right.

public : void PageRight()public void PageRight()Public Function PageRight() As void// This API is not available in Javascript.

Remarks

This implementation calls SetHorizontalOffset using a value for "page" that is same as the ViewportWidth.

PageUp() PageUp() PageUp() PageUp()

Scrolls content by one page toward the top.

public : void PageUp()public void PageUp()Public Function PageUp() As void// This API is not available in Javascript.

Remarks

This implementation calls SetVerticalOffset using a value for "page" that is same as the ViewportHeight.

SetHorizontalOffset(Double) SetHorizontalOffset(Double) SetHorizontalOffset(Double) SetHorizontalOffset(Double)

Changes the horizontal offset of content within the OrientedVirtualizingPanel viewport.

public : void SetHorizontalOffset(double offset)public void SetHorizontalOffset(Double offset)Public Function SetHorizontalOffset(offset As Double) As void// This API is not available in Javascript.
Parameters
offset
double Double Double Double

The horizontal offset to set, in pixels.

SetVerticalOffset(Double) SetVerticalOffset(Double) SetVerticalOffset(Double) SetVerticalOffset(Double)

Changes the vertical offset of content within the OrientedVirtualizingPanel viewport.

public : void SetVerticalOffset(double offset)public void SetVerticalOffset(Double offset)Public Function SetVerticalOffset(offset As Double) As void// This API is not available in Javascript.
Parameters
offset
double Double Double Double

The offset to set, in pixels.

Events

HorizontalSnapPointsChanged HorizontalSnapPointsChanged HorizontalSnapPointsChanged HorizontalSnapPointsChanged

Fires when the measurements for horizontal snap points change.

public : event EventHandler HorizontalSnapPointsChanged<object>public event EventHandler HorizontalSnapPointsChanged<object>Public Event HorizontalSnapPointsChanged<object>// This API is not available in Javascript.
<orientedVirtualizingPanel HorizontalSnapPointsChanged="eventhandler" />

VerticalSnapPointsChanged VerticalSnapPointsChanged VerticalSnapPointsChanged VerticalSnapPointsChanged

Fires when the measurements for vertical snap points change.

public : event EventHandler VerticalSnapPointsChanged<object>public event EventHandler VerticalSnapPointsChanged<object>Public Event VerticalSnapPointsChanged<object>// This API is not available in Javascript.
<orientedVirtualizingPanel VerticalSnapPointsChanged="eventhandler" />

See Also