I​Item​Container​Provider I​Item​Container​Provider I​Item​Container​Provider Interface

Definition

Exposes a Microsoft UI Automation method to enable applications to find an element in a container, such as a virtualized list. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.ItemContainer.

public : interface IItemContainerProviderpublic interface IItemContainerProviderPublic Interface IItemContainerProvider
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Controls that contain a large number of child items can use virtualization to efficiently manage the items. With virtualization, the control maintains full information in memory for only a subset of items at any given time. Typically, the subset includes only those items that are currently visible to the user. Full information about the remaining virtualized items is kept in storage and is loaded into memory, or realized, as the control needs it, for example, as new items become visible to the user. A related pattern is IVirtualizedItemProvider. For more info on what this pattern is for, see ItemContainer Control Pattern.

IItemContainerProvider is implemented by the existing Windows Runtime automation peers for various list controls or views, controls that share the base class ItemsControl. Each of these peers inherits from ItemsControlAutomationPeer, and ItemsControlAutomationPeer provides the common FindItemByProperty implementation.

The IItemContainerProvider pattern doesn't have a pattern property identifier class, the only API to implement is FindItemByProperty, a method.

Methods

FindItemByProperty(IRawElementProviderSimple, AutomationProperty, Object) FindItemByProperty(IRawElementProviderSimple, AutomationProperty, Object) FindItemByProperty(IRawElementProviderSimple, AutomationProperty, Object)

Retrieves an element by the specified property value.

public : IRawElementProviderSimple FindItemByProperty(IRawElementProviderSimple startAfter, AutomationProperty automationProperty, PlatForm::Object value)public IRawElementProviderSimple FindItemByProperty(IRawElementProviderSimple startAfter, AutomationProperty automationProperty, Object value)Public Function FindItemByProperty(startAfter As IRawElementProviderSimple, automationProperty As AutomationProperty, value As Object) As IRawElementProviderSimple
Parameters
startAfter
IRawElementProviderSimple IRawElementProviderSimple IRawElementProviderSimple

The item in the container after which to begin the search.

automationProperty
AutomationProperty AutomationProperty AutomationProperty

The property that contains the value to retrieve.

value
PlatForm::Object Object Object

The value to retrieve.

Returns

The first item that matches the search criterion; otherwise, null.

Attributes

See Also