Version: Unity 6.3 Beta (6000.3)
LanguageEnglish
  • C#

AssistiveSupport.activeHierarchy

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static Accessibility.AccessibilityHierarchy activeHierarchy;

Description

The accessibility hierarchy that is currently accessible to screen readers.


An active AccessibilityHierarchy is required to make the content of an application accessible to screen reader users.

To manage system resources efficiently, setting this property only takes effect if the screen reader is on, where the value of AssistiveSupport.isScreenReaderEnabled is true. Similarly, when the screen reader is turned off, so when the AssistiveSupport.screenReaderStatusChanged event is sent with a false parameter or when AssistiveSupport.screenReaderStatusOverride is set to AssistiveSupport.ScreenReaderStatusOverride.ForceDisabled, this property is automatically set to null. You must set it each time the screen reader is turned on.

When this property is set, Unity notifies the screen reader of the new hierarchy by calling IAccessibilityNotificationDispatcher.SendScreenChanged (with a null parameter).