AppBarAutomationPeer class
TOC
Collapse the table of content
Expand the table of content

AppBarAutomationPeer class

Exposes AppBar types to Microsoft UI Automation.

Inheritance

Object
  DependencyObject
    AutomationPeer
      FrameworkElementAutomationPeer
        AppBarAutomationPeer

Syntax


public ref class AppBarAutomationPeer : FrameworkElementAutomationPeer,
    IExpandCollapseProvider,
    IToggleProvider

Members

The AppBarAutomationPeer class has these types of members:

Constructors

The AppBarAutomationPeer class has these constructors.

ConstructorDescription
AppBarAutomationPeer Initializes a new instance of the AppBarAutomationPeer class.

 

Methods

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

MethodDescription
Close Closes the app bar.
Collapse Hides all nodes, controls, or content that are descendants of the control.
Expand Displays all child nodes, controls, or content of the control.
SetVisualState Changes the visual state of the app bar (such as minimizing or maximizing it).
Toggle Cycles through the toggle states of an AppBarAutomationPeer.
WaitForInputIdle Blocks the calling code for the specified time or until the associated process enters an idle state, whichever completes first.

 

Properties

The AppBarAutomationPeer class has these properties.

PropertyAccess typeDescription

ExpandCollapseState

Read-only

Gets the state, expanded or collapsed, of the control.

InteractionState

Read-only

Gets the interaction state of the app bar, such as running, closing, and so on.

IsModal

Read-only

Gets a Boolean value indicating if the app bar is modal.

IsTopmost

Read-only

Gets a Boolean value indicating if the app bar is the topmost element in the z-order of layout.

Maximizable

Read-only

Gets a Boolean value that indicates whether the app bar can be maximized.

Minimizable

Read-only

Gets a Boolean value that indicates whether the app bar can be minimized.

ToggleState

Read-only

Retrieves the toggle state of the owner AppBar.

VisualState

Read-only

Gets the visual state of the app bar.

 

Remarks

The Windows Runtime AppBar class creates a new AppBarAutomationPeer as its OnCreateAutomationPeer definition. Derive your automation peer from AppBarAutomationPeer if you are deriving a custom class from AppBar and want to add automation support for additional features that you enabled in your custom class. Then override OnCreateAutomationPeer so that it returns your custom peer.

Default peer implementation and overrides in AppBarAutomationPeer

AppBarAutomationPeer has overrides of Core methods such that the associated AutomationPeer methods provide peer-specific information to a UI Automation client.

The peer also has other behaviors that are provided by the base FrameworkElementAutomationPeer class. For more info, see "Base implementation in FrameworkElementAutomationPeer" section of Custom automation peers.

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.Peers
Windows::UI::Xaml::Automation::Peers [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

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

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

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

Metadata

Windows.winmd

Attributes

[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06020000)]
[WebHostHidden()]

See also

Object
IExpandCollapseProvider
FrameworkElementAutomationPeer
AppBar
IToggleProvider
Custom automation peers
IToggleProvider

 

 

Show:
© 2016 Microsoft