ComboBoxAutomationPeer ComboBoxAutomationPeer ComboBoxAutomationPeer Class

Definition

Exposes ComboBox types to Microsoft UI Automation.

public : class ComboBoxAutomationPeer : SelectorAutomationPeer, IComboBoxAutomationPeer, IExpandCollapseProvider, IValueProvider, IWindowProvider
public class ComboBoxAutomationPeer : SelectorAutomationPeer, IComboBoxAutomationPeer, IExpandCollapseProvider, IValueProvider, IWindowProvider
Public 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)

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.

Properties

CanSelectMultiple CanSelectMultiple CanSelectMultiple

Inherited from SelectorAutomationPeer

Dispatcher Dispatcher Dispatcher

Inherited from DependencyObject

EventsSource EventsSource EventsSource

Inherited from AutomationPeer

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.

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.

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
Platform::Boolean bool bool

A Boolean value indicating if the ComboBox control is modal.

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
Platform::Boolean bool bool

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

IsSelectionRequired IsSelectionRequired IsSelectionRequired

Inherited from SelectorAutomationPeer

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
Platform::Boolean bool bool

A Boolean value indicating if the ComboBox control is topmost.

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
Platform::Boolean bool bool

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

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
Platform::Boolean bool bool

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

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

Owner Owner Owner

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
Platform::String string string

The value of the control, as a string.

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.

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

Methods

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

Inherited from DependencyObject

Close() Close() Close()

Attempts to close the ComboBox control.

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

CreateItemAutomationPeer(Object) CreateItemAutomationPeer(Object) CreateItemAutomationPeer(Object)

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

Expand() Expand() Expand()

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

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

FindItemByProperty(IRawElementProviderSimple,AutomationProperty,Object) FindItemByProperty(IRawElementProviderSimple,AutomationProperty,Object) FindItemByProperty(IRawElementProviderSimple,AutomationProperty,Object)

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

GenerateRawElementProviderRuntimeId GenerateRawElementProviderRuntimeId GenerateRawElementProviderRuntimeId

Inherited from AutomationPeer

GetAcceleratorKey GetAcceleratorKey GetAcceleratorKey

Inherited from AutomationPeer

GetAcceleratorKeyCore GetAcceleratorKeyCore GetAcceleratorKeyCore

Inherited from AutomationPeer

GetAccessKey GetAccessKey GetAccessKey

Inherited from AutomationPeer

GetAccessKeyCore GetAccessKeyCore GetAccessKeyCore

Inherited from AutomationPeer

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

Inherited from DependencyObject

GetAnnotations GetAnnotations GetAnnotations

Inherited from AutomationPeer

GetAnnotationsCore GetAnnotationsCore GetAnnotationsCore

Inherited from AutomationPeer

GetAutomationControlType GetAutomationControlType GetAutomationControlType

Inherited from AutomationPeer

GetAutomationControlTypeCore GetAutomationControlTypeCore GetAutomationControlTypeCore

Inherited from AutomationPeer

GetAutomationId GetAutomationId GetAutomationId

Inherited from AutomationPeer

GetAutomationIdCore GetAutomationIdCore GetAutomationIdCore

Inherited from AutomationPeer

GetBoundingRectangle GetBoundingRectangle GetBoundingRectangle

Inherited from AutomationPeer

GetBoundingRectangleCore GetBoundingRectangleCore GetBoundingRectangleCore

Inherited from AutomationPeer

GetChildren GetChildren GetChildren

Inherited from AutomationPeer

GetChildrenCore GetChildrenCore GetChildrenCore

Inherited from AutomationPeer

GetClassName GetClassName GetClassName

Inherited from AutomationPeer

GetClassNameCore GetClassNameCore GetClassNameCore

Inherited from AutomationPeer

GetClickablePoint GetClickablePoint GetClickablePoint

Inherited from AutomationPeer

GetClickablePointCore GetClickablePointCore GetClickablePointCore

Inherited from AutomationPeer

GetControlledPeers GetControlledPeers GetControlledPeers

Inherited from AutomationPeer

GetControlledPeersCore GetControlledPeersCore GetControlledPeersCore

Inherited from AutomationPeer

GetCulture GetCulture GetCulture

Inherited from AutomationPeer

GetCultureCore GetCultureCore GetCultureCore

Inherited from AutomationPeer

GetDescribedByCore GetDescribedByCore GetDescribedByCore

Inherited from AutomationPeer

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

Inherited from AutomationPeer

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

Inherited from AutomationPeer

GetFlowsFromCore GetFlowsFromCore GetFlowsFromCore

Inherited from AutomationPeer

GetFlowsToCore GetFlowsToCore GetFlowsToCore

Inherited from AutomationPeer

GetFocusedElement GetFocusedElement GetFocusedElement

Inherited from AutomationPeer

GetFocusedElementCore GetFocusedElementCore GetFocusedElementCore

Inherited from AutomationPeer

GetFullDescription GetFullDescription GetFullDescription

Inherited from AutomationPeer

GetFullDescriptionCore GetFullDescriptionCore GetFullDescriptionCore

Inherited from AutomationPeer

GetHelpText GetHelpText GetHelpText

Inherited from AutomationPeer

GetHelpTextCore GetHelpTextCore GetHelpTextCore

Inherited from AutomationPeer

GetItemStatus GetItemStatus GetItemStatus

Inherited from AutomationPeer

GetItemStatusCore GetItemStatusCore GetItemStatusCore

Inherited from AutomationPeer

GetItemType GetItemType GetItemType

Inherited from AutomationPeer

GetItemTypeCore GetItemTypeCore GetItemTypeCore

Inherited from AutomationPeer

