Export (0) Print
Expand All

ItemContainerGenerator Class

Generates the user interface (UI) on behalf of its host, such as an ItemsControl.

System::Object
  System.Windows.Controls::ItemContainerGenerator

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

public ref class ItemContainerGenerator sealed : IRecyclingItemContainerGenerator, 
	IItemContainerGenerator, IWeakEventListener

The ItemContainerGenerator type exposes the following members.

  NameDescription
Public propertyItemsGets the collection of items that belong to this ItemContainerGenerator.
Public propertyStatusThe generation status of the ItemContainerGenerator.
Top

  NameDescription
Public methodContainerFromIndexReturns the element corresponding to the item at the given index within the ItemCollection.
Public methodContainerFromItemReturns the UIElement corresponding to the given item.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGenerateBatchesReturns an object that manages the Status property.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexFromContainer(DependencyObject)Returns the index to an item that corresponds to the specified, generated UIElement.
Public methodIndexFromContainer(DependencyObject, Boolean)Returns the index to an item that corresponds to the specified, generated UIElement, optionally recursively searching hierarchical items.
Public methodItemFromContainerReturns the item that corresponds to the specified, generated UIElement.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventItemsChangedThe ItemsChanged event is raised by a ItemContainerGenerator to inform layouts that the items collection has changed.
Public eventStatusChangedThe StatusChanged event is raised by a ItemContainerGenerator to inform controls that its status has changed.
Top

  NameDescription
Explicit interface implemetationPrivate methodIItemContainerGenerator::GenerateNext()Returns the container element used to display the next item.
Explicit interface implemetationPrivate methodIItemContainerGenerator::GenerateNext(Boolean%)Returns the container element used to display the next item, and whether the container element has been newly generated (realized).
Explicit interface implemetationPrivate methodIItemContainerGenerator::GeneratorPositionFromIndexReturns the GeneratorPosition object that maps to the item at the specified index.
Explicit interface implemetationPrivate methodIItemContainerGenerator::GetItemContainerGeneratorForPanelReturns the ItemContainerGenerator appropriate for use by the specified panel.
Explicit interface implemetationPrivate methodIItemContainerGenerator::IndexFromGeneratorPositionReturns the index that maps to the specified GeneratorPosition.
Explicit interface implemetationPrivate methodIItemContainerGenerator::PrepareItemContainerPrepares the specified element as the container for the corresponding item.
Explicit interface implemetationPrivate methodIItemContainerGenerator::RemoveThis member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code.
Explicit interface implemetationPrivate methodIItemContainerGenerator::RemoveAllRemoves all generated (realized) items.
Explicit interface implemetationPrivate methodIItemContainerGenerator::StartAt(GeneratorPosition, GeneratorDirection)Prepares the generator to generate items, starting at the specified GeneratorPosition, and in the specified GeneratorDirection.
Explicit interface implemetationPrivate methodIItemContainerGenerator::StartAt(GeneratorPosition, GeneratorDirection, Boolean)Prepares the generator to generate items, starting at the specified GeneratorPosition, and in the specified GeneratorDirection, and controlling whether or not to start at a generated (realized) item.
Explicit interface implemetationPrivate methodIRecyclingItemContainerGenerator::RecycleThis member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code.
Explicit interface implemetationPrivate methodIWeakEventListener::ReceiveWeakEventThis member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code.
Top

ItemContainerGenerator implements IItemContainerGenerator, which is the interface that defines a type which:

  • Maintains an association between the data view of a multiple-item control, such as ContainerFromElement and the corresponding UIElement items.

  • Generates UIElement items on behalf of a multiple-item control.

Each ItemsControl type has a corresponding container type. Container elements are the objects that contain the data items in the item collection. For example, for ListBox, the generated containers are ListBoxItem controls; for ComboBox, they are ComboBoxItem controls.

The ItemsControl generates its items through the IItemContainerGenerator interface. The ItemContainerGenerator property of the ItemsControl is of type ItemContainerGenerator, which implements the IItemContainerGenerator interface. Therefore, you can access the ItemContainerGenerator object associated with your ItemsControl using the ItemContainerGenerator property. For example, if you have a data-bound TreeView, and you want to get a TreeViewItem based on its index or its associated data item, you can use the ItemContainerGenerator::ContainerFromIndex or the ItemContainerGenerator::ContainerFromItem method. Alternatively, you can use the ItemContainerGenerator::IndexFromContainer or the ItemContainerGenerator::ItemFromContainer method to get the index or data item associated with a given generated container element.

Apart from those usages, the IItemContainerGenerator interface is used in advanced scenarios. Typically, advanced applications that have their own implementation of a virtualizing panel call members of the interface.

If you need to get a specific ListBoxItem at a particular index in a ListBox, you can use an ItemContainerGenerator.

The following example shows a ListBox and its items.

<ListBox Margin="10,0,0,5" Name="lb" VerticalAlignment="Top" Grid.Column="0" Grid.Row="2">
    <ListBoxItem>Item 0</ListBoxItem>
    <ListBoxItem>Item 1</ListBoxItem>
    <ListBoxItem>Item 2</ListBoxItem>
    <ListBoxItem>Item 3</ListBoxItem>
</ListBox>

The following example shows how to retrieve the item by specifying the index of the item in the ContainerFromIndex property of the ItemContainerGenerator.

No code example is currently available or this language may not be supported.

After you have retrieved the list box item, you can display the contents of the item, as shown in the following example.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.3, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft