AppBarAutomationPeer
AppBarAutomationPeer
AppBarAutomationPeer
AppBarAutomationPeer
Class
Definition
public : class AppBarAutomationPeer : FrameworkElementAutomationPeer, IAppBarAutomationPeer, IExpandCollapseProvider, IToggleProvider, IWindowProviderpublic class AppBarAutomationPeer : FrameworkElementAutomationPeer, IAppBarAutomationPeer, IExpandCollapseProvider, IToggleProvider, IWindowProviderPublic Class AppBarAutomationPeer Inherits FrameworkElementAutomationPeer Implements IAppBarAutomationPeer, IExpandCollapseProvider, IToggleProvider, IWindowProvider// This API is not available in Javascript.
- Inheritance
-
FrameworkElementAutomationPeerFrameworkElementAutomationPeerFrameworkElementAutomationPeerFrameworkElementAutomationPeerAppBarAutomationPeerAppBarAutomationPeerAppBarAutomationPeerAppBarAutomationPeer
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Inherited Members
Inherited methods
Inherited properties
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 Microsoft UI Automation client.
- GetPattern reports that the peer provides pattern support for PatternInterface.Toggle (IToggleProvider ).
- ****: GetPattern also reports pattern support for PatternInterface.ExpandCollapse (IExpandCollapseProvider ).
- GetClassName returns "ApplicationBar".
- GetAutomationControlType returns AutomationControlType.AppBar.
Note
Windows 8: returns AutomationControlType.Custom
- The peer can fire the PropertyChanged automation event when ToggleState of the peer and owner control changes. 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.
Constructors
AppBarAutomationPeer(AppBar) AppBarAutomationPeer(AppBar) AppBarAutomationPeer(AppBar) AppBarAutomationPeer(AppBar)
Initializes a new instance of the AppBarAutomationPeer class.
public : AppBarAutomationPeer(AppBar owner)public AppBarAutomationPeer(AppBar owner)Public Sub New(owner As AppBar)// This API is not available in Javascript.
Properties
ExpandCollapseState ExpandCollapseState ExpandCollapseState ExpandCollapseState
Gets the state, expanded or collapsed, of the control.
public : ExpandCollapseState ExpandCollapseState { get; }public ExpandCollapseState ExpandCollapseState { get; }Public ReadOnly Property ExpandCollapseState As ExpandCollapseState// This API is not available in Javascript.
A value of the enumeration.
InteractionState InteractionState InteractionState InteractionState
Gets the interaction state of the app bar, such as running, closing, and so on.
public : WindowInteractionState InteractionState { get; }public WindowInteractionState InteractionState { get; }Public ReadOnly Property InteractionState As WindowInteractionState// This API is not available in Javascript.
The interaction state of the app bar.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
IsModal IsModal IsModal IsModal
Gets a Boolean value indicating if the app bar is modal.
public : PlatForm::Boolean IsModal { get; }public bool IsModal { get; }Public ReadOnly Property IsModal As bool// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
true if the app bar is modal; otherwise, false.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
IsTopmost IsTopmost IsTopmost IsTopmost
Gets a Boolean value indicating if the app bar is the topmost element in the z-order of layout.
public : PlatForm::Boolean IsTopmost { get; }public bool IsTopmost { get; }Public ReadOnly Property IsTopmost As bool// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
true if the app bar is topmost; otherwise, false.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Maximizable Maximizable Maximizable Maximizable
Gets a Boolean value that indicates whether the app bar can be maximized.
public : PlatForm::Boolean Maximizable { get; }public bool Maximizable { get; }Public ReadOnly Property Maximizable As bool// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
true if the app bar can be maximized; otherwise, false.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Minimizable Minimizable Minimizable Minimizable
Gets a Boolean value that indicates whether the app bar can be minimized.
public : PlatForm::Boolean Minimizable { get; }public bool Minimizable { get; }Public ReadOnly Property Minimizable As bool// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
true if the app bar can be minimized; otherwise, false.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
ToggleState ToggleState ToggleState ToggleState
Retrieves the toggle state of the owner AppBar.
public : ToggleState ToggleState { get; }public ToggleState ToggleState { get; }Public ReadOnly Property ToggleState As ToggleState// This API is not available in Javascript.
The ToggleState of the owner control.
Remarks
An automation element must cycle through its toggle state in this order: On, Off and, if supported, Indeterminate.
VisualState VisualState VisualState VisualState
Gets the visual state of the app bar.
public : WindowVisualState VisualState { get; }public WindowVisualState VisualState { get; }Public ReadOnly Property VisualState As WindowVisualState// This API is not available in Javascript.
The visual state of the app bar, as a value of the enumeration.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Methods
Close() Close() Close() Close()
Closes the app bar.
public : void Close()public void Close()Public Function Close() As void// This API is not available in Javascript.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Collapse() Collapse() Collapse() Collapse()
Hides all nodes, controls, or content that are descendants of the control.
public : void Collapse()public void Collapse()Public Function Collapse() As void// This API is not available in Javascript.
Expand() Expand() Expand() Expand()
Displays all child nodes, controls, or content of the control.
public : void Expand()public void Expand()Public Function Expand() As void// This API is not available in Javascript.
SetVisualState(WindowVisualState) SetVisualState(WindowVisualState) SetVisualState(WindowVisualState) SetVisualState(WindowVisualState)
Changes the visual state of the app bar (such as minimizing or maximizing it).
public : void SetVisualState(WindowVisualState state)public void SetVisualState(WindowVisualState state)Public Function SetVisualState(state As WindowVisualState) As void// This API is not available in Javascript.
The visual state of the app bar to change to, as a value of the enumeration.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Toggle() Toggle() Toggle() Toggle()
Cycles through the toggle states of an AppBarAutomationPeer.
public : void Toggle()public void Toggle()Public Function Toggle() As void// This API is not available in Javascript.
WaitForInputIdle(Int32) WaitForInputIdle(Int32) WaitForInputIdle(Int32) WaitForInputIdle(Int32)
Blocks the calling code for the specified time or until the associated process enters an idle state, whichever completes first.
public : PlatForm::Boolean WaitForInputIdle(int milliseconds)public bool WaitForInputIdle(Int32 milliseconds)Public Function WaitForInputIdle(milliseconds As Int32) As bool// This API is not available in Javascript.
- milliseconds
- int Int32 Int32 Int32
The amount of time, in milliseconds, to wait for the associated process to become idle.
true if the app bar has entered the idle state; false if the timeout occurred.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|