Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


AccessibilityNode

An instance of a node in the AccessibilityHierarchy, representing an element in the UI that the screen reader can read, focus, and execute actions on.
Read time 2 minutesLast updated 17 days ago

Definition

public class AccessibilityNode

Properties

Property

Description

allowsDirectInteractionWhether this node allows direct touch interaction for users.
childrenThe children nodes of the node.
frameThe Rect represents the position in screen coordinates of the node in the UI. This can be set directly but it is recommended that AccessibilityNode.frameGetter is set instead, so that the value can be recalculated when necessary.
frameGetterOptional delegate that can be set to calculate the AccessibilityNode.frame for the node instead of setting a flat value. If the frame of the node may change over time, this delegate should be set instead of giving a one time value for the AccessibilityNode.frame.
hintProvides additional information about the accessibility node. For example, the result of performing an action on the node.
idThe ID of this node.
isActiveWhether this node is active in the hierarchy. The default value is
true
.
isFocusedWhether the node is focused by the screen reader.
labelA string value that succinctly describes this node. The AccessibilityNode.label is the first thing read by the screen reader when a node is focused.
parentThe parent of the node. If the node is at the root level, the AccessibilityNode.parent value is
null
.
roleThe role for the node.
stateThe state for the node.
valueThe value of this node.

Methods

Method

Description

GetHashCodeA hash used for comparisons.
ToStringProvides a debugging string.

Events

Member

Description

decrementedCalled when the user of the screen reader decrements the content of the node.
dismissedCalled when the user of the screen reader dismisses this node.
focusChangedCalled when the node gains or loses screen reader focus.
incrementedCalled when the user of the screen reader increments the content of the node.
selectedCalled when the user of the screen reader selects this node.