WrapGrid class

Applies to Windows and Windows Phone

Positions child elements sequentially from left to right or top to bottom. When elements extend beyond the container edge, elements are positioned in the next row or column. Can only be used to display items in an ItemsControl.

Inheritance

Object
  DependencyObject
    UIElement
      FrameworkElement
        Panel
          VirtualizingPanel
            OrientedVirtualizingPanel
              WrapGrid

Syntax


public sealed class WrapGrid : OrientedVirtualizingPanel


<WrapGrid ...>
  oneOrMoreUIElements
</WrapGrid>

XAML Values

oneOrMoreUIElements

One or more object elements that define the child elements this WrapGrid should contain and present. These should be elements that derive from UIElement. Elements placed here are added to the Children collection after being parsed.

Attributes

[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06020000)]
[WebHostHidden()]

Members

The WrapGrid class has these types of members:

Constructors

The WrapGrid class has these constructors.

ConstructorDescription
WrapGrid Initializes a new instance of the WrapGrid class.

 

Events

The WrapGrid class has these events.

EventDescription
DataContextChanged Occurs when the value of the FrameworkElement.DataContext property changes. (Inherited from FrameworkElement)
DoubleTapped Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element. (Inherited from UIElement)
DragEnter Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement)
DragLeave Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement)
DragOver Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement)
Drop Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement)
GotFocus Occurs when a UIElement receives focus. (Inherited from UIElement)
Holding Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element. (Inherited from UIElement)
HorizontalSnapPointsChanged Fires when the measurements for horizontal snap points change. (Inherited from OrientedVirtualizingPanel)
KeyDown Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement)
KeyUp Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement)
LayoutUpdated Occurs when the layout of the visual tree changes, due to layout-relevant properties changing value or some other action that refreshes the layout. (Inherited from FrameworkElement)
Loaded Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction. (Inherited from FrameworkElement)
LostFocus Occurs when a UIElement loses focus. (Inherited from UIElement)
ManipulationCompleted Occurs when a manipulation on the UIElement is complete. (Inherited from UIElement)
ManipulationDelta Occurs when the input device changes position during a manipulation. (Inherited from UIElement)
ManipulationInertiaStarting Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins. (Inherited from UIElement)
ManipulationStarted Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement)
ManipulationStarting Occurs when the manipulation processor is first created. (Inherited from UIElement)
PointerCanceled Occurs when a pointer that made contact abnormally loses contact. (Inherited from UIElement)
PointerCaptureLost Occurs when pointer capture previously held by this element moves to another element or elsewhere. (Inherited from UIElement)
PointerEntered Occurs when a pointer enters the hit test area of this element. (Inherited from UIElement)
PointerExited Occurs when a pointer leaves the hit test area of this element. (Inherited from UIElement)
PointerMoved Occurs when a pointer moves while the pointer remains within the hit test area of this element. (Inherited from UIElement)
PointerPressed Occurs when the pointer device initiates a Press action within this element. (Inherited from UIElement)
PointerReleased Occurs when the pointer device that previously initiated a Press action is released, while within this element. (Inherited from UIElement)
PointerWheelChanged Occurs when the delta value of a pointer wheel changes. (Inherited from UIElement)
RightTapped Occurs when a right-tap input stimulus happens while the pointer is over the element. (Inherited from UIElement)
SizeChanged Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement. (Inherited from FrameworkElement)
Tapped Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element. (Inherited from UIElement)
Unloaded Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement)
VerticalSnapPointsChanged Fires when the measurements for vertical snap points change. (Inherited from OrientedVirtualizingPanel)

 

Methods

The WrapGrid class has these methods. It also inherits methods from the Object class.

MethodDescription
AddHandler Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked even if the event is handled elsewhere. (Inherited from UIElement)
AddInternalChild Adds the specified UIElement to the Children collection of a VirtualizingPanel element. (Inherited from VirtualizingPanel)
Arrange Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement)
ArrangeOverride Provides the behavior for the Arrange pass of layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement)
BringIndexIntoView Generates the item at the specified index location and makes it visible. (Inherited from VirtualizingPanel)
CancelDirectManipulations Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement. (Inherited from UIElement)
CapturePointer Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events. (Inherited from UIElement)
ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject)
FindName Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement)
FindSubElementsForTouchTargeting Enables a UIElement subclass to expose child elements that assist with resolving touch targeting. (Inherited from UIElement)
GetAnimationBaseValue Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetBindingExpression Returns the BindingExpression that represents the binding on the specified property. (Inherited from FrameworkElement)
GetIrregularSnapPoints Returns the set of distances between irregular snap points for a specified orientation and alignment. (Inherited from OrientedVirtualizingPanel)
GetRegularSnapPoints Gets the distance between regular snap points for a specified orientation and alignment. (Inherited from OrientedVirtualizingPanel)
GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
GoToElementStateCore When implemented in a derived class, enables per-state construction of a visual tree for a control template in code, rather than by loading XAML for all states at control startup. (Inherited from FrameworkElement)
InsertInternalChild Adds the specified UIElement to the collection of a VirtualizingPanel element at the specified index position. (Inherited from VirtualizingPanel)
InvalidateArrange Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement)
InvalidateMeasure Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement)
LineDown Scrolls content by one line toward the bottom. (Inherited from OrientedVirtualizingPanel)
LineLeft Scrolls content by one line toward the left. (Inherited from OrientedVirtualizingPanel)
LineRight Scrolls content by one line toward the right. (Inherited from OrientedVirtualizingPanel)
LineUp Scrolls content by one line toward the top. (Inherited from OrientedVirtualizingPanel)
MakeVisible Changes existing offsets in order to make the provided element visible in the viewport, and returns a Rect measurement of the area. (Inherited from OrientedVirtualizingPanel)
Measure Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement)
MeasureOverride Provides the behavior for the Measure pass of the layout cycle. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement)
MouseWheelDown Scrolls content by one mouse-wheel click toward the bottom. (Inherited from OrientedVirtualizingPanel)
MouseWheelLeft Scrolls content by one mouse-wheel click toward the left. (Inherited from OrientedVirtualizingPanel)
MouseWheelRight Scrolls content by one mouse-wheel click toward the right. (Inherited from OrientedVirtualizingPanel)
MouseWheelUp Scrolls content by one mouse-wheel click toward the top. (Inherited from OrientedVirtualizingPanel)
OnApplyTemplate Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class. (Inherited from FrameworkElement)
OnClearChildren Called when the collection of child elements is cleared by the base Panel class. (Inherited from VirtualizingPanel)
OnCreateAutomationPeer When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure. (Inherited from UIElement)
OnDisconnectVisualChildren Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property. (Inherited from UIElement)
OnItemsChanged Called when the Items collection that is associated with the ItemsControl for this Panel changes. (Inherited from VirtualizingPanel)
PageDown Scrolls content by one page toward the bottom. (Inherited from OrientedVirtualizingPanel)
PageLeft Scrolls content by one page toward the left. (Inherited from OrientedVirtualizingPanel)
PageRight Scrolls content by one page toward the right. (Inherited from OrientedVirtualizingPanel)
PageUp Scrolls content by one page toward the top. (Inherited from OrientedVirtualizingPanel)
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
ReleasePointerCapture Releases pointer captures for capture of one specific pointer by this UIElement. (Inherited from UIElement)
ReleasePointerCaptures Releases all pointer captures held by this element. (Inherited from UIElement)
RemoveHandler Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler. (Inherited from UIElement)
RemoveInternalChildRange Removes child elements from the Children collection. (Inherited from VirtualizingPanel)
SetBinding Attaches a binding to a FrameworkElement, using the provided binding object. (Inherited from FrameworkElement)
SetHorizontalOffset Changes the horizontal offset of content within the OrientedVirtualizingPanel viewport. (Inherited from OrientedVirtualizingPanel)
SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
SetVerticalOffset Changes the vertical offset of content within the OrientedVirtualizingPanel viewport. (Inherited from OrientedVirtualizingPanel)
TransformToVisual Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement)
UpdateLayout Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement)

 

Properties

The WrapGrid class has these properties.

PropertyAccess typeDescription

ActualHeight

Read-onlyGets the rendered height of a FrameworkElement. (Inherited from FrameworkElement)

ActualWidth

Read-onlyGets the rendered width of a FrameworkElement. (Inherited from FrameworkElement)

AllowDrop

Read/writeGets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement)

AreHorizontalSnapPointsRegular

Read-onlyGets a value that indicates whether the horizontal snap points for the OrientedVirtualizingPanel are equidistant from each other. (Inherited from OrientedVirtualizingPanel)

AreVerticalSnapPointsRegular

Read-onlyGets a value that indicates whether the vertical snap points for the OrientedVirtualizingPanel are equidistant from each other. (Inherited from OrientedVirtualizingPanel)

Background

Read/writeGets or sets a Brush that is used to fill the panel. (Inherited from Panel)

BaseUri

Read-onlyGets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time. (Inherited from FrameworkElement)

CacheMode

Read/writeGets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Inherited from UIElement)

CanHorizontallyScroll

Read/writeGets or sets a value that determines how the OrientedVirtualizingPanel measures space for child elements for possible scrolling in the horizontal dimension. (Inherited from OrientedVirtualizingPanel)

CanVerticallyScroll

