Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

ItemsPanelTemplate Class

.NET Framework 4

Specifies the panel that the ItemsPresenter creates for the layout of the items of an ItemsControl.

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.FrameworkTemplate
      System.Windows.Controls.ItemsPanelTemplate

Namespace:  System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
C#
C++
F#
VB
Copy 
public class ItemsPanelTemplate : FrameworkTemplate
XAML Object Element Usage
Copy 
<ItemsPanelTemplate>
  VisualTree
</ItemsPanelTemplate>

The ItemsPanelTemplate type exposes the following members.

  Name Description
Public method ItemsPanelTemplate() Initializes an instance of the ItemsPanelTemplate class.
Public method ItemsPanelTemplate(FrameworkElementFactory) Initializes an instance of the ItemsPanelTemplate class with the specified template.
Top
  Name Description
Public property Dispatcher Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public property HasContent Gets a value that indicates whether this template has optimized content. (Inherited from FrameworkTemplate.)
Public property IsSealed Gets a value that indicates whether this object is in an immutable state so it cannot be changed. (Inherited from FrameworkTemplate.)
Public property Resources Gets or sets the collection of resources that can be used within the scope of this template. (Inherited from FrameworkTemplate.)
Public property Template Gets or sets a reference to the object that records or plays the XAML nodes for the template when the template is defined or applied by a writer. (Inherited from FrameworkTemplate.)
Public property VisualTree Gets or sets the root node of the template. (Inherited from FrameworkTemplate.)
Top
  Name Description
