ItemsControl Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Represents a control that can be used to present a collection of items.
System.Windows::DependencyObject
System.Windows::UIElement
System.Windows::FrameworkElement
System.Windows.Controls::Control
System.Windows.Controls::ItemsControl
Microsoft.Phone.Controls::Panorama
Microsoft.Phone.Controls::Pivot
Microsoft.Phone.Controls.Primitives::PivotHeadersControl
System.Windows.Controls.Primitives::Selector
Assembly: System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.
The ItemsControl type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | ActualHeight | Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.) |
![]() | ActualWidth | Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.) |
![]() | AllowDrop | Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement.) |
![]() | Background | (Inherited from Control.) |
![]() | BorderBrush | (Inherited from Control.) |
![]() | BorderThickness | (Inherited from Control.) |
![]() | CacheMode | Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.) |
![]() | CharacterSpacing | (Inherited from Control.) |
![]() | Clip | Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.) |
![]() | Cursor | Infrastructure. Gets or sets the cursor image that displays while the pointer is over a FrameworkElement. (Inherited from FrameworkElement.) |
![]() | DataContext | Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.) |
![]() | DefaultStyleKey | (Inherited from Control.) |
![]() | DesiredSize | Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.) |
![]() | Dispatcher | Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.) |
![]() | DisplayMemberPath | Gets or sets the name or path of the property that is displayed for each data item. |
![]() | FlowDirection | Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.) |
![]() | FontFamily | (Inherited from Control.) |
![]() | FontSize | (Inherited from Control.) |
![]() | FontStretch | (Inherited from Control.) |
![]() | FontStyle | (Inherited from Control.) |
![]() | FontWeight | (Inherited from Control.) |
![]() | Foreground | (Inherited from Control.) |
![]() | Height | Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.) |
![]() | HorizontalAlignment | Gets 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.) |
![]() | HorizontalContentAlignment | (Inherited from Control.) |
![]() | IsEnabled | (Inherited from Control.) |
![]() | IsHitTestVisible | Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.) |
![]() | IsTabStop | (Inherited from Control.) |
![]() | ItemContainerGenerator | Gets the ItemContainerGenerator associated with this ItemsControl. |
![]() | Items | Gets the collection used to generate the content of the control. |
![]() | ItemsPanel | Gets or sets the template that defines the panel that controls the layout of items. |
![]() | ItemsSource | Gets or sets a collection used to generate the content of the ItemsControl. |
![]() | ItemTemplate | Gets or sets the DataTemplate used to display each item. |
![]() | Language | Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.) |
![]() | Margin | Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.) |
![]() | MaxHeight | Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
![]() | MaxWidth | Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
![]() | MinHeight | Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
![]() | MinWidth | Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
![]() | Name | Gets 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 | Gets or sets the degree of the object's opacity. (Inherited from UIElement.) |
![]() | OpacityMask | Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.) |
![]() | Padding | (Inherited from Control.) |
![]() | Parent | Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.) |
![]() | Projection | Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.) |
![]() | RenderSize | Gets the final render size of a UIElement. (Inherited from UIElement.) |
![]() | RenderTransform | Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.) |
![]() | RenderTransformOrigin | Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.) |
![]() | Resources | Gets 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.) |
![]() | Style | Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.) |
![]() | TabIndex | (Inherited from Control.) |
![]() | TabNavigation | (Inherited from Control.) |
![]() | Tag | Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.) |
![]() | Template | (Inherited from Control.) |
![]() | Triggers | Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.) |
![]() | UseLayoutRounding | Gets 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.) |
![]() | UseOptimizedManipulationRouting | Gets or sets a value that indicates whether the system should handle input events or whether the FrameworkElement should handle input events. (Inherited from FrameworkElement.) |
![]() | VerticalAlignment | Gets 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.) |
![]() | VerticalContentAlignment | (Inherited from Control.) |
![]() | Visibility | Gets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.) |
![]() | Width | Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.) |
| Name | Description | |
|---|---|---|
![]() | 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 for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.) |
![]() | ApplyTemplate | (Inherited from Control.) |
![]() | 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 Windows Phone layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.) |
![]() | CaptureMouse | Sets touch capture to a UIElement. (Inherited from UIElement.) |
![]() | CheckAccess | Determines whether the calling thread has access to this object. (Inherited from DependencyObject.) |
![]() | ClearContainerForItemOverride | Undoes the effects of the PrepareContainerForItemOverride method. |
![]() | ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject.) |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
![]() | FindName | Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.) |
![]() | Focus | (Inherited from Control.) |
![]() | GetAnimationBaseValue | Returns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.) |
![]() | GetBindingExpression | Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.) |
![]() | GetContainerForItemOverride | Creates or identifies the element that is used to display the given item. |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() ![]() | GetItemsOwner | Returns the ItemsControl that the specified element hosts items for. |
![]() | GetTemplateChild | (Inherited from Control.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.) |
![]() | 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.) |
![]() | IsItemItsOwnContainerOverride | Determines if the specified item is (or is eligible to be) its own container. |
![]() ![]() | ItemsControlFromItemContainer | Returns the ItemsControl that owns the specified container element. |
![]() | 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 Windows Phone layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | OnApplyTemplate | When overridden in a derived class, is 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 an application. For more information, see Remarks. (Inherited from FrameworkElement.) |
![]() | OnCreateAutomationPeer | When implemented in a derived class, returns class-specific AutomationPeer implementations for the Windows Phone automation infrastructure. (Inherited from UIElement.) |
![]() | OnDoubleTap | (Inherited from Control.) |
![]() | OnDragEnter | (Inherited from Control.) |
![]() | OnDragLeave | (Inherited from Control.) |
![]() | OnDragOver | (Inherited from Control.) |
![]() | OnDrop | (Inherited from Control.) |
![]() | OnGotFocus | (Inherited from Control.) |
![]() | OnHold | (Inherited from Control.) |
![]() | OnItemsChanged | Called when the value of the Items property changes. |
![]() | OnKeyDown | (Inherited from Control.) |
![]() | OnKeyUp | (Inherited from Control.) |
![]() | OnLostFocus | (Inherited from Control.) |
![]() | OnLostMouseCapture | (Inherited from Control.) |
![]() | OnManipulationCompleted | (Inherited from Control.) |
![]() | OnManipulationDelta | (Inherited from Control.) |
![]() | OnManipulationStarted | (Inherited from Control.) |
![]() | OnMouseEnter | (Inherited from Control.) |
![]() | OnMouseLeave | (Inherited from Control.) |
![]() | OnMouseLeftButtonDown | (Inherited from Control.) |
![]() | OnMouseLeftButtonUp | (Inherited from Control.) |
![]() | OnMouseMove | (Inherited from Control.) |
![]() | OnMouseRightButtonDown | (Inherited from Control.) |
![]() | OnMouseRightButtonUp | (Inherited from Control.) |
![]() | OnMouseWheel | (Inherited from Control.) |
![]() | OnTap | (Inherited from Control.) |
![]() | OnTextInput | (Inherited from Control.) |
![]() | OnTextInputStart | (Inherited from Control.) |
![]() | OnTextInputUpdate | (Inherited from Control.) |
![]() | PrepareContainerForItemOverride | Prepares the specified element to display the specified item. |
![]() | ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.) |
![]() | ReleaseMouseCapture | Removes touch capture from a UIElement. After this call, typically no object holds touch capture. (Inherited from UIElement.) |
![]() | RemoveHandler | Removes the specified routed event handler from this UIElement. (Inherited from UIElement.) |
![]() | SetBinding | Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.) |
![]() | SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | 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.) |
| Name | Description | |
|---|---|---|
![]() | BindingValidationError | Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.) |
![]() | DoubleTap | Occurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.) |
![]() | GotFocus | Occurs when a UIElement receives focus. (Inherited from UIElement.) |
![]() | Hold | Occurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.) |
![]() | IsEnabledChanged | (Inherited from Control.) |
![]() | 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 Windows Phone visual tree changes. (Inherited from FrameworkElement.) |
![]() | Loaded | Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.) |
![]() | LostFocus | Occurs when a UIElement loses focus. (Inherited from UIElement.) |
![]() | LostMouseCapture | Occurs when the UIElement loses touch capture. (Inherited from UIElement.) |
![]() | ManipulationCompleted | Occurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.) |
![]() | ManipulationDelta | Occurs when the input device changes position during a manipulation. (Inherited from UIElement.) |
![]() | ManipulationStarted | Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.) |
![]() | MouseEnter | Occurs when a screen tap occurs within the bounding area of a UIElement. (Inherited from UIElement.) |
![]() | MouseLeave | Occurs when a touch event occurs outside the bounding area of a UIElement. (Inherited from UIElement.) |
![]() | MouseLeftButtonDown | Occurs when a UIElement is tapped. (Inherited from UIElement.) |
![]() | MouseLeftButtonUp | Occurs when the finger is lifted off of a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.) |
![]() | MouseMove | Occurs when the coordinate position of the finger on the screen while touching a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.) |
![]() | MouseWheel | Infrastructure. Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.) |
![]() | SizeChanged | Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.) |
![]() | Tap | Occurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.) |
![]() | TextInput | Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.) |
![]() | TextInputStart | Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.) |
![]() | TextInputUpdate | Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.) |
![]() | Unloaded | Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.) |
| Name | Description | |
|---|---|---|
![]() ![]() | DisplayMemberPathProperty | Identifies the DisplayMemberPath dependency property. |
![]() ![]() | ItemsPanelProperty | Identifies the ItemsPanel dependency property. |
![]() ![]() | ItemsSourceProperty | Identifies the ItemsSource dependency property. |
![]() ![]() | ItemTemplateProperty | Identifies the ItemTemplate dependency property. |
In general, an ItemsControl serves two roles. It can be used to present a fixed set of items, or it can be used to display a list obtained from data binding to an object. There are several controls that inherit from ItemsControl that you can use in your application, but you can also use an ItemsControl directly. For example, if you have a collection of data that you want to display as a nonselectable list, you can use an ItemsControl to contain the data. Regardless of whether you use the ItemsControl or a child class, you can use the ItemTemplate to specify the appearance of each item.
If you want to display a fixed list, populate Items with one or more FrameworkElement child objects, and leave DisplayMemberPath as the default empty string. Do not specify ItemsSource.
If you want to display data from an object source, specify ItemsSource to be a reference to an object. Usually you do this through a Binding declaration, and the resolution mechanism for the object being used as the binding source is potentially influenced by the acting DataContext. You can set DisplayMemberPath to be the name or path of the particular property that should be displayed as repeating data by using a default display for the returned object. Or you can leave DisplayMemberPath as the default empty string, and specify a DataTemplate for ItemTemplate. This last approach gives you more control of the visual representation of each item, and it also enables you to display multiple properties of each data-bound object within each item by using a layout that you define in the template.
The following example creates an ItemsControl. By default, an ItemsControl lists items but does not have any other visual characteristics, such as chrome. The example specifies a ControlTemplate to give the ItemsControl a border. It also specifies a DataTemplate to specify the appearance of each item and an ItemsPanelTemplate to lay out the items horizontally.
<Grid> <Grid.Resources> <src:Tasks x:Key="myTodoList"/> </Grid.Resources> <ItemsControl Margin="10" Width="400" ItemsSource="{Binding Source={StaticResource myTodoList}}"> <!--Use the Template property to specify a ControlTemplate to define the appearance of an ItemsControl. The ItemsPresenter uses the specified ItemsPanelTemplate (defined below) to layout the items. If an ItemsPanelTemplate is not specified, the default is used. (For ItemsControl, the default is an ItemsPanelTemplate that specifies a StackPanel that arranges items vertically.)--> <ItemsControl.Template> <ControlTemplate TargetType="ItemsControl"> <Border BorderBrush="Aqua" BorderThickness="1" CornerRadius="15"> <ItemsPresenter/> </Border> </ControlTemplate> </ItemsControl.Template> <!--Use the ItemsPanel property to specify an ItemsPanelTemplate that defines the panel that is used to hold the generated items. In other words, use this property if you want to affect how the items are laid out.--> <ItemsControl.ItemsPanel> <ItemsPanelTemplate> <StackPanel Orientation="Horizontal"/> </ItemsPanelTemplate> </ItemsControl.ItemsPanel> <!--Use the ItemTemplate to set a DataTemplate to define the appeatance of the data objects. This DataTemplate specifies that each data object appears with the Proriity and TaskName on top of a silver ellipse.--> <ItemsControl.ItemTemplate> <DataTemplate> <Grid Width="70" Margin="5"> <Ellipse Fill="Silver"/> <StackPanel> <TextBlock Margin="3,3,3,0" FontSize="12" HorizontalAlignment="Center" Text="{Binding Path=Priority}"/> <TextBlock Margin="3,0,3,7" FontSize="12" HorizontalAlignment="Center" Text="{Binding Path=TaskName}"/> </StackPanel> </Grid> </DataTemplate> </ItemsControl.ItemTemplate> </ItemsControl> </Grid>
public class Task : INotifyPropertyChanged { private string name; private int priority; public event PropertyChangedEventHandler PropertyChanged; public Task() { } public Task(string name, int priority) { this.name = name; this.priority = priority; } public override string ToString() { return name.ToString(); } public string TaskName { get { return name; } set { name = value; OnPropertyChanged("TaskName"); } } public int Priority { get { return priority; } set { priority = value; OnPropertyChanged("Priority"); } } protected void OnPropertyChanged(string info) { PropertyChangedEventHandler handler = PropertyChanged; if (handler != null) { handler(this, new PropertyChangedEventArgs(info)); } } } public class Tasks : ObservableCollection<Task> { public Tasks() : base() { Add(new Task("Shopping", 2)); Add(new Task("Laundry", 2)); Add(new Task("Email", 1)); Add(new Task("Clean", 3)); Add(new Task("Dinner", 1)); } }
The previous example produces output that resembles the following illustration.







