Table of Contents

Class AutomationProperties

Namespace
Avalonia.Automation
Assembly
Avalonia.Controls.dll
public static class AutomationProperties
Inheritance
AutomationProperties
Inherited Members

Fields

AcceleratorKeyProperty

Defines the AutomationProperties.AcceleratorKey attached property.

public static readonly AttachedProperty<string?> AcceleratorKeyProperty

Field Value

AttachedProperty<string>

Remarks

This property affects the default value for GetAcceleratorKey().

AccessKeyProperty

Defines the AutomationProperties.AccessKey attached property

public static readonly AttachedProperty<string?> AccessKeyProperty

Field Value

AttachedProperty<string>

Remarks

This property affects the default value for GetAccessKey().

AccessibilityViewProperty

Defines the AutomationProperties.AccessibilityView attached property.

public static readonly AttachedProperty<AccessibilityView> AccessibilityViewProperty

Field Value

AttachedProperty<AccessibilityView>

Remarks

The value of this property affects the default value of the IsContentElement() and IsControlElement() properties.

AutomationIdProperty

Defines the AutomationProperties.AutomationId attached property.

public static readonly AttachedProperty<string?> AutomationIdProperty

Field Value

AttachedProperty<string>

Remarks

This property affects the default value for GetAutomationId().

ControlTypeOverrideProperty

Defines the AutomationProperties.ControlTypeOverride attached property.

public static readonly AttachedProperty<AutomationControlType?> ControlTypeOverrideProperty

Field Value

AttachedProperty<AutomationControlType?>

Remarks

This property affects the default value for GetAutomationControlType().

HelpTextProperty

Defines the AutomationProperties.HelpText attached property.

public static readonly AttachedProperty<string?> HelpTextProperty

Field Value

AttachedProperty<string>

Remarks

This property affects the default value for GetHelpText().

IsColumnHeaderProperty

Defines the AutomationProperties.IsColumnHeader attached property.

public static readonly AttachedProperty<bool> IsColumnHeaderProperty

Field Value

AttachedProperty<bool>

Remarks

This property currently has no effect.

IsOffscreenBehaviorProperty

Defines the AutomationProperties.IsOffscreenBehavior attached property.

public static readonly AttachedProperty<IsOffscreenBehavior> IsOffscreenBehaviorProperty

Field Value

AttachedProperty<IsOffscreenBehavior>

Remarks

This property affects the default value for IsOffscreen().

IsRequiredForFormProperty

Defines the AutomationProperties.IsRequiredForForm attached property.

public static readonly AttachedProperty<bool> IsRequiredForFormProperty

Field Value

AttachedProperty<bool>

Remarks

This property currently has no effect.

IsRowHeaderProperty

Defines the AutomationProperties.IsRowHeader attached property.

public static readonly AttachedProperty<bool> IsRowHeaderProperty

Field Value

AttachedProperty<bool>

Remarks

This property currently has no effect.

ItemStatusProperty

Defines the AutomationProperties.ItemStatus attached property.

public static readonly AttachedProperty<string?> ItemStatusProperty

Field Value

AttachedProperty<string>

Remarks

This property currently has no effect.

ItemTypeProperty

Defines the AutomationProperties.ItemType attached property.

public static readonly AttachedProperty<string?> ItemTypeProperty

Field Value

AttachedProperty<string>

Remarks

This property currently has no effect.

LabeledByProperty

Defines the AutomationProperties.LabeledBy attached property.

public static readonly AttachedProperty<Control> LabeledByProperty

Field Value

AttachedProperty<Control>

Remarks

This property affects the default value for GetLabeledBy().

LiveSettingProperty

Defines the AutomationProperties.LiveSetting attached property.

public static readonly AttachedProperty<AutomationLiveSetting> LiveSettingProperty

Field Value

AttachedProperty<AutomationLiveSetting>

Remarks

This property currently has no effect.

NameProperty

Defines the AutomationProperties.Name attached attached property.

public static readonly AttachedProperty<string?> NameProperty

Field Value

AttachedProperty<string>

Remarks

