ComboBoxAutomationPeer
ComboBoxAutomationPeer
ComboBoxAutomationPeer
ComboBoxAutomationPeer
Class
Definition
public : class ComboBoxAutomationPeer : SelectorAutomationPeer, IComboBoxAutomationPeer, IExpandCollapseProvider, IValueProvider, IWindowProviderpublic class ComboBoxAutomationPeer : SelectorAutomationPeer, IComboBoxAutomationPeer, IExpandCollapseProvider, IValueProvider, IWindowProviderPublic Class ComboBoxAutomationPeer Inherits SelectorAutomationPeer Implements IComboBoxAutomationPeer, IExpandCollapseProvider, IValueProvider, IWindowProvider// This API is not available in Javascript.
- Inheritance
-
FrameworkElementAutomationPeerFrameworkElementAutomationPeerFrameworkElementAutomationPeerFrameworkElementAutomationPeerItemsControlAutomationPeerItemsControlAutomationPeerItemsControlAutomationPeerItemsControlAutomationPeerComboBoxAutomationPeerComboBoxAutomationPeerComboBoxAutomationPeerComboBoxAutomationPeer
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Inherited Members
Inherited properties
Inherited methods
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.
- GetPattern reports that the peer provides pattern support for these patterns:
- PatternInterface.Value (IValueProvider )
- PatternInterface.Selection (ISelectionProvider )
- PatternInterface.ItemContainer (IItemContainerProvider )
- PatternInterface.ExpandCollapse (IExpandCollapseProvider ) This is the accumulated pattern support from each of the peer base classes and ComboBoxAutomationPeer itself.
- GetClassName returns "ComboBox".
- GetAutomationControlType returns AutomationControlType.ComboBox.
- GetChildren provides peers for contained elements. See ComboBoxItemAutomationPeer. 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.
Constructors
ComboBoxAutomationPeer(ComboBox) 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)// 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 ComboBox control.
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 ComboBox control, as a value of the enumeration.
| 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 ComboBox control 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
A Boolean value indicating if the ComboBox control is modal.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
IsReadOnly 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// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
true if the control value can be set; otherwise, false.
IsTopmost 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// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
A Boolean value indicating if the ComboBox control is topmost.
| 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 indicating if the ComboBox control 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
A Boolean value indicating if the ComboBox control can be maximized.
| 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 indicating if the ComboBox control 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
A Boolean value indicating if the ComboBox control can be minimized.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Value Value Value Value
Gets the value of the control.
public : PlatForm::String Value { get; }public string Value { get; }Public ReadOnly Property Value As string// This API is not available in Javascript.
- Value
- PlatForm::String string string string
The value of the control, as a string.
VisualState VisualState VisualState VisualState
Gets the WindowVisualState for the ComboBox control.
public : WindowVisualState VisualState { get; }public WindowVisualState VisualState { get; }Public ReadOnly Property VisualState As WindowVisualState// This API is not available in Javascript.
The WindowVisualState for the ComboBox control, 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()
Attempts to close the ComboBox control.
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.
SetValue(String) SetValue(String) SetValue(String) SetValue(String)
Sets the value of a control, as an implementation of the IValueProvider pattern.
public : void SetValue(PlatForm::String value)public void SetValue(String value)Public Function SetValue(value As String) As void// This API is not available in Javascript.
- value
- PlatForm::String String String String
The value to set.
SetVisualState(WindowVisualState) 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// This API is not available in Javascript.
The visual state for the ComboBox control, as a value of the enumeration.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
WaitForInputIdle(Int32) 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(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. The maximum is Int32.MaxValue.
true if the window has entered the idle state; false if the time-out occurred.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|