Combo​Box​Automation​Peer Combo​Box​Automation​Peer Combo​Box​Automation​Peer Class

Definition

Exposes ComboBox types to Microsoft UI Automation.

public class ComboBoxAutomationPeer : SelectorAutomationPeer, IComboBoxAutomationPeer, IExpandCollapseProvider, IValueProvider, IWindowProviderpublic class ComboBoxAutomationPeer : SelectorAutomationPeer, IComboBoxAutomationPeer, IExpandCollapseProvider, IValueProvider, IWindowProviderPublic Class ComboBoxAutomationPeer Inherits SelectorAutomationPeer Implements IComboBoxAutomationPeer, IExpandCollapseProvider, IValueProvider, IWindowProvider
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Inherited Members

Inherited properties

Inherited methods

Windows.UI.Xaml.Automation.Peers.AutomationPeer.RaiseTextEditTextChangedEvent(Windows.UI.Xaml.Automation.AutomationTextEditChangeType,Windows.Foundation.Collections.IVectorView<System.String>)Windows.UI.Xaml.Automation.Peers.AutomationPeer.RaiseTextEditTextChangedEvent(Windows.UI.Xaml.Automation.AutomationTextEditChangeType,Windows.Foundation.Collections.IVectorView<System.String>)Windows.UI.Xaml.Automation.Peers.AutomationPeer.RaiseTextEditTextChangedEvent(Windows.UI.Xaml.Automation.AutomationTextEditChangeType,Windows.Foundation.Collections.IVectorView<System.String>)

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 Microsoft 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.

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.

Constructors

ComboBoxAutomationPeer(ComboBox) ComboBoxAutomationPeer(ComboBox) ComboBoxAutomationPeer(ComboBox)

Initializes a new instance of the ComboBoxAutomationPeer class.

public ComboBoxAutomationPeer(ComboBox owner)public ComboBoxAutomationPeer(ComboBox owner)Public Sub New(owner As ComboBox)
Parameters
owner
ComboBox ComboBox ComboBox

The owner element to create for.

Attributes

Properties

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
Value
ExpandCollapseState ExpandCollapseState ExpandCollapseState

A value of the enumeration.

Attributes

InteractionState InteractionState InteractionState

Gets the interaction state of the ComboBox control.

public WindowInteractionState InteractionState { get; }public WindowInteractionState InteractionState { get; }Public ReadOnly Property InteractionState As WindowInteractionState
Value
WindowInteractionState WindowInteractionState WindowInteractionState

The interaction state of the ComboBox control, as a value of the enumeration.

Attributes
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

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

public PlatForm::Boolean IsModal { get; }public bool IsModal { get; }Public ReadOnly Property IsModal As bool
Value
bool bool bool

A Boolean value indicating if the ComboBox control is modal.

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

IsReadOnly IsReadOnly IsReadOnly

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

public PlatForm::Boolean IsReadOnly { get; }public bool IsReadOnly { get; }Public ReadOnly Property IsReadOnly As bool
Value
bool bool bool

true if the control value can be set; otherwise, false.

Attributes

IsTopmost IsTopmost IsTopmost

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

public PlatForm::Boolean IsTopmost { get; }public bool IsTopmost { get; }Public ReadOnly Property IsTopmost As bool
Value
bool bool bool

A Boolean value indicating if the ComboBox control is topmost.

Attributes
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

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

public PlatForm::Boolean Maximizable { get; }public bool Maximizable { get; }Public ReadOnly Property Maximizable As bool
Value
bool bool bool

A Boolean value indicating if the ComboBox control can be maximized.

Attributes
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

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

public PlatForm::Boolean Minimizable { get; }public bool Minimizable { get; }Public ReadOnly Property Minimizable As bool
Value
bool bool bool

A Boolean value indicating if the ComboBox control can be minimized.

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

Value Value Value

Gets the value of the control.

public PlatForm::String Value { get; }public string Value { get; }Public ReadOnly Property Value As string
Value
string string string

The value of the control, as a string.

Attributes

VisualState VisualState VisualState

Gets the WindowVisualState for the ComboBox control.

public WindowVisualState VisualState { get; }public WindowVisualState VisualState { get; }Public ReadOnly Property VisualState As WindowVisualState
Value
WindowVisualState WindowVisualState WindowVisualState

The WindowVisualState for the ComboBox control, as a value of the enumeration.

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

Methods

Close() Close() Close()

Attempts to close the ComboBox control.

public void Close()public void Close()Public Function Close() As void
Attributes
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()

Hides all nodes, controls, or content that are descendants of the control.

public void Collapse()public void Collapse()Public Function Collapse() As void
Attributes

Expand() Expand() Expand()

Displays all child nodes, controls, or content of the control.

public void Expand()public void Expand()Public Function Expand() As void
Attributes

SetValue(String) SetValue(String) SetValue(String)

Sets the value of a control, as an implementation of the IValueProvider pattern.

public void SetValue(String value)public void SetValue(String value)Public Function SetValue(value As String) As void
Parameters
value
System.String System.String System.String

The value to set.

Attributes

SetVisualState(WindowVisualState) SetVisualState(WindowVisualState) SetVisualState(WindowVisualState)

Changes the visual state of the ComboBox control.

public void SetVisualState(WindowVisualState state)public void SetVisualState(WindowVisualState state)Public Function SetVisualState(state As WindowVisualState) As void
Parameters
state
WindowVisualState WindowVisualState WindowVisualState

The visual state for the ComboBox control, as a value of the enumeration.

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

WaitForInputIdle(Int32) WaitForInputIdle(Int32) WaitForInputIdle(Int32)

Causes the calling code to block for the specified time or until the associated process enters an idle state, whichever completes first.

public PlatForm::Boolean WaitForInputIdle(Int32 milliseconds)public bool WaitForInputIdle(Int32 milliseconds)Public Function WaitForInputIdle(milliseconds As Int32) As bool
Parameters
milliseconds
System.Int32 System.Int32 System.Int32

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

Returns
bool bool bool

true if the window has entered the idle state; false if the time-out occurred.

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

See Also