Skip to main content
ItemsPanelTemplate Class
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

Namespace:   System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)

SystemObject
   System.Windows.ThreadingDispatcherObject
     System.WindowsFrameworkTemplate
      System.Windows.ControlsItemsPanelTemplate

public class ItemsPanelTemplate : FrameworkTemplate
public ref class ItemsPanelTemplate : FrameworkTemplate
type ItemsPanelTemplate = 
    class
        inherit FrameworkTemplate
    end
Public Class ItemsPanelTemplate
	Inherits FrameworkTemplate
NameDescription
System_CAPS_pubmethod ItemsPanelTemplate

Initializes an instance of the ItemsPanelTemplate class.

System_CAPS_pubmethod ItemsPanelTemplate

Initializes an instance of the ItemsPanelTemplate class with the specified template.

NameDescription
System_CAPS_pubproperty

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_pubproperty

Gets a value that indicates whether this template has optimized content.(Inherited from FrameworkTemplate.)

System_CAPS_pubproperty

Gets a value that indicates whether this object is in an immutable state so it cannot be changed.(Inherited from FrameworkTemplate.)

System_CAPS_pubproperty

Gets or sets the collection of resources that can be used within the scope of this template.(Inherited from FrameworkTemplate.)

System_CAPS_pubproperty

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.)

System_CAPS_pubproperty

Gets or sets the root node of the template.(Inherited from FrameworkTemplate.)

NameDescription
System_CAPS_pubmethod CheckAccess

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_pubmethod Equals

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethod Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethod FindName

Finds the element associated with the specified name defined within this template.(Inherited from FrameworkTemplate.)

System_CAPS_pubmethod GetHashCode

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod LoadContent

Loads the content of the template as an instance of an object and returns the root element of the content.(Inherited from FrameworkTemplate.)

System_CAPS_protmethod MemberwiseClone

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethod RegisterName

Registers a new name/object pair into the current name scope.(Inherited from FrameworkTemplate.)

System_CAPS_pubmethod Seal

Locks the template so it cannot be changed.(Inherited from FrameworkTemplate.)

System_CAPS_pubmethod ShouldSerializeResources

Returns a value that indicates whether serialization processes should serialize the value of the property on instances of this class.(Inherited from FrameworkTemplate.)

System_CAPS_pubmethod ShouldSerializeVisualTree

Returns a value that indicates whether serialization processes should serialize the value of the property on instances of this class.(Inherited from FrameworkTemplate.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethod UnregisterName

Removes a name/object mapping from the XAML namescope.(Inherited from FrameworkTemplate.)

System_CAPS_protmethod ValidateTemplatedParent

Checks that the templated parent is a non-null ItemsPresenter object.(Overrides FrameworkTemplateValidateTemplatedParent.)

System_CAPS_pubmethod VerifyAccess

Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

NameDescription
System_CAPS_pubinterface System_CAPS_privmethod INameScopeFindName

This API supports the product infrastructure and is not intended to be used directly from your code. Returns an object that has the provided identifying name. (Inherited from FrameworkTemplate.)

System_CAPS_pubinterface System_CAPS_privmethod IQueryAmbientIsAmbientPropertyAvailable

Queries whether a specified ambient property is available in the current scope.(Inherited from FrameworkTemplate.)

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

Each ItemsControl type has a default ItemsPanelTemplate. For the ItemsControl class, the default 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 property. The following example shows a ListBox  Style that creates a horizontal ListBox.

<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 property as in previous example, the horizontal StackPanel is specified within the ControlTemplate. Note that the 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 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.


  

  

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.


  

  

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

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top