AppBarAutomationPeer AppBarAutomationPeer AppBarAutomationPeer AppBarAutomationPeer Class

Definition

Exposes AppBar types to Microsoft UI Automation.

public : class AppBarAutomationPeer : FrameworkElementAutomationPeer, IAppBarAutomationPeer, IExpandCollapseProvider, IToggleProvider, IWindowProvider
public class AppBarAutomationPeer : FrameworkElementAutomationPeer, IAppBarAutomationPeer, IExpandCollapseProvider, IToggleProvider, IWindowProvider
Public Class AppBarAutomationPeer Inherits FrameworkElementAutomationPeer Implements IAppBarAutomationPeer, IExpandCollapseProvider, IToggleProvider, IWindowProvider
var appBarAutomationPeer = new appBarAutomationPeer(owner);
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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.

Note

Windows 8: returns AutomationControlType.Custom

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)
var appBarAutomationPeer = new appBarAutomationPeer(owner);
Parameters
owner
AppBar AppBar AppBar AppBar

The AppBar control instance to create the peer for.

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
var expandCollapseState = appBarAutomationPeer.expandCollapseState;

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
var windowInteractionState = appBarAutomationPeer.interactionState;
Additional features and requirements
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
var bool = appBarAutomationPeer.isModal;
Value
Platform::Boolean bool bool bool

true if the app bar is modal; otherwise, false.

Additional features and requirements
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
var bool = appBarAutomationPeer.isTopmost;
Value
Platform::Boolean bool bool bool

true if the app bar is topmost; otherwise, false.

Additional features and requirements
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
var bool = appBarAutomationPeer.maximizable;
Value
Platform::Boolean bool bool bool

true if the app bar can be maximized; otherwise, false.

Additional features and requirements
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
var bool = appBarAutomationPeer.minimizable;
Value
Platform::Boolean bool bool bool

true if the app bar can be minimized; otherwise, false.

Additional features and requirements
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
var toggleState = appBarAutomationPeer.toggleState;
Value
ToggleState ToggleState ToggleState ToggleState

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
var windowVisualState = appBarAutomationPeer.visualState;
Value
WindowVisualState WindowVisualState WindowVisualState WindowVisualState

The visual state of the app bar, as a value of the enumeration.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Dispatcher Dispatcher Dispatcher Dispatcher

Inherited from DependencyObject

EventsSource EventsSource EventsSource EventsSource

Inherited from AutomationPeer

Owner Owner Owner Owner

Methods

Close() Close() Close() Close()

Closes the app bar.

public : void Close()
public void Close()
Public Function Close() As void
appBarAutomationPeer.close();
Additional features and requirements
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
appBarAutomationPeer.collapse();

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
appBarAutomationPeer.expand();

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
appBarAutomationPeer.setVisualState(state);
Parameters
state
WindowVisualState WindowVisualState WindowVisualState WindowVisualState

The visual state of the app bar to change to, as a value of the enumeration.

Additional features and requirements
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
appBarAutomationPeer.toggle();

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
var bool = appBarAutomationPeer.waitForInputIdle(milliseconds);
Parameters
milliseconds
int Int32 Int32 Int32

The amount of time, in milliseconds, to wait for the associated process to become idle.

Returns
Platform::Boolean bool bool bool

true if the app bar has entered the idle state; false if the timeout occurred.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Inherited from DependencyObject

CreatePeerForElement(UIElement) CreatePeerForElement(UIElement) CreatePeerForElement(UIElement) CreatePeerForElement(UIElement)

FromElement(UIElement) FromElement(UIElement) FromElement(UIElement) FromElement(UIElement)

GenerateRawElementProviderRuntimeId GenerateRawElementProviderRuntimeId GenerateRawElementProviderRuntimeId GenerateRawElementProviderRuntimeId

Inherited from AutomationPeer

GetAcceleratorKey GetAcceleratorKey GetAcceleratorKey GetAcceleratorKey

Inherited from AutomationPeer

GetAcceleratorKeyCore GetAcceleratorKeyCore GetAcceleratorKeyCore GetAcceleratorKeyCore

Inherited from AutomationPeer

GetAccessKey GetAccessKey GetAccessKey GetAccessKey

Inherited from AutomationPeer

GetAccessKeyCore GetAccessKeyCore GetAccessKeyCore GetAccessKeyCore

Inherited from AutomationPeer

GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

Inherited from DependencyObject

GetAnnotations GetAnnotations GetAnnotations GetAnnotations

Inherited from AutomationPeer

