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

IAccessibilityNotificationDispatcher.SendPageScrolledAnnouncement

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

Declaration

public void SendPageScrolledAnnouncement(string announcement, Accessibility.AccessibilityNode nodeToFocus);

Parameters

Parameter Description
announcement Text that describes the new scroll position. For example, "Tab 3 of 5" or "Page 19 of 27". This text is read by the screen reader after processing the notification.
nodeToFocus An optional node to be focused by the screen reader after processing the notification.

Description

Notifies the screen reader that a scrolling action completed and optionally requests it to move its focus to a given accessibility node.


Call this method after responding to the AccessibilityNode.scrolled event to provide the user with information about the contents of the screen after they performed a scroll gesture, and to update the screen reader focus accordingly. For example, to move it off an accessibility node that may have been scrolled out of the screen.

On iOS, if this method is repeatedly called with the same text, the screen reader indicates to the user that scrolling cannot continue due to a border or boundary.