ScreenReaderPositionChangedEventArgs.IsReadingText Property

Definition

Namespace:

Windows.UI.Accessibility

Gets whether a screen reader is currently reading a block of text.

public:
 property bool IsReadingText { bool get(); };

bool IsReadingText();

public bool IsReadingText { get; }

var boolean = screenReaderPositionChangedEventArgs.isReadingText;

Public ReadOnly Property IsReadingText As Boolean

Property Value

Boolean

bool

True if the screen reader is reading text; otherwise, false.

This property is true when reading text and embedded objects continuously from the beginning, or current location, in a document, webpage, or app.

When navigating by a single character or word in a text-based element this property is false.

Remarks

This property is useful in situations where you need to handle the frequent and predictable movement of the screen reader focus. For example, Magnifier smooths the movement of the magnified region by setting its location in anticipation of the movement of the Narrator focus.

Reading with Narrator is initiated through specific key combinations, such as Caps lock + M. While reading text, the need for the user to press other keys and key combinations to navigate through different objects in a document, webpage, or app is eliminated. For a comprehensive list of key combinations that initiate text reading with Narrator, see Reading text.