GetAnnotationsCore GetAnnotationsCore GetAnnotationsCore GetAnnotationsCore

Inherited from AutomationPeer

GetAutomationControlType GetAutomationControlType GetAutomationControlType GetAutomationControlType

Inherited from AutomationPeer

GetAutomationControlTypeCore GetAutomationControlTypeCore GetAutomationControlTypeCore GetAutomationControlTypeCore

Inherited from AutomationPeer

GetAutomationId GetAutomationId GetAutomationId GetAutomationId

Inherited from AutomationPeer

GetAutomationIdCore GetAutomationIdCore GetAutomationIdCore GetAutomationIdCore

Inherited from AutomationPeer

GetBoundingRectangle GetBoundingRectangle GetBoundingRectangle GetBoundingRectangle

Inherited from AutomationPeer

GetBoundingRectangleCore GetBoundingRectangleCore GetBoundingRectangleCore GetBoundingRectangleCore

Inherited from AutomationPeer

GetChildren GetChildren GetChildren GetChildren

Inherited from AutomationPeer

GetChildrenCore GetChildrenCore GetChildrenCore GetChildrenCore

Inherited from AutomationPeer

GetClassName GetClassName GetClassName GetClassName

Inherited from AutomationPeer

GetClassNameCore GetClassNameCore GetClassNameCore GetClassNameCore

Inherited from AutomationPeer

GetClickablePoint GetClickablePoint GetClickablePoint GetClickablePoint

Inherited from AutomationPeer

GetClickablePointCore GetClickablePointCore GetClickablePointCore GetClickablePointCore

Inherited from AutomationPeer

GetControlledPeers GetControlledPeers GetControlledPeers GetControlledPeers

Inherited from AutomationPeer

GetControlledPeersCore GetControlledPeersCore GetControlledPeersCore GetControlledPeersCore

Inherited from AutomationPeer

GetCulture GetCulture GetCulture GetCulture

Inherited from AutomationPeer

GetCultureCore GetCultureCore GetCultureCore GetCultureCore

Inherited from AutomationPeer

GetDescribedByCore GetDescribedByCore GetDescribedByCore GetDescribedByCore

Inherited from AutomationPeer

GetElementFromPoint(Point) GetElementFromPoint(Point) GetElementFromPoint(Point) GetElementFromPoint(Point)

Inherited from AutomationPeer

GetElementFromPointCore(Point) GetElementFromPointCore(Point) GetElementFromPointCore(Point) GetElementFromPointCore(Point)

Inherited from AutomationPeer

GetFlowsFromCore GetFlowsFromCore GetFlowsFromCore GetFlowsFromCore

Inherited from AutomationPeer

GetFlowsToCore GetFlowsToCore GetFlowsToCore GetFlowsToCore

Inherited from AutomationPeer

GetFocusedElement GetFocusedElement GetFocusedElement GetFocusedElement

Inherited from AutomationPeer

GetFocusedElementCore GetFocusedElementCore GetFocusedElementCore GetFocusedElementCore

Inherited from AutomationPeer

GetFullDescription GetFullDescription GetFullDescription GetFullDescription

Inherited from AutomationPeer

GetFullDescriptionCore GetFullDescriptionCore GetFullDescriptionCore GetFullDescriptionCore

Inherited from AutomationPeer

GetHelpText GetHelpText GetHelpText GetHelpText

Inherited from AutomationPeer

GetHelpTextCore GetHelpTextCore GetHelpTextCore GetHelpTextCore

Inherited from AutomationPeer

GetItemStatus GetItemStatus GetItemStatus GetItemStatus

Inherited from AutomationPeer

GetItemStatusCore GetItemStatusCore GetItemStatusCore GetItemStatusCore

Inherited from AutomationPeer

GetItemType GetItemType GetItemType GetItemType

Inherited from AutomationPeer

GetItemTypeCore GetItemTypeCore GetItemTypeCore GetItemTypeCore

Inherited from AutomationPeer

GetLabeledBy GetLabeledBy GetLabeledBy GetLabeledBy

Inherited from AutomationPeer

GetLabeledByCore GetLabeledByCore GetLabeledByCore GetLabeledByCore

Inherited from AutomationPeer

GetLandmarkType GetLandmarkType GetLandmarkType GetLandmarkType

Inherited from AutomationPeer

GetLandmarkTypeCore GetLandmarkTypeCore GetLandmarkTypeCore GetLandmarkTypeCore

Inherited from AutomationPeer

GetLevel GetLevel GetLevel GetLevel