This property affects the default value for GetName().

PositionInSetProperty

Defines the AutomationProperties.PositionInSet attached property.

public static readonly AttachedProperty<int> PositionInSetProperty

Field Value

AttachedProperty<int>

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

Defines the AutomationProperties.SizeOfSet attached property.

public static readonly AttachedProperty<int> SizeOfSetProperty

Field Value

AttachedProperty<int>

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.

Methods

GetAcceleratorKey(StyledElement)

Helper for reading the value of the AcceleratorKeyProperty on a StyledElement.

public static string? GetAcceleratorKey(StyledElement element)

Parameters

element StyledElement

Returns

string

GetAccessKey(StyledElement)

Helper for reading the value of the AccessKeyProperty on a StyledElement.

public static string? GetAccessKey(StyledElement element)

Parameters

element StyledElement

Returns

string

GetAccessibilityView(StyledElement)

Helper for reading the value of the AccessibilityViewProperty on a StyledElement.

public static AccessibilityView GetAccessibilityView(StyledElement element)

Parameters

element StyledElement

Returns

AccessibilityView

GetAutomationId(StyledElement)

Helper for reading the value of the AutomationIdProperty on a StyledElement.

public static string? GetAutomationId(StyledElement element)

Parameters

element StyledElement

Returns

string

GetControlTypeOverride(StyledElement)

Helper for reading the value of the ControlTypeOverrideProperty on a StyledElement.

public static AutomationControlType? GetControlTypeOverride(StyledElement element)

Parameters

element StyledElement

Returns

AutomationControlType?

GetHelpText(StyledElement)

Helper for reading the value of the HelpTextProperty on a StyledElement.

public static string? GetHelpText(StyledElement element)

Parameters

element StyledElement

Returns

string

GetIsColumnHeader(StyledElement)

Helper for reading the value of the IsColumnHeaderProperty on a StyledElement.

public static bool GetIsColumnHeader(StyledElement element)

Parameters

element StyledElement

Returns

bool

GetIsOffscreenBehavior(StyledElement)

Helper for reading the value of the IsOffscreenBehaviorProperty on a StyledElement.

public static IsOffscreenBehavior GetIsOffscreenBehavior(StyledElement element)

Parameters

element StyledElement

Returns

IsOffscreenBehavior

GetIsRequiredForForm(StyledElement)

Helper for reading the value of the IsRequiredForFormProperty on a StyledElement.

public static bool GetIsRequiredForForm(StyledElement element)

Parameters

element StyledElement

Returns

bool

GetIsRowHeader(StyledElement)

Helper for reading the value of the IsRowHeaderProperty on a StyledElement.

public static bool GetIsRowHeader(StyledElement element)

Parameters

element StyledElement

Returns

bool

GetItemStatus(StyledElement)

Helper for reading the value of the ItemStatusProperty on a StyledElement.

public static string? GetItemStatus(StyledElement element)

Parameters

element StyledElement

Returns

string

GetItemType(StyledElement)

Helper for reading the value of the ItemTypeProperty on a StyledElement.

public static string? GetItemType(StyledElement element)

Parameters

element StyledElement

Returns

string

GetLabeledBy(StyledElement)

Helper for reading the value of the LabeledByProperty on a StyledElement.

public static Control GetLabeledBy(StyledElement element)

Parameters

element StyledElement

Returns

Control

GetLiveSetting(StyledElement)

Helper for reading the value of the LiveSettingProperty on a StyledElement.

public static AutomationLiveSetting GetLiveSetting(StyledElement element)

Parameters

element StyledElement

Returns

AutomationLiveSetting

GetName(StyledElement)

Helper for reading the value of the NameProperty on a StyledElement.

public static string? GetName(StyledElement element)

Parameters

element StyledElement

Returns

string

GetPositionInSet(StyledElement)

Helper for reading the value of the PositionInSetProperty on a StyledElement.

public static int GetPositionInSet(StyledElement element)

Parameters

element StyledElement

Returns

int

GetSizeOfSet(StyledElement)

Helper for reading the value of the SizeOfSetProperty on a StyledElement.