Read/writeGets or sets a value that determines how the OrientedVirtualizingPanel measures space for child elements for possible scrolling in the vertical dimension. (Inherited from OrientedVirtualizingPanel)

Children

Read-onlyGets the collection of child elements of the panel. (Inherited from Panel)

ChildrenTransitions

Read/writeGets or sets the collection of Transition style elements that apply to child content of a Panel subclass. (Inherited from Panel)

Clip

Read/writeGets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (Inherited from UIElement)

CompositeMode

Read/writeGets or sets a property that declares alternate composition and blending modes for the element in its parent layout and window. This is relevant for elements that are involved in a mixed XAML / Microsoft DirectX UI. (Inherited from UIElement)

DataContext

Read/writeGets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement)

DesiredSize

Read-onlyGets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement)

Dispatcher

Read-onlyGets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject)

ExtentHeight

Read-onlyGets the vertical size of the panel extent. (Inherited from OrientedVirtualizingPanel)

ExtentWidth

Read-onlyGets the horizontal size of the panel extent. (Inherited from OrientedVirtualizingPanel)

FlowDirection

Read/writeGets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either LeftToRight or RightToLeft. Setting FlowDirection to RightToLeft on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left. (Inherited from FrameworkElement)

Height

Read/writeGets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement)

HorizontalAlignment

Read/writeGets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement)

HorizontalChildrenAlignment

Read/writeGets or sets the alignment rules by which child elements are arranged for the horizontal dimension.

HorizontalChildrenAlignmentProperty

Read-onlyIdentifies the HorizontalChildrenAlignment dependency property.

HorizontalOffset

Read-onlyGets the horizontal offset of the scrolled content. (Inherited from OrientedVirtualizingPanel)

IsDoubleTapEnabled

Read/writeGets or sets a value that determines whether the DoubleTapped event can originate from that element. (Inherited from UIElement)

IsHitTestVisible

Read/writeGets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement)

IsHoldingEnabled

Read/writeGets or sets a value that determines whether the Holding event can originate from that element. (Inherited from UIElement)

IsItemsHost

Read-onlyGets a value that indicates whether this Panel is a container for UI items that are generated by an ItemsControl. (Inherited from Panel)

IsRightTapEnabled

Read/writeGets or sets a value that determines whether the RightTapped event can originate from that element. (Inherited from UIElement)

IsTapEnabled

Read/writeGets or sets a value that determines whether the Tapped event can originate from that element. (Inherited from UIElement)

ItemContainerGenerator

Read-onlyGets a value that identifies the ItemContainerGenerator for this VirtualizingPanel. (Inherited from VirtualizingPanel)

ItemHeight

Read/writeGets or sets the height of the layout area for each item that is contained in a WrapGrid.

ItemHeightProperty

Read-onlyIdentifies the ItemHeight dependency property.

ItemWidth

Read/writeGets or sets the width of the layout area for each item that is contained in a WrapGrid.

ItemWidthProperty

Read-onlyIdentifies the ItemWidth dependency property.

Language

Read/writeGets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI. (Inherited from FrameworkElement)

ManipulationMode

Read/writeGets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. Setting this value enables handling the manipulation events from this element in app code. (Inherited from UIElement)

Margin

Read/writeGets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement)

MaxHeight

Read/writeGets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement)

MaximumRowsOrColumns

Read/writeGets or sets a value that influences the wrap point, also accounting for Orientation.

MaximumRowsOrColumnsProperty

Read-onlyIdentifies the MaximumRowsOrColumns dependency property.

MaxWidth

Read/writeGets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement)

MinHeight

Read/writeGets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement)

MinWidth

Read/writeGets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement)

Name

Read/writeGets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement)

Opacity

Read/writeGets or sets the degree of the object's opacity. (Inherited from UIElement)

Orientation

Read/writeGets or sets the direction in which child elements are arranged.

OrientationProperty

Read-onlyIdentifies the Orientation dependency property.

Parent

Read-onlyGets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement)

PointerCaptures

Read-onlyGets the set of all captured pointers, represented as Pointer values. (Inherited from UIElement)

Projection

Read/writeGets or sets the perspective projection (3-D effect) to apply when rendering this element. (Inherited from UIElement)

RenderSize

Read-onlyGets the final render size of a UIElement. (Inherited from UIElement)

RenderTransform

Read/writeGets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement)

RenderTransformOrigin

Read/writeGets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement)

RequestedTheme

Read/writeGets or sets the UI theme that is used by the UIElement (and its child elements) for resource determination. The UI theme you specify with RequestedTheme can override the app-level RequestedTheme. (Inherited from FrameworkElement)

Resources

Read/writeGets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement)

