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

ComboBoxAutomationPeer class

Exposes ComboBox types to Microsoft UI Automation.

Inheritance

Object
  DependencyObject
    AutomationPeer
      FrameworkElementAutomationPeer
        ItemsControlAutomationPeer
          SelectorAutomationPeer
            ComboBoxAutomationPeer

Syntax


public class ComboBoxAutomationPeer : SelectorAutomationPeer,
    IExpandCollapseProvider,
    IValueProvider

Members

The ComboBoxAutomationPeer class has these types of members:

Constructors

The ComboBoxAutomationPeer class has these constructors.

ConstructorDescription
ComboBoxAutomationPeer Initializes a new instance of the ComboBoxAutomationPeer class.

 

Methods

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

MethodDescription
Close Attempts to close the ComboBox control.
Collapse Hides all nodes, controls, or content that are descendants of the control.
Expand Displays all child nodes, controls, or content of the control.
SetValue Sets the value of a control, as an implementation of the IValueProvider pattern.
SetVisualState Changes the visual state of the ComboBox control.
WaitForInputIdle Causes the calling code to block for the specified time or until the associated process enters an idle state, whichever completes first.

 

Properties

The ComboBoxAutomationPeer 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 ComboBox control.

IsModal

Read-only

Gets a Boolean value indicating if the ComboBox control is modal.

IsReadOnly

Read-only

Gets a value that specifies whether the value of a control is read-only.

IsTopmost

Read-only

Gets a Boolean value indicating if the ComboBox control is topmost.

Maximizable

Read-only

Gets a Boolean value indicating if the ComboBox control can be maximized.

Minimizable

Read-only

Gets a Boolean value indicating if the ComboBox control can be minimized.

Value

Read-only

Gets the value of the control.

VisualState

Read-only

Gets the WindowVisualState for the ComboBox control.

 

Remarks

The Windows Runtime ComboBox class creates a new ComboBoxAutomationPeer as its OnCreateAutomationPeer definition. Derive your automation peer from ComboBoxAutomationPeer if you are deriving a custom class from ComboBox 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 ComboBoxAutomationPeer

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

This peer has the base classes ItemsControlAutomationPeer and SelectorAutomationPeer and these peers also have behavior that isn't overridden by the notes above. For more info, see ItemsControlAutomationPeer and SelectorAutomationPeer.

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.

IsReadOnly and IsEnabled return a calculated value based on UI properties such as IsEnabled on the owner.

The peer can fire the automation events when ExpandCollapseState of the peer and owner control changes.

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
ComboBox
SelectorAutomationPeer
IItemContainerProvider
ISelectionProvider
IValueProvider
IExpandCollapseProvider
ItemsControlAutomationPeer
ComboBoxItemAutomationPeer
Custom automation peers

 

 

Show:
© 2017 Microsoft