Class AccessibleObject

Definition

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

It's a base abstract class for Widget. It provides the available definitions for the screen reader, such as Name, Description, ReadingInfoType, etc. There are many relationships between two accessible objects, like ChildOf, ParentOf, FlowsTo, FlowsFrom, etc.

C#
Copy
public abstract class AccessibleObject : EvasObject, IAccessibleObject
Inheritance
AccessibleObject
Derived
Implements

Constructors

View Source

AccessibleObject()

Creates and initializes a new instance of the AccessibleObject class.

Declaration
C#
Copy
protected AccessibleObject()
API Level: preview
View Source

AccessibleObject(EvasObject)

Creates and initializes a new instance of the AccessibleObject class with the parent EvasObject class parameter.

Declaration
C#
Copy
protected AccessibleObject(EvasObject parent)
Parameters
Type Name Description
EvasObject parent

Parent EvasObject class.

API Level: preview

Methods

View Source

Highlight()

Highlights the accessible widget.

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

Unhighlight()

Clears the highlight of the accessible widget.

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

Explicit Interface Implementations

View Source

IAccessibleObject.AppendRelation(IAccessibleRelation)

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

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

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

View Source

IAccessibleObject.CanHighlight

Gets or sets the highlightable of a given widget.

Declaration
C#
Copy
bool IAccessibleObject.CanHighlight { get; set; }
Returns
Type Description
Boolean
View Source

IAccessibleObject.Description

Gets or sets the contextual information about an object.

Declaration
C#
Copy
string IAccessibleObject.Description { get; set; }
Returns
Type Description
System.String
View Source

IAccessibleObject.DescriptionProvider

Gets or sets the delegate for Description.

Declaration
C#
Copy
AccessibleInfoProvider IAccessibleObject.DescriptionProvider { get; set; }
Returns
Type Description
AccessibleInfoProvider
View Source

IAccessibleObject.Name

Gets or sets an accessible name of the object.

Declaration
C#
Copy
string IAccessibleObject.Name { get; set; }
Returns
Type Description
System.String
View Source

IAccessibleObject.NameProvider

Gets or sets the delegate for Name.

Declaration
C#
Copy
AccessibleInfoProvider IAccessibleObject.NameProvider { get; set; }
Returns
Type Description
AccessibleInfoProvider
View Source

IAccessibleObject.ReadingInfoType

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

Declaration
C#
Copy
ReadingInfoType IAccessibleObject.ReadingInfoType { get; set; }
Returns
Type Description
ReadingInfoType
View Source

IAccessibleObject.RemoveRelation(IAccessibleRelation)

Removes the relationship between two accessible objects.

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

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

View Source

IAccessibleObject.Role

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

Declaration
C#
Copy
AccessRole IAccessibleObject.Role { get; set; }
Returns
Type Description
AccessRole
View Source

IAccessibleObject.TranslationDomain

Gets or sets the translation domain of the "name" and "description" properties. The 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 developers responsibility to ensure that translation files are loaded and binded to the translation domain when accessibility is enabled.

Declaration
C#
Copy
string IAccessibleObject.TranslationDomain { get; set; }
Returns
Type Description
System.String

Implements

Extension Methods