ScrollOwner

Read/writeGets or sets a reference to a ScrollViewer that is the scroll host or scroll owner for scrolling behavior of the OrientedVirtualizingPanel. (Inherited from OrientedVirtualizingPanel)

Style

Read/writeGets or sets an instance Style that is applied for this object during layout and rendering. (Inherited from FrameworkElement)

Tag

Read/writeGets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement)

Transitions

Read/writeGets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement)

Triggers

Read-onlyGets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. (Inherited from FrameworkElement)

UseLayoutRounding

Read/writeGets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement)

VerticalAlignment

Read/writeGets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement)

VerticalChildrenAlignment

Read/writeGets or sets the alignment rules by which child elements are arranged for the vertical dimension.

VerticalChildrenAlignmentProperty

Read-onlyIdentifies the VerticalChildrenAlignment dependency property.

VerticalOffset

Read-onlyGets the vertical offset of the scrolled content. (Inherited from OrientedVirtualizingPanel)

ViewportHeight

Read-onlyGets the vertical size of the viewport or content area. (Inherited from OrientedVirtualizingPanel)

ViewportWidth

Read-onlyGets the horizontal size of the viewport or content area. (Inherited from OrientedVirtualizingPanel)

Visibility

Read/writeGets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout. (Inherited from UIElement)

Width

Read/writeGets or sets the width of a FrameworkElement. (Inherited from FrameworkElement)

 

Remarks

WrapGrid can only be used to display items in an ItemsControl. A primary scenario for WrapGrid is that it provides the items panel template behavior for GridView in default templates.

The content of a WrapGrid is virtualized. This can improve performance when you work with large data sets. For more info, see Load, store, and display large sets of data efficiently.

In a WrapGrid, elements are arranged in rows or columns that automatically wrap to a new row or column when the MaximumRowsOrColumns value is reached. The Orientation property specifies whether the grid adds its items in rows or columns before wrapping.

When the value is Vertical, the grid adds items in columns from top to bottom, then wraps from left to right, like this:

Item 1Item 4Item 7
Item 2Item 5Item 8
Item 3Item 6Item 9

 

When the value is Horizontal, the grid adds items in rows from left to right, then wraps from top to bottom, like this:

Item 1Item 2Item 3
Item 4Item 5Item 6
Item 7Item 8Item 9

 

Windows 8 behavior

For Windows 8, items added to the items lists programmatically at run-time sometimes would start a new row in the internal grid representation, even if the item could have been added to an existing row based on the MaximumRowsOrColumns setting.

Starting with Windows 8.1, items added to items lists programmatically at run-time will fill rows in expected ways, starting a new row only when row-column limits are exceeded.

This behavior difference usually has no effect on the layout the user sees, because the items control that contains the WrapGrid is ultimately controlling the layout. But the difference can be detected if you are using coordinate-relative techniques to check the layout within the WrapGrid. For instance, you might see coordinate differences if you are calling TransformToVisual or VisualTreeHelper APIs, with the WrapGrid as the "relative-to" element.

If you migrate your app code from Windows 8 to Windows 8.1, and you're doing advanced layout verification with TransformToVisual or VisualTreeHelper within a WrapGrid you may want to account for this behavior change.

Apps that were compiled for Windows 8 but running on Windows 8.1 continue to use the Windows 8 behavior.

Examples

Here's how to use a WrapGrid to change the layout of items in a ListView. The WrapGrid replaces the default StackPanel, which arranges items in a single column. We set the WrapGrid.MaximumRowsOrColumns property so that items are arranged in 2 columns.


<ListView Height="320" Width="260">
    <ListView.ItemsPanel>
        <ItemsPanelTemplate>
            <WrapGrid Orientation="Horizontal" MaximumRowsOrColumns="2"/>
        </ItemsPanelTemplate>
    </ListView.ItemsPanel>

    <Rectangle Height="100" Width="100" Fill="Blue" />
    <Rectangle Height="100" Width="100" Fill="Red" />
    <Rectangle Height="100" Width="100" Fill="Yellow" />
    <Rectangle Height="100" Width="100" Fill="Green" />
    <Rectangle Height="100" Width="100" Fill="Gray" />
    <Rectangle Height="100" Width="100" Fill="LightBlue" />
    <Rectangle Height="100" Width="100" Fill="Pink" />
    <Rectangle Height="100" Width="100" Fill="YellowGreen" />
</ListView>


Requirements

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

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

Metadata

Windows.winmd

See also

OrientedVirtualizingPanel
IScrollSnapPointsInfo
ItemsControl.ItemsPanel
ItemsPanelTemplate
Quickstart: Adding ListView and GridView controls

 

 

Show:
© 2014 Microsoft