Public method CheckAccess Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FindName Finds the element associated with the specified name defined within this template. (Inherited from FrameworkTemplate.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method LoadContent Loads the content of the template as an instance of an object and returns the root element of the content. (Inherited from FrameworkTemplate.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method RegisterName Registers a new name/object pair into the current name scope. (Inherited from FrameworkTemplate.)
Public method Seal Locks the template so it cannot be changed. (Inherited from FrameworkTemplate.)
Public method ShouldSerializeResources Returns a value that indicates whether serialization processes should serialize the value of the Resources property on instances of this class. (Inherited from FrameworkTemplate.)
Public method ShouldSerializeVisualTree Returns a value that indicates whether serialization processes should serialize the value of the VisualTree property on instances of this class. (Inherited from FrameworkTemplate.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method UnregisterName Removes a name/object mapping from the XAML namescope. (Inherited from FrameworkTemplate.)
Protected method ValidateTemplatedParent Checks that the templated parent is a non-null ItemsPresenter object. (Overrides FrameworkTemplate.ValidateTemplatedParent(FrameworkElement).)
Public method VerifyAccess Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top
  Name Description
Explicit interface implemetation Private method INameScope.FindName Infrastructure. Returns an object that has the provided identifying name. (Inherited from FrameworkTemplate.)
Explicit interface implemetation Private method IQueryAmbient.IsAmbientPropertyAvailable Queries whether a specified ambient property is available in the current scope. (Inherited from FrameworkTemplate.)
Top

The ItemsPanelTemplate specifies the panel that is used for the layout of items. GroupStyle has a Panel property that is of type ItemsPanelTemplate. ItemsControl types have an ItemsPanel property that is of type ItemsPanelTemplate.

Each ItemsControl type has a default ItemsPanelTemplate. For the ItemsControl class, the default ItemsPanel value is an ItemsPanelTemplate that specifies a StackPanel. For the ListBox, the default uses the VirtualizingStackPanel. For MenuItem, the default uses WrapPanel. For StatusBar, the default uses DockPanel.

To create a horizontal ListBox, you can create a template that specifies a horizontal StackPanel and set it as the ItemsPanel property. The following example shows a ListBox Style that creates a horizontal ListBox.

XAML
Copy 

<Style TargetType="ListBox">
  <Setter Property="ItemsPanel">
    <Setter.Value>
      <ItemsPanelTemplate>
        <StackPanel Orientation="Horizontal"
                    VerticalAlignment="Center"
                    HorizontalAlignment="Center"/>
      </ItemsPanelTemplate>
    </Setter.Value>
  </Setter>
</Style>

The following example uses a ControlTemplate to create a horizontal ListBox that has rounded corners. Note that in this example, instead of setting the ItemsPanel property as in previous example, the horizontal StackPanel is specified within the ControlTemplate. Note that the IsItemsHost property is set to true on the StackPanel, indicating that the generated items should go in the panel. When you specify it this way, the ItemsPanel cannot be replaced by the user of the control without using a ControlTemplate. Therefore, only do this if you know you wouldn't want the panel to be replaced without the use of a template.

XAML
Copy 

<Style TargetType="ListBox">
  <Setter Property="Template">
    <Setter.Value>
      <ControlTemplate TargetType="ListBox">
        <Border CornerRadius="5" Background="{TemplateBinding ListBox.Background}">
          <ScrollViewer HorizontalScrollBarVisibility="Auto">
            <StackPanel Orientation="Horizontal"
                       VerticalAlignment="Center"
                       HorizontalAlignment="Center"
                       IsItemsHost="True"/>
          </ScrollViewer>
        </Border>
      </ControlTemplate>
    </Setter.Value>
  </Setter>
</Style>

Alternatively, you can do the following to achieve the same results. In this case, the ItemsPresenter creates the panel for the layout of the items based on what is specified by the ItemsPanelTemplate.

XAML
Copy 

<Style TargetType="{x:Type ListBox}">
  <Setter Property="ItemsPanel">
    <Setter.Value>
      <ItemsPanelTemplate>
        <StackPanel Orientation="Horizontal"
                     VerticalAlignment="Center"
                     HorizontalAlignment="Center"/>
      </ItemsPanelTemplate>
    </Setter.Value>
  </Setter>
  <Setter Property="Template">
    <Setter.Value>
      <ControlTemplate TargetType="{x:Type ListBox}">
        <Border CornerRadius="5"
                Background="{TemplateBinding ListBox.Background}">
          <ScrollViewer HorizontalScrollBarVisibility="Auto">
            <ItemsPresenter/>
          </ScrollViewer>
        </Border>
      </ControlTemplate>
    </Setter.Value>
  </Setter>
</Style>

For an example of how to use the different styling and templating properties on the ItemsControl, see Data Templating Overview.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
ItemsPanelTemplate as DynamicResource; very handy.

<Window x:Class="TestWin.Window1"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
<Window.Resources>
<XmlDataProvider x:Key="EntityContext" Source="Entities.xml" XPath="Entities/Contexts"/>
<DataTemplate x:Key="ct_TickersWrapDataTemplate">
<Border Background="{Binding XPath=Color}">
<StackPanel HorizontalAlignment="Center" VerticalAlignment="Center">
<TextBlock Text="{Binding XPath=Ticker}" Style="{DynamicResource ct_TickersWrapTickerTextBlock}"/>
<TextBlock Text="{Binding XPath=PriceChange}" Style="{DynamicResource ct_TickersWrapPriceTextBlock}"/>
</StackPanel>
</Border>
</DataTemplate>
<ItemsPanelTemplate x:Key="ct_TickersWrapItemsPanelTemplate">
<WrapPanel
IsItemsHost="True"
Width="{Binding Path=ActualWidth,RelativeSource={RelativeSource Mode=FindAncestor, AncestorType={x:Type ScrollContentPresenter}}}" />
</ItemsPanelTemplate>
<DataTemplate x:Key="ct_TickersListDataTemplate">
<Grid>
<Grid.ColumnDefinitions>
<ColumnDefinition Width="82"/>
<ColumnDefinition Width="5"/>
<ColumnDefinition Width="78"/>
<ColumnDefinition Width="5"/>
<ColumnDefinition Width="78"/>
<ColumnDefinition Width="20"/>
<ColumnDefinition Width="201"/>
<ColumnDefinition Width="20"/>
</Grid.ColumnDefinitions>
<Border Grid.Column="0" Background="{Binding XPath=Color}">
<TextBlock Text="{Binding XPath=Ticker}" Style="{DynamicResource ct_TickersListTickerTextBlock}"/>
</Border>
<TextBlock Grid.Column="2" Text="{Binding XPath=Price}" Style="{DynamicResource ct_TickersListPriceTextBlock}"/>
<TextBlock Grid.Column="4" Text="{Binding XPath=PriceChange}" Style="{DynamicResource ct_TickersListPriceTextBlock}"/>
<Image Grid.Column="6" Source="{Binding XPath=Chart}" Width="175" Height="30" HorizontalAlignment="Left"/>
</Grid>
</DataTemplate>

<ItemsPanelTemplate x:Key="ct_TickersListItemsPanelTemplate">
<StackPanel/>
</ItemsPanelTemplate>
</Window.Resources>
<StackPanel>
<!--List Version-->
<ListBox
ItemContainerStyle="{DynamicResource ct_TickersListBoxItem}"
ItemsPanel="{DynamicResource ct_TickersListItemsPanelTemplate}"
ItemsSource="{Binding Source={StaticResource EntityContext}, XPath=Context}"
ItemTemplate="{StaticResource ct_TickersListDataTemplate}"
Style="{DynamicResource ct_TickersListBox}"
ScrollViewer.HorizontalScrollBarVisibility="Disabled"
Visibility="Visible"/>

<!--WrapPanel Version-->
<ListBox
ItemContainerStyle="{DynamicResource ct_TickersWrapPanelItem}"
ItemsPanel="{DynamicResource ct_TickersWrapItemsPanelTemplate}"
ItemsSource="{Binding Source={StaticResource EntityContext}, XPath=Context}"
ItemTemplate="{StaticResource ct_TickersWrapDataTemplate}"
Style="{DynamicResource ct_TickersListBox}"
ScrollViewer.HorizontalScrollBarVisibility="Disabled"
Visibility="Collapsed"/>
</StackPanel>
</Window>
History