LiveTextBlock Class

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.PlatformUI
Assembly:
Microsoft.VisualStudio.Shell.15.0.dll
Package:
Microsoft.VisualStudio.Shell.15.0 v17.11.40262

A text block designed for supporting live region accessiblity text. The default live setting is Polite.

public ref class LiveTextBlock : System::Windows::Controls::TextBlock
public class LiveTextBlock : System.Windows.Controls.TextBlock
type LiveTextBlock = class
    inherit TextBlock
Public Class LiveTextBlock
Inherits TextBlock
Inheritance
TextBlock
LiveTextBlock

Examples

<LiveTextBlock Text="Text to display and read" />

<LiveTextBlock Text="Text to display" LiveText="Text to read" />

Constructors

LiveTextBlock()

Initializes a new instance of the LiveTextBlock class.

Fields

FrequencyProperty

This custom property specifies how frequently (in # of reads/sec) a rate limited LiveRegionChanged event is raised. This is useful for chatty LiveTextBlocks, where raising too many change events triggers double/triple reads of the same text.
IsFrequencyLimitedProperty

This custom property specifies that the LiveTextBlock should limit how frequently a LiveRegionChanged event is raised. This is useful for chatty LiveTextBlocks, where raising too many change events triggers double/triple reads of the same text.
LiveTextProperty

This custom property specifies the text the screen reader will actually read. Under the covers the LiveText property is bound to the Text property so nothing special needs to be done to make sure the screen reader can find the right text to read, but only the LiveText sends a notification that the live region value changed.

Properties

Frequency

Gets or sets how frequently LiveRegionChanged events are raised in response to changes to the LiveText property. This value is only used if IsFrequencyLimited is set to true. The default value is 1, i.e. by default if frequency limiting is enabled, the LiveTextBlock will never announce the LiveText more than once per second.
IsFrequencyLimited

Gets or sets if the LiveRegionChanged events should be restricted with respect to how frequently they are sent when the LiveText changes. The default value is false, i.e. by default one LiveRegionChanged event will be raised for every LiveText change even if multiple LiveText changes occur per second. When this setting is enabled, the value of Frequency controls how frequently the LiveRegionChanged event is raised.
LiveText

Methods

OnCreateAutomationPeer()

Applies to