This topic has not yet been rated - Rate this topic

ItemsPanelTemplate Class

May 02, 2013

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

System.Object
  System.Windows.DependencyObject
    System.Windows.FrameworkTemplate
      System.Windows.Controls.ItemsPanelTemplate

Namespace: System.Windows.Controls
Assembly: System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.

Syntax

public sealed class ItemsPanelTemplate : FrameworkTemplate

XAML Object Element Usage

<ItemsPanelTemplate ...>
  templateRootElement
</ItemsPanelTemplate>

XAML Values

templateRootElement: A single object element that derives from FrameworkElement.

The ItemsPanelTemplate type exposes the following members.

Constructors

	Name	Description
	ItemsPanelTemplate	Initializes a new instance of the ItemsPanelTemplate class.

Top

Properties

	Name	Description
	Dispatcher	Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)

Top

Methods

	Name	Description
	CheckAccess	Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
	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.)
	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.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	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.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReadLocalValue	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
	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.)

Top

Remarks

The ItemsPanelTemplate specifies the panel that is used for the layout of items. The ItemsControl has an ItemsPanel property that is of type ItemsPanelTemplate.

Examples

The following example creates a ListBox that displays its items horizontally. The example sets the ItemsPanel to a ItemsPanelTemplate that has a StackPanel whose Orientation property is set to Horizontal.

XAML


<Grid>
  <Grid.Resources>
    <Style x:Key="horizontalListBoxStyle" TargetType="ListBox">
      <Setter Property="ItemsPanel">
        <Setter.Value>
          <ItemsPanelTemplate>
            <StackPanel Orientation="Horizontal"
              VerticalAlignment="Center"
              HorizontalAlignment="Center"/>
          </ItemsPanelTemplate>
        </Setter.Value>
      </Setter>
    </Style>

    <src:Items x:Key="items"/>
  </Grid.Resources>

  <ListBox ItemsSource="{StaticResource items}" 
           Style="{StaticResource horizontalListBoxStyle}"/>

</Grid>

The following example shows the collection of strings to which the ListBox is bound.


public class Items : 
    System.Collections.ObjectModel.ObservableCollection<string>
{
    public Items()
    {
        Add("Item 1");
        Add("Item 2");
        Add("Item 3");
        Add("Item 4");
        Add("Item 5");
    }
}

The preceding example produces output that is similar to the following illustration.

ListBox with items arranged horizontally