ISelectionItemProvider interface

ISelectionItemProvider interface

Exposes methods and properties to support access by a Microsoft UI Automation client to individual, selectable child controls of containers that implement ISelectionProvider. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.SelectionItem.

Syntax


public interface ISelectionItemProvider

Members

The ISelectionItemProvider interface has these types of members:

Methods

The ISelectionItemProvider interface has these methods. It also inherits methods from the Object class.

MethodDescription
AddToSelection Adds the current element to the collection of selected items.
RemoveFromSelection Removes the current element from the collection of selected items.
Select Clears any existing selection and then selects the current element.

 

Properties

The ISelectionItemProvider interface has these properties.

PropertyAccess typeDescription

IsSelected

Read-only

Gets a value that indicates whether an item is selected.

SelectionContainer

Read-only

Gets the UI Automation provider that implements ISelectionProvider and acts as the container for the calling object.

 

Remarks

This pattern has guidelines and conventions that aren't fully documented here. For more info on what this pattern is for, see SelectionItem Control Pattern. However, you don't need to follow the guidance regarding IRawElementProviderFragmentRoot, that is specific to COM provider implementations and the interface doesn't exist in the Windows Runtime automation provider API.

ISelectionItemProvider is implemented by these existing Windows Runtime classes:

Use SelectionItemPatternIdentifiers if you want to reference the ISelectionItemProvider pattern properties from control code when you fire automation events or call RaisePropertyChangedEvent.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.UI.Xaml.Automation.Provider
Windows::UI::Xaml::Automation::Provider [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Automation.Provider
Windows::UI::Xaml::Automation::Provider [C++]

Metadata

Windows.winmd

Attributes

[Version(0x06020000)]
[WebHostHidden()]

See also

SelectionItemPatternIdentifiers
ISelectionItemProvider (COM interface)
Custom automation peers
SelectionItem Control Pattern

 

 

Show:
© 2016 Microsoft