Package at.bestsolution.uia

Interface IMultipleViewProvider

All Superinterfaces:
IInitable
public interface IMultipleViewProvider extends IInitable
Provides access to controls that provide, and are able to switch between, multiple representations of the same set of information or child controls.

Implemented on a Microsoft UI Automation provider that must support the MultipleView control pattern.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    IMultipleViewProvider.MultipleViewProviderContext
    context object for IMultipleViewProvider.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    get_CurrentView()
    Identifies the current view that the control is using to display information or child controls.
    int[]
    GetSupportedViews()
    Retrieves a collection of control-specific view identifiers.
    String
    GetViewName(int viewId)
    Retrieves the name of a control-specific view.
    void
    SetCurrentView(int viewId)
    Sets the current control-specific view.

    Methods inherited from interface at.bestsolution.uia.IInitable

    initialize

  • Method Details

    • get_CurrentView

      int get_CurrentView()
      Identifies the current view that the control is using to display information or child controls.

      The collection of view identifiers must be identical for all instances of a control.

      Returns:
      the current view identifier

    • GetSupportedViews

      int[] GetSupportedViews()
      Retrieves a collection of control-specific view identifiers.

      An empty array is returned by UIAutoCore.dll if the provider does not supply any view identifiers. The collection of view identifiers must be identical for all instances of a control. View identifier values can be passed to IMultipleViewProvider::GetViewName.

      Returns:
      Receives a collection of control-specific integer values that identify the views available for a UI Automation element.

    • GetViewName

      String GetViewName(int viewId)
      Retrieves the name of a control-specific view.

      View identifiers can be retrieved by using IMultipleViewProvider::GetSupportedViews. The collection of view identifiers must be identical for all instances of a control. View names must be suitable for use in text-to-speech, Braille, and other accessible applications.

      Parameters:
      viewId - A view identifier.
      Returns:
      Receives a localized name for the view. This parameter is passed uninitialized.

    • SetCurrentView

      void SetCurrentView(int viewId)
      Sets the current control-specific view.

      View identifiers can be retrieved by using IMultipleViewProvider::GetSupportedViews. The collection of view identifiers must be identical for all instances of a control.

      Parameters:
      viewId - A view identifier.