GetLabeledBy GetLabeledBy GetLabeledBy

Inherited from AutomationPeer

GetLabeledByCore GetLabeledByCore GetLabeledByCore

Inherited from AutomationPeer

GetLandmarkType GetLandmarkType GetLandmarkType

Inherited from AutomationPeer

GetLandmarkTypeCore GetLandmarkTypeCore GetLandmarkTypeCore

Inherited from AutomationPeer

GetLevel GetLevel GetLevel

Inherited from AutomationPeer

GetLevelCore GetLevelCore GetLevelCore

Inherited from AutomationPeer

GetLiveSetting GetLiveSetting GetLiveSetting

Inherited from AutomationPeer

GetLiveSettingCore GetLiveSettingCore GetLiveSettingCore

Inherited from AutomationPeer

GetLocalizedControlType GetLocalizedControlType GetLocalizedControlType

Inherited from AutomationPeer

GetLocalizedControlTypeCore GetLocalizedControlTypeCore GetLocalizedControlTypeCore

Inherited from AutomationPeer

GetLocalizedLandmarkType GetLocalizedLandmarkType GetLocalizedLandmarkType

Inherited from AutomationPeer

GetLocalizedLandmarkTypeCore GetLocalizedLandmarkTypeCore GetLocalizedLandmarkTypeCore

Inherited from AutomationPeer

GetName GetName GetName

Inherited from AutomationPeer

GetNameCore GetNameCore GetNameCore

Inherited from AutomationPeer

GetOrientation GetOrientation GetOrientation

Inherited from AutomationPeer

GetOrientationCore GetOrientationCore GetOrientationCore

Inherited from AutomationPeer

GetParent GetParent GetParent

Inherited from AutomationPeer

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

Inherited from AutomationPeer

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

Inherited from AutomationPeer

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

Inherited from AutomationPeer

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

Inherited from AutomationPeer

GetPositionInSet GetPositionInSet GetPositionInSet

Inherited from AutomationPeer

GetPositionInSetCore GetPositionInSetCore GetPositionInSetCore

Inherited from AutomationPeer

GetSelection GetSelection GetSelection

Inherited from SelectorAutomationPeer

GetSizeOfSet GetSizeOfSet GetSizeOfSet

Inherited from AutomationPeer

GetSizeOfSetCore GetSizeOfSetCore GetSizeOfSetCore

Inherited from AutomationPeer

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

Inherited from DependencyObject

HasKeyboardFocus HasKeyboardFocus HasKeyboardFocus

Inherited from AutomationPeer

HasKeyboardFocusCore HasKeyboardFocusCore HasKeyboardFocusCore

Inherited from AutomationPeer

InvalidatePeer InvalidatePeer InvalidatePeer

Inherited from AutomationPeer

IsContentElement IsContentElement IsContentElement

Inherited from AutomationPeer

IsContentElementCore IsContentElementCore IsContentElementCore

Inherited from AutomationPeer

IsControlElement IsControlElement IsControlElement

Inherited from AutomationPeer

IsControlElementCore IsControlElementCore IsControlElementCore

Inherited from AutomationPeer

IsDataValidForForm IsDataValidForForm IsDataValidForForm

Inherited from AutomationPeer

IsDataValidForFormCore IsDataValidForFormCore IsDataValidForFormCore

Inherited from AutomationPeer

IsEnabled IsEnabled IsEnabled

Inherited from AutomationPeer

IsEnabledCore IsEnabledCore IsEnabledCore

Inherited from AutomationPeer

IsKeyboardFocusable IsKeyboardFocusable IsKeyboardFocusable

Inherited from AutomationPeer

IsKeyboardFocusableCore IsKeyboardFocusableCore IsKeyboardFocusableCore

Inherited from AutomationPeer

IsOffscreen IsOffscreen IsOffscreen

Inherited from AutomationPeer

IsOffscreenCore IsOffscreenCore IsOffscreenCore

Inherited from AutomationPeer

IsPassword IsPassword IsPassword

Inherited from AutomationPeer

IsPasswordCore IsPasswordCore IsPasswordCore

Inherited from AutomationPeer

IsPeripheral IsPeripheral IsPeripheral

Inherited from AutomationPeer

IsPeripheralCore IsPeripheralCore IsPeripheralCore

Inherited from AutomationPeer

IsRequiredForForm IsRequiredForForm IsRequiredForForm

Inherited from AutomationPeer

IsRequiredForFormCore IsRequiredForFormCore IsRequiredForFormCore

Inherited from AutomationPeer

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

Inherited from AutomationPeer

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

Inherited from AutomationPeer

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

Inherited from AutomationPeer

OnCreateItemAutomationPeer(Object) OnCreateItemAutomationPeer(Object) OnCreateItemAutomationPeer(Object)

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

Inherited from AutomationPeer

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

Inherited from AutomationPeer

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

Inherited from AutomationPeer

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)

Inherited from 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})

Inherited from AutomationPeer

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

Inherited from DependencyObject

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

Inherited from DependencyObject

SetFocus SetFocus SetFocus

Inherited from AutomationPeer

SetFocusCore SetFocusCore SetFocusCore

Inherited from AutomationPeer

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

Inherited from AutomationPeer

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

Inherited from DependencyObject

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
Parameters
value
Platform::String String String

The value to set.

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.

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

ShowContextMenu ShowContextMenu ShowContextMenu

Inherited from AutomationPeer

ShowContextMenuCore ShowContextMenuCore ShowContextMenuCore

Inherited from AutomationPeer

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

Inherited from DependencyObject

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
Parameters
milliseconds
int Int32 Int32

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

Returns
Platform::Boolean bool bool

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

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

See Also