Inherited from AutomationPeer

GetLevelCore GetLevelCore GetLevelCore GetLevelCore

Inherited from AutomationPeer

GetLiveSetting GetLiveSetting GetLiveSetting GetLiveSetting

Inherited from AutomationPeer

GetLiveSettingCore GetLiveSettingCore GetLiveSettingCore GetLiveSettingCore

Inherited from AutomationPeer

GetLocalizedControlType GetLocalizedControlType GetLocalizedControlType GetLocalizedControlType

Inherited from AutomationPeer

GetLocalizedControlTypeCore GetLocalizedControlTypeCore GetLocalizedControlTypeCore GetLocalizedControlTypeCore

Inherited from AutomationPeer

GetLocalizedLandmarkType GetLocalizedLandmarkType GetLocalizedLandmarkType GetLocalizedLandmarkType

Inherited from AutomationPeer

GetLocalizedLandmarkTypeCore GetLocalizedLandmarkTypeCore GetLocalizedLandmarkTypeCore GetLocalizedLandmarkTypeCore

Inherited from AutomationPeer

GetName GetName GetName GetName

Inherited from AutomationPeer

GetNameCore GetNameCore GetNameCore GetNameCore

Inherited from AutomationPeer

GetOrientation GetOrientation GetOrientation GetOrientation

Inherited from AutomationPeer

GetOrientationCore GetOrientationCore GetOrientationCore GetOrientationCore

Inherited from AutomationPeer

GetParent GetParent GetParent GetParent

Inherited from AutomationPeer

GetPattern(PatternInterface) GetPattern(PatternInterface) GetPattern(PatternInterface) GetPattern(PatternInterface)

Inherited from AutomationPeer

GetPatternCore(PatternInterface) GetPatternCore(PatternInterface) GetPatternCore(PatternInterface) GetPatternCore(PatternInterface)

Inherited from AutomationPeer

GetPeerFromPoint(Point) GetPeerFromPoint(Point) GetPeerFromPoint(Point) GetPeerFromPoint(Point)

Inherited from AutomationPeer

GetPeerFromPointCore(Point) GetPeerFromPointCore(Point) GetPeerFromPointCore(Point) GetPeerFromPointCore(Point)

Inherited from AutomationPeer

GetPositionInSet GetPositionInSet GetPositionInSet GetPositionInSet

Inherited from AutomationPeer

GetPositionInSetCore GetPositionInSetCore GetPositionInSetCore GetPositionInSetCore

Inherited from AutomationPeer

GetSizeOfSet GetSizeOfSet GetSizeOfSet GetSizeOfSet

Inherited from AutomationPeer

GetSizeOfSetCore GetSizeOfSetCore GetSizeOfSetCore GetSizeOfSetCore

Inherited from AutomationPeer

GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Inherited from DependencyObject

HasKeyboardFocus HasKeyboardFocus HasKeyboardFocus HasKeyboardFocus

Inherited from AutomationPeer

HasKeyboardFocusCore HasKeyboardFocusCore HasKeyboardFocusCore HasKeyboardFocusCore

Inherited from AutomationPeer

InvalidatePeer InvalidatePeer InvalidatePeer InvalidatePeer

Inherited from AutomationPeer

IsContentElement IsContentElement IsContentElement IsContentElement

Inherited from AutomationPeer

IsContentElementCore IsContentElementCore IsContentElementCore IsContentElementCore

Inherited from AutomationPeer

IsControlElement IsControlElement IsControlElement IsControlElement

Inherited from AutomationPeer

IsControlElementCore IsControlElementCore IsControlElementCore IsControlElementCore

Inherited from AutomationPeer

IsDataValidForForm IsDataValidForForm IsDataValidForForm IsDataValidForForm

Inherited from AutomationPeer

IsDataValidForFormCore IsDataValidForFormCore IsDataValidForFormCore IsDataValidForFormCore

Inherited from AutomationPeer

IsEnabled IsEnabled IsEnabled IsEnabled

Inherited from AutomationPeer

IsEnabledCore IsEnabledCore IsEnabledCore IsEnabledCore

Inherited from AutomationPeer

IsKeyboardFocusable IsKeyboardFocusable IsKeyboardFocusable IsKeyboardFocusable

Inherited from AutomationPeer

IsKeyboardFocusableCore IsKeyboardFocusableCore IsKeyboardFocusableCore IsKeyboardFocusableCore

Inherited from AutomationPeer

IsOffscreen IsOffscreen IsOffscreen IsOffscreen

