ISelectionItemProvider ISelectionItemProvider ISelectionItemProvider ISelectionItemProvider Interface

Definition

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.

public : interface ISelectionItemProviderpublic interface ISelectionItemProviderPublic Interface ISelectionItemProvider// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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.

Properties

IsSelected IsSelected IsSelected IsSelected

Gets a value that indicates whether an item is selected.

public : PlatForm::Boolean IsSelected { get; }public bool IsSelected { get; }Public ReadOnly Property IsSelected As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

true if the element is selected; otherwise, false.

SelectionContainer SelectionContainer SelectionContainer SelectionContainer

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

public : IRawElementProviderSimple SelectionContainer { get; }public IRawElementProviderSimple SelectionContainer { get; }Public ReadOnly Property SelectionContainer As IRawElementProviderSimple// This API is not available in Javascript.

Methods

AddToSelection() AddToSelection() AddToSelection() AddToSelection()

Adds the current element to the collection of selected items.

public : void AddToSelection()public void AddToSelection()Public Function AddToSelection() As void// This API is not available in Javascript.

RemoveFromSelection() RemoveFromSelection() RemoveFromSelection() RemoveFromSelection()

Removes the current element from the collection of selected items.

public : void RemoveFromSelection()public void RemoveFromSelection()Public Function RemoveFromSelection() As void// This API is not available in Javascript.

Select() Select() Select() Select()

Clears any existing selection and then selects the current element.

public : void Select()public void Select()Public Function Select() As void// This API is not available in Javascript.

See Also