ISelectionProvider interface

Applies to Windows and Windows Phone

Exposes methods and properties to support access by a Microsoft UI Automation client to controls that act as containers for a collection of individual, selectable child items. The children of this element must implement ISelectionItemProvider. Implement ISelectionProvider in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.SelectionItem.

Syntax


public interface ISelectionProvider

Attributes

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

Members

The ISelectionProvider interface has these types of members:

Methods

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

MethodDescription
GetSelection Retrieves a UI Automation provider for each child element that is selected.

 

Properties

The ISelectionProvider interface has these properties.

PropertyAccess typeDescription

CanSelectMultiple

Read-onlyGets a value that indicates whether the Microsoft UI Automation provider allows more than one child element to be selected concurrently.

IsSelectionRequired

Read-onlyGets a value that indicates whether the UI Automation provider requires at least one child element to be selected.

 

Remarks

This pattern has guidelines and conventions that aren't fully documented here. For more info on what this pattern is for, see Selection 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.

ISelectionProvider is implemented by the existing Windows Runtime class SelectorAutomationPeer, which is the base class for ComboBoxAutomationPeer and ListBoxAutomationPeer.

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

Requirements

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

See also

SelectionPatternIdentifiers
Selector
ISelectionProvider (COM interface)
Custom automation peers
Selection Control Pattern

 

 

Show:
© 2014 Microsoft