Interface IAccessibleObject

Definition

Namespace:
ElmSharp.Accessible
Assembly:
ElmSharp.dll
API Level:
preview

IAccessibleObject is an interface, which defines the properties and methods of an accessible object.

C#
Copy
public interface IAccessibleObject

Properties

View Source

CanHighlight

Gets or sets the highlightable of the given widget.

Declaration
C#
Copy
bool CanHighlight { get; set; }
Property Value
Type Description
Boolean
API Level: preview
View Source

Description

Gets or sets contextual information about the object.

Declaration
C#
Copy
string Description { get; set; }
Property Value
Type Description
System.String
API Level: preview
View Source

DescriptionProvider

Gets or sets the delegate for Description.

Declaration
C#
Copy
AccessibleInfoProvider DescriptionProvider { get; set; }
Property Value
Type Description
AccessibleInfoProvider
API Level: preview
View Source

Name

Gets or sets an accessible name of the object.

Declaration
C#
Copy
string Name { get; set; }
Property Value
Type Description
System.String
API Level: preview
View Source

NameProvider

Gets or sets the delegate for Name.

Declaration
C#
Copy
AccessibleInfoProvider NameProvider { get; set; }
Property Value
Type Description
AccessibleInfoProvider
API Level: preview
View Source

ReadingInfoType

Gets or sets the reading information types of an accessible object.

Declaration
C#
Copy
ReadingInfoType ReadingInfoType { get; set; }
Property Value
Type Description
ReadingInfoType
API Level: preview
View Source

Role

Gets or sets the role of the object in an accessibility domain.

Declaration
C#
Copy
AccessRole Role { get; set; }
Property Value
Type Description
AccessRole
API Level: preview
View Source

TranslationDomain

Gets or sets the translation domain of the "name" and "description" properties. Translation domain should be set if the application wants to support i18n for accessing the "name" and "description" properties. When the translation domain is set, values of the "name" and "description" properties will be translated with dgettext function using the current translation domain as "domainname" parameter. It is the application developer's responsibility to ensure that translation files are loaded and binded to the translation domain when accessibility is enabled.

Declaration
C#
Copy
string TranslationDomain { get; set; }
Property Value
Type Description
System.String
API Level: preview

Methods

View Source

AppendRelation(IAccessibleRelation)

Defines the relationship between two accessible objects. Relationships can be queried by Assistive Technology clients to provide customized feedback, improving overall user experience. AppendRelation API is asymmetric, which means that appending (For example, relation FlowsTo from object A to B) do not append relation FlowsFrom from object B to object A.

Declaration
C#
Copy
void AppendRelation(IAccessibleRelation relation)
Parameters
Type Name Description
IAccessibleRelation relation

The relationship between the source object and target object of a given type.

API Level: preview
View Source

Highlight()

Highlights the accessible widget.

Declaration
C#
Copy
void Highlight()
API Level: preview
View Source

RemoveRelation(IAccessibleRelation)

Removes the relationship between two accessible objects.

Declaration
C#
Copy
void RemoveRelation(IAccessibleRelation relation)
Parameters
Type Name Description
IAccessibleRelation relation

The relationship between the source object and target object of a given type.

API Level: preview
View Source

Unhighlight()

Clears the highlight of the accessible widget.

Declaration
C#
Copy
void Unhighlight()
API Level: preview