public static int GetSizeOfSet(StyledElement element)

Parameters

element StyledElement

Returns

int

SetAcceleratorKey(StyledElement, string)

Helper for setting the value of the AcceleratorKeyProperty on a StyledElement.

public static void SetAcceleratorKey(StyledElement element, string value)

Parameters

element StyledElement
value string

SetAccessKey(StyledElement, string)

Helper for setting the value of the AccessKeyProperty on a StyledElement.

public static void SetAccessKey(StyledElement element, string value)

Parameters

element StyledElement
value string

SetAccessibilityView(StyledElement, AccessibilityView)

Helper for setting the value of the AccessibilityViewProperty on a StyledElement.

public static void SetAccessibilityView(StyledElement element, AccessibilityView value)

Parameters

element StyledElement
value AccessibilityView

SetAutomationId(StyledElement, string?)

Helper for setting the value of the AutomationIdProperty on a StyledElement.

public static void SetAutomationId(StyledElement element, string? value)

Parameters

element StyledElement
value string

SetControlTypeOverride(StyledElement, AutomationControlType?)

Helper for setting the value of the ControlTypeOverrideProperty on a StyledElement.

public static void SetControlTypeOverride(StyledElement element, AutomationControlType? value)

Parameters

element StyledElement
value AutomationControlType?

SetHelpText(StyledElement, string?)

Helper for setting the value of the HelpTextProperty on a StyledElement.

public static void SetHelpText(StyledElement element, string? value)

Parameters

element StyledElement
value string

SetIsColumnHeader(StyledElement, bool)

Helper for setting the value of the IsColumnHeaderProperty on a StyledElement.

public static void SetIsColumnHeader(StyledElement element, bool value)

Parameters

element StyledElement
value bool

SetIsOffscreenBehavior(StyledElement, IsOffscreenBehavior)

Helper for setting the value of the IsOffscreenBehaviorProperty on a StyledElement.

public static void SetIsOffscreenBehavior(StyledElement element, IsOffscreenBehavior value)

Parameters

element StyledElement
value IsOffscreenBehavior

SetIsRequiredForForm(StyledElement, bool)

Helper for setting the value of the IsRequiredForFormProperty on a StyledElement.

public static void SetIsRequiredForForm(StyledElement element, bool value)

Parameters

element StyledElement
value bool

SetIsRowHeader(StyledElement, bool)

Helper for setting the value of the IsRowHeaderProperty on a StyledElement.

public static void SetIsRowHeader(StyledElement element, bool value)

Parameters

element StyledElement
value bool

SetItemStatus(StyledElement, string?)

Helper for setting the value of the ItemStatusProperty on a StyledElement.

public static void SetItemStatus(StyledElement element, string? value)

Parameters

element StyledElement
value string

SetItemType(StyledElement, string?)

Helper for setting the value of the ItemTypeProperty on a StyledElement.

public static void SetItemType(StyledElement element, string? value)

Parameters

element StyledElement
value string

SetLabeledBy(StyledElement, Control)

Helper for setting the value of the LabeledByProperty on a StyledElement.

public static void SetLabeledBy(StyledElement element, Control value)

Parameters

element StyledElement
value Control

SetLiveSetting(StyledElement, AutomationLiveSetting)

Helper for setting the value of the LiveSettingProperty on a StyledElement.

public static void SetLiveSetting(StyledElement element, AutomationLiveSetting value)

Parameters

element StyledElement
value AutomationLiveSetting

SetName(StyledElement, string?)

Helper for setting the value of the NameProperty on a StyledElement.

public static void SetName(StyledElement element, string? value)

Parameters

element StyledElement
value string

SetPositionInSet(StyledElement, int)

Helper for setting the value of the PositionInSetProperty on a StyledElement.

public static void SetPositionInSet(StyledElement element, int value)

Parameters

element StyledElement
value int

SetSizeOfSet(StyledElement, int)

Helper for setting the value of the SizeOfSetProperty on a StyledElement.

public static void SetSizeOfSet(StyledElement element, int value)

Parameters

element StyledElement
value int