Inherited from AutomationPeer

IsOffscreenCore IsOffscreenCore IsOffscreenCore IsOffscreenCore

Inherited from AutomationPeer

IsPassword IsPassword IsPassword IsPassword

Inherited from AutomationPeer

IsPasswordCore IsPasswordCore IsPasswordCore IsPasswordCore

Inherited from AutomationPeer

IsPeripheral IsPeripheral IsPeripheral IsPeripheral

Inherited from AutomationPeer

IsPeripheralCore IsPeripheralCore IsPeripheralCore IsPeripheralCore

Inherited from AutomationPeer

IsRequiredForForm IsRequiredForForm IsRequiredForForm IsRequiredForForm

Inherited from AutomationPeer

IsRequiredForFormCore IsRequiredForFormCore IsRequiredForFormCore IsRequiredForFormCore

Inherited from AutomationPeer

ListenerExists(AutomationEvents) ListenerExists(AutomationEvents) ListenerExists(AutomationEvents) ListenerExists(AutomationEvents)

Inherited from AutomationPeer

Navigate(AutomationNavigationDirection) Navigate(AutomationNavigationDirection) Navigate(AutomationNavigationDirection) Navigate(AutomationNavigationDirection)

Inherited from AutomationPeer

NavigateCore(AutomationNavigationDirection) NavigateCore(AutomationNavigationDirection) NavigateCore(AutomationNavigationDirection) NavigateCore(AutomationNavigationDirection)

Inherited from AutomationPeer

PeerFromProvider(IRawElementProviderSimple) PeerFromProvider(IRawElementProviderSimple) PeerFromProvider(IRawElementProviderSimple) PeerFromProvider(IRawElementProviderSimple)

Inherited from AutomationPeer

ProviderFromPeer(AutomationPeer) ProviderFromPeer(AutomationPeer) ProviderFromPeer(AutomationPeer) ProviderFromPeer(AutomationPeer)

Inherited from AutomationPeer

RaiseAutomationEvent(AutomationEvents) RaiseAutomationEvent(AutomationEvents) RaiseAutomationEvent(AutomationEvents) RaiseAutomationEvent(AutomationEvents)

Inherited from AutomationPeer

RaiseNotificationEvent(AutomationNotificationKind,AutomationNotificationProcessing,String,String) RaiseNotificationEvent(AutomationNotificationKind,AutomationNotificationProcessing,String,String) RaiseNotificationEvent(AutomationNotificationKind,AutomationNotificationProcessing,String,String) RaiseNotificationEvent(AutomationNotificationKind,AutomationNotificationProcessing,String,String)

Inherited from AutomationPeer

RaisePropertyChangedEvent(AutomationProperty,Object,Object) RaisePropertyChangedEvent(AutomationProperty,Object,Object) RaisePropertyChangedEvent(AutomationProperty,Object,Object) RaisePropertyChangedEvent(AutomationProperty,Object,Object)

Inherited from AutomationPeer

RaiseStructureChangedEvent(AutomationStructureChangeType,AutomationPeer) RaiseStructureChangedEvent(AutomationStructureChangeType,AutomationPeer) RaiseStructureChangedEvent(AutomationStructureChangeType,AutomationPeer) RaiseStructureChangedEvent(AutomationStructureChangeType,AutomationPeer)

Inherited from AutomationPeer

RaiseTextEditTextChangedEvent(AutomationTextEditChangeType,IVectorView{String}) RaiseTextEditTextChangedEvent(AutomationTextEditChangeType,IVectorView{String}) RaiseTextEditTextChangedEvent(AutomationTextEditChangeType,IVectorView{String}) RaiseTextEditTextChangedEvent(AutomationTextEditChangeType,IVectorView{String})

Inherited from AutomationPeer

ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Inherited from DependencyObject

RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

Inherited from DependencyObject

SetFocus SetFocus SetFocus SetFocus

Inherited from AutomationPeer

SetFocusCore SetFocusCore SetFocusCore SetFocusCore

Inherited from AutomationPeer

SetParent(AutomationPeer) SetParent(AutomationPeer) SetParent(AutomationPeer) SetParent(AutomationPeer)

Inherited from AutomationPeer

SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Inherited from DependencyObject

ShowContextMenu ShowContextMenu ShowContextMenu ShowContextMenu

Inherited from AutomationPeer

ShowContextMenuCore ShowContextMenuCore ShowContextMenuCore ShowContextMenuCore

Inherited from AutomationPeer

UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Inherited from DependencyObject

See Also