RadioButtonAutomationPeer
RadioButtonAutomationPeer
RadioButtonAutomationPeer
RadioButtonAutomationPeer
Class
Definition
Exposes RadioButton types to Microsoft UI Automation.
public : class RadioButtonAutomationPeer : ToggleButtonAutomationPeer, IRadioButtonAutomationPeer, ISelectionItemProviderpublic class RadioButtonAutomationPeer : ToggleButtonAutomationPeer, IRadioButtonAutomationPeer, ISelectionItemProviderPublic Class RadioButtonAutomationPeer Inherits ToggleButtonAutomationPeer Implements IRadioButtonAutomationPeer, ISelectionItemProvider// This API is not available in Javascript.
- Inheritance
-
FrameworkElementAutomationPeerFrameworkElementAutomationPeerFrameworkElementAutomationPeerFrameworkElementAutomationPeerToggleButtonAutomationPeerToggleButtonAutomationPeerToggleButtonAutomationPeerToggleButtonAutomationPeerRadioButtonAutomationPeerRadioButtonAutomationPeerRadioButtonAutomationPeerRadioButtonAutomationPeer
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Inherited Members
Inherited methods
Inherited properties
Remarks
The Windows Runtime RadioButton class creates a new RadioButtonAutomationPeer as its OnCreateAutomationPeer definition. Derive your automation peer from RadioButtonAutomationPeer if you are deriving a custom class from RadioButton 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 RadioButtonAutomationPeer
RadioButtonAutomationPeer 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 PatternInterface.SelectionItem (ISelectionItemProvider ). Also, the ToggleButtonAutomationPeer peer base reports support for PatternInterface.Toggle (IToggleProvider ).
- GetClassName returns "RadioButton".
- GetAutomationControlType returns AutomationControlType.RadioButton.
- IsControlElement returns true. This peer has the base classes ButtonBaseAutomationPeer and ToggleButtonAutomationPeer and inherits behavior other than the overrides indicated above. Notably, GetName returns a string value based on examining the current Content. For more info, see ButtonBaseAutomationPeer.
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.
Constructors
RadioButtonAutomationPeer(RadioButton) RadioButtonAutomationPeer(RadioButton) RadioButtonAutomationPeer(RadioButton) RadioButtonAutomationPeer(RadioButton)
Initializes a new instance of the RadioButtonAutomationPeer class.
public : RadioButtonAutomationPeer(RadioButton owner)public RadioButtonAutomationPeer(RadioButton owner)Public Sub New(owner As RadioButton)// This API is not available in Javascript.
The owner element to create for.
Properties
IsSelected IsSelected IsSelected IsSelected
Gets a value that indicates whether an item is selected.
public : PlatForm::Boolean IsSelected { get; }public bool IsSelected { get; }Public ReadOnly Property IsSelected As bool// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
true if the element is selected; otherwise, false.
SelectionContainer SelectionContainer SelectionContainer SelectionContainer
Gets the UI automation provider that implements ISelectionProvider and acts as the container for the calling object.
public : IRawElementProviderSimple SelectionContainer { get; }public IRawElementProviderSimple SelectionContainer { get; }Public ReadOnly Property SelectionContainer As IRawElementProviderSimple// This API is not available in Javascript.
- Value
- IRawElementProviderSimple IRawElementProviderSimple IRawElementProviderSimple IRawElementProviderSimple
The provider that supports ISelectionProvider.
Methods
AddToSelection() AddToSelection() AddToSelection() AddToSelection()
Adds the current element to the collection of selected items.
public : void AddToSelection()public void AddToSelection()Public Function AddToSelection() As void// This API is not available in Javascript.
RemoveFromSelection() RemoveFromSelection() RemoveFromSelection() RemoveFromSelection()
Removes the current element from the collection of selected items.
public : void RemoveFromSelection()public void RemoveFromSelection()Public Function RemoveFromSelection() As void// This API is not available in Javascript.