AutomationProperties Class
Definition
public class AutomationProperties
Methods
GetAcceleratorKey Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.AcceleratorKeyProperty on a StyledElement.
public string GetAcceleratorKey(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
string
GetAccessKey Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.AccessKeyProperty on a StyledElement.
public string GetAccessKey(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
string
GetAccessibilityView Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.AccessibilityViewProperty on a StyledElement.
public Avalonia.Automation.AccessibilityView GetAccessibilityView(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
GetAutomationId Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.AutomationIdProperty on a StyledElement.
public string GetAutomationId(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
string
GetClassNameOverride Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.ClassNameOverrideProperty on a StyledElement.
public string GetClassNameOverride(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
string
GetControlTypeOverride Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.ControlTypeOverrideProperty on a StyledElement.
public Nullable<Avalonia.Automation.Peers.AutomationControlType> GetControlTypeOverride(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
GetHeadingLevel Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.HeadingLevelProperty on a StyledElement.
public int GetHeadingLevel(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
int
GetHelpText Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.HelpTextProperty on a StyledElement.
public string GetHelpText(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
string
GetIsColumnHeader Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.IsColumnHeaderProperty on a StyledElement.
public bool GetIsColumnHeader(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
bool
GetIsControlElementOverride Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.IsControlElementOverrideProperty on a StyledElement.
public Nullable<bool> GetIsControlElementOverride(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
Nullable<bool>
GetIsOffscreenBehavior Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.IsOffscreenBehaviorProperty on a StyledElement.
public Avalonia.Automation.IsOffscreenBehavior GetIsOffscreenBehavior(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
GetIsRequiredForForm Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.IsRequiredForFormProperty on a StyledElement.
public bool GetIsRequiredForForm(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
bool
GetIsRowHeader Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.IsRowHeaderProperty on a StyledElement.
public bool GetIsRowHeader(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
bool
GetItemStatus Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.ItemStatusProperty on a StyledElement.
public string GetItemStatus(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
string
GetItemType Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.ItemTypeProperty on a StyledElement.
public string GetItemType(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
string
GetLabeledBy Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.LabeledByProperty on a StyledElement.
public Avalonia.Controls.Control GetLabeledBy(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
GetLandmarkType Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.LandmarkTypeProperty on a StyledElement.
public Nullable<Avalonia.Automation.Peers.AutomationLandmarkType> GetLandmarkType(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
GetLiveSetting Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.LiveSettingProperty on a StyledElement.
public Avalonia.Automation.AutomationLiveSetting GetLiveSetting(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
GetName Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.NameProperty on a StyledElement.
public string GetName(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
string
GetPositionInSet Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.PositionInSetProperty on a StyledElement.
public int GetPositionInSet(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
int
GetSizeOfSet Method
Helper for reading the value of the Avalonia.Automation.AutomationProperties.SizeOfSetProperty on a StyledElement.
public int GetSizeOfSet(Avalonia.StyledElement element)
Parameters
element Avalonia.StyledElement
Returns
int
SetAcceleratorKey Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.AcceleratorKeyProperty on a StyledElement.
public void SetAcceleratorKey(Avalonia.StyledElement element, string value)
Parameters
element Avalonia.StyledElement
value string
SetAccessKey Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.AccessKeyProperty on a StyledElement.
public void SetAccessKey(Avalonia.StyledElement element, string value)
Parameters
element Avalonia.StyledElement
value string
SetAccessibilityView Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.AccessibilityViewProperty on a StyledElement.
public void SetAccessibilityView(Avalonia.StyledElement element, Avalonia.Automation.AccessibilityView value)
Parameters
element Avalonia.StyledElement
SetAutomationId Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.AutomationIdProperty on a StyledElement.
public void SetAutomationId(Avalonia.StyledElement element, string value)
Parameters
element Avalonia.StyledElement
value string
SetClassNameOverride Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.ClassNameOverrideProperty on a StyledElement.
public void SetClassNameOverride(Avalonia.StyledElement element, string value)
Parameters
element Avalonia.StyledElement
value string
SetControlTypeOverride Method
public void SetControlTypeOverride(Avalonia.StyledElement element, Nullable<Avalonia.Automation.Peers.AutomationControlType> value)
Parameters
element Avalonia.StyledElement
value Nullable<Avalonia.Automation.Peers.AutomationControlType>
SetHeadingLevel Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.HeadingLevelProperty on a StyledElement.
public void SetHeadingLevel(Avalonia.StyledElement element, int value)
Parameters
element Avalonia.StyledElement
value int
SetHelpText Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.HelpTextProperty on a StyledElement.
public void SetHelpText(Avalonia.StyledElement element, string value)
Parameters
element Avalonia.StyledElement
value string
SetIsColumnHeader Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.IsColumnHeaderProperty on a StyledElement.
public void SetIsColumnHeader(Avalonia.StyledElement element, bool value)
Parameters
element Avalonia.StyledElement
value bool
SetIsControlElementOverride Method
public void SetIsControlElementOverride(Avalonia.StyledElement element, Nullable<bool> value)
Parameters
element Avalonia.StyledElement
value Nullable<bool>
SetIsOffscreenBehavior Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.IsOffscreenBehaviorProperty on a StyledElement.
public void SetIsOffscreenBehavior(Avalonia.StyledElement element, Avalonia.Automation.IsOffscreenBehavior value)
Parameters
element Avalonia.StyledElement
SetIsRequiredForForm Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.IsRequiredForFormProperty on a StyledElement.
public void SetIsRequiredForForm(Avalonia.StyledElement element, bool value)
Parameters
element Avalonia.StyledElement
value bool
SetIsRowHeader Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.IsRowHeaderProperty on a StyledElement.
public void SetIsRowHeader(Avalonia.StyledElement element, bool value)
Parameters
element Avalonia.StyledElement
value bool
SetItemStatus Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.ItemStatusProperty on a StyledElement.
public void SetItemStatus(Avalonia.StyledElement element, string value)
Parameters
element Avalonia.StyledElement
value string
SetItemType Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.ItemTypeProperty on a StyledElement.
public void SetItemType(Avalonia.StyledElement element, string value)
Parameters
element Avalonia.StyledElement
value string
SetLabeledBy Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.LabeledByProperty on a StyledElement.
public void SetLabeledBy(Avalonia.StyledElement element, Avalonia.Controls.Control value)
Parameters
element Avalonia.StyledElement
SetLandmarkType Method
public void SetLandmarkType(Avalonia.StyledElement element, Nullable<Avalonia.Automation.Peers.AutomationLandmarkType> value)
Parameters
element Avalonia.StyledElement
value Nullable<Avalonia.Automation.Peers.AutomationLandmarkType>
SetLiveSetting Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.LiveSettingProperty on a StyledElement.
public void SetLiveSetting(Avalonia.StyledElement element, Avalonia.Automation.AutomationLiveSetting value)
Parameters
element Avalonia.StyledElement
SetName Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.NameProperty on a StyledElement.
public void SetName(Avalonia.StyledElement element, string value)
Parameters
element Avalonia.StyledElement
value string
SetPositionInSet Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.PositionInSetProperty on a StyledElement.
public void SetPositionInSet(Avalonia.StyledElement element, int value)
Parameters
element Avalonia.StyledElement
value int
SetSizeOfSet Method
Helper for setting the value of the Avalonia.Automation.AutomationProperties.SizeOfSetProperty on a StyledElement.
public void SetSizeOfSet(Avalonia.StyledElement element, int value)
Parameters
element Avalonia.StyledElement
value int
Fields
| Name | Description |
|---|---|
| AcceleratorKeyProperty | Defines the AutomationProperties.AcceleratorKey attached property. |
| AccessKeyProperty | Defines the AutomationProperties.AccessKey attached property |
| AccessibilityViewProperty | Defines the AutomationProperties.AccessibilityView attached property. |
| AutomationIdProperty | Defines the AutomationProperties.AutomationId attached property. |
| ClassNameOverrideProperty | Defines the AutomationProperties.ClassNameOverride attached property. |
| ControlTypeOverrideProperty | Defines the AutomationProperties.ControlTypeOverride attached property. |
| HeadingLevelProperty | Defines the AutomationProperties.HeadingLevel attached property. |
| HelpTextProperty | Defines the AutomationProperties.HelpText attached property. |
| IsColumnHeaderProperty | Defines the AutomationProperties.IsColumnHeader attached property. |
| IsControlElementOverrideProperty | Defines the AutomationProperties.IsControlElementOverride attached property. |
| IsOffscreenBehaviorProperty | Defines the AutomationProperties.IsOffscreenBehavior attached property. |
| IsRequiredForFormProperty | Defines the AutomationProperties.IsRequiredForForm attached property. |
| IsRowHeaderProperty | Defines the AutomationProperties.IsRowHeader attached property. |
| ItemStatusProperty | Defines the AutomationProperties.ItemStatus attached property. |
| ItemTypeProperty | Defines the AutomationProperties.ItemType attached property. |
| LabeledByProperty | Defines the AutomationProperties.LabeledBy attached property. |
| LandmarkTypeProperty | Defines the AutomationProperties.LandmarkType attached property. |
| LiveSettingProperty | Defines the AutomationProperties.LiveSetting attached property. |
| NameProperty | Defines the AutomationProperties.Name attached attached property. |
| PositionInSetProperty | Defines the AutomationProperties.PositionInSet attached property. |
| SizeOfSetProperty | Defines the AutomationProperties.SizeOfSet attached property. |
AcceleratorKeyProperty Field
Defines the AutomationProperties.AcceleratorKey attached property.
public Avalonia.AttachedProperty<string> AcceleratorKeyProperty
Remarks
This property affects the default value for Avalonia.Automation.Peers.AutomationPeer.GetAcceleratorKey.
AccessKeyProperty Field
Defines the AutomationProperties.AccessKey attached property
public Avalonia.AttachedProperty<string> AccessKeyProperty
Remarks
This property affects the default value for Avalonia.Automation.Peers.AutomationPeer.GetAccessKey.
AccessibilityViewProperty Field
Defines the AutomationProperties.AccessibilityView attached property.
public Avalonia.AttachedProperty<Avalonia.Automation.AccessibilityView> AccessibilityViewProperty
Remarks
The value of this property affects the default value of the Avalonia.Automation.Peers.AutomationPeer.IsContentElement and Avalonia.Automation.Peers.AutomationPeer.IsControlElement properties.
AutomationIdProperty Field
Defines the AutomationProperties.AutomationId attached property.
public Avalonia.AttachedProperty<string> AutomationIdProperty
Remarks
This property affects the default value for Avalonia.Automation.Peers.AutomationPeer.GetAutomationId.
ClassNameOverrideProperty Field
Defines the AutomationProperties.ClassNameOverride attached property.
public Avalonia.AttachedProperty<string> ClassNameOverrideProperty
Remarks
This property affects the default value for Avalonia.Automation.Peers.AutomationPeer.GetClassName.
ControlTypeOverrideProperty Field
Defines the AutomationProperties.ControlTypeOverride attached property.
public Avalonia.AttachedProperty<Nullable<Avalonia.Automation.Peers.AutomationControlType>> ControlTypeOverrideProperty
Remarks
This property affects the default value for Avalonia.Automation.Peers.AutomationPeer.GetAutomationControlType.
HeadingLevelProperty Field
Defines the AutomationProperties.HeadingLevel attached property.
public Avalonia.AttachedProperty<int> HeadingLevelProperty
Remarks
This property affects the default value for Avalonia.Automation.Peers.AutomationPeer.GetHeadingLevel.
HelpTextProperty Field
Defines the AutomationProperties.HelpText attached property.
public Avalonia.AttachedProperty<string> HelpTextProperty
Remarks
This property affects the default value for Avalonia.Automation.Peers.AutomationPeer.GetHelpText.
IsColumnHeaderProperty Field
Defines the AutomationProperties.IsColumnHeader attached property.
public Avalonia.AttachedProperty<bool> IsColumnHeaderProperty
Remarks
This property currently has no effect.
IsControlElementOverrideProperty Field
Defines the AutomationProperties.IsControlElementOverride attached property.
public Avalonia.AttachedProperty<Nullable<bool>> IsControlElementOverrideProperty
Remarks
This property affects the default value for Avalonia.Automation.Peers.AutomationPeer.IsControlElement.
IsOffscreenBehaviorProperty Field
Defines the AutomationProperties.IsOffscreenBehavior attached property.
public Avalonia.AttachedProperty<Avalonia.Automation.IsOffscreenBehavior> IsOffscreenBehaviorProperty
Remarks
This property affects the default value for Avalonia.Automation.Peers.AutomationPeer.IsOffscreen.
IsRequiredForFormProperty Field
Defines the AutomationProperties.IsRequiredForForm attached property.
public Avalonia.AttachedProperty<bool> IsRequiredForFormProperty
Remarks
This property currently has no effect.
IsRowHeaderProperty Field
Defines the AutomationProperties.IsRowHeader attached property.
public Avalonia.AttachedProperty<bool> IsRowHeaderProperty
Remarks
This property currently has no effect.
ItemStatusProperty Field
Defines the AutomationProperties.ItemStatus attached property.
public Avalonia.AttachedProperty<string> ItemStatusProperty
Remarks
This property currently has no effect.
ItemTypeProperty Field
Defines the AutomationProperties.ItemType attached property.
public Avalonia.AttachedProperty<string> ItemTypeProperty
Remarks
This property currently has no effect.
LabeledByProperty Field
Defines the AutomationProperties.LabeledBy attached property.
public Avalonia.AttachedProperty<Avalonia.Controls.Control> LabeledByProperty
Remarks
This property affects the default value for Avalonia.Automation.Peers.AutomationPeer.GetLabeledBy.
LandmarkTypeProperty Field
Defines the AutomationProperties.LandmarkType attached property.
public Avalonia.AttachedProperty<Nullable<Avalonia.Automation.Peers.AutomationLandmarkType>> LandmarkTypeProperty
Remarks
This property affects the default value for Avalonia.Automation.Peers.AutomationPeer.GetLandmarkType
LiveSettingProperty Field
Defines the AutomationProperties.LiveSetting attached property.
public Avalonia.AttachedProperty<Avalonia.Automation.AutomationLiveSetting> LiveSettingProperty
Remarks
This property affects the default value for Avalonia.Automation.Peers.AutomationPeer.GetLiveSetting and controls whether live region changed events are emitted.
NameProperty Field
Defines the AutomationProperties.Name attached attached property.
public Avalonia.AttachedProperty<string> NameProperty
Remarks
This property affects the default value for Avalonia.Automation.Peers.AutomationPeer.GetName.
PositionInSetProperty Field
Defines the AutomationProperties.PositionInSet attached property.
public Avalonia.AttachedProperty<int> PositionInSetProperty
Remarks
NOTE: This property currently has no effect.
The PositionInSet property describes the ordinal location of the element within a set of elements which are considered to be siblings. PositionInSet works in coordination with the SizeOfSet property to describe the ordinal location in the set.
SizeOfSetProperty Field
Defines the AutomationProperties.SizeOfSet attached property.
public Avalonia.AttachedProperty<int> SizeOfSetProperty
Remarks
NOTE: This property currently has no effect.
The SizeOfSet property describes the count of automation elements in a group or set that are considered to be siblings. SizeOfSet works in coordination with the PositionInSet property to describe the count of items in the set.