Package at.bestsolution.uia

Interface ISelectionProvider

All Superinterfaces:
IInitable
All Known Subinterfaces:
ISelectionProvider2
public interface ISelectionProvider extends IInitable
Provides access to controls that act as containers for a collection of individual, selectable child items. The children of this control must implement ISelectionItemProvider.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    ISelectionProvider.SelectionProviderContext
    context object for ISelectionProvider.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    get_CanSelectMultiple()
    Indicates whether the Microsoft UI Automation provider allows more than one child element to be selected concurrently.
    boolean
    get_IsSelectionRequired()
    Indicates whether the Microsoft UI Automation provider requires at least one child element to be selected.
    IUIAElement[]
    GetSelection()
    Retrieves a Microsoft UI Automation provider for each child element that is selected.

    Methods inherited from interface at.bestsolution.uia.IInitable

    initialize

  • Method Details

    • get_CanSelectMultiple

      boolean get_CanSelectMultiple()
      Indicates whether the Microsoft UI Automation provider allows more than one child element to be selected concurrently.

      This property may be dynamic. For example, in rare cases a control might allow multiple items to be selected on initialization but subsequently allow only single selections to be made.

      Returns:
      true if multiple items can be selected

    • get_IsSelectionRequired

      boolean get_IsSelectionRequired()
      Indicates whether the Microsoft UI Automation provider requires at least one child element to be selected.

      This property can be dynamic. For example, the initial state of a control might not have any items selected by default, meaning that ISelectionProvider::IsSelectionRequired is FALSE. However, after an item is selected the control must always have at least one item selected.

      Returns:
      true if selection is required

    • GetSelection

      IUIAElement[] GetSelection()
      Retrieves a Microsoft UI Automation provider for each child element that is selected.
      Returns:
      the selected elements