HeaderPane
Main
Hide
Share Link
Print

Announce Method, SftTree Class

Announces a status message to screen readers.

Class: SftTree
Namespace: Softelvdm.SftTreeNET
Assembly: Softelvdm.SftTreeNET

Syntax

public void Announce( string text );
public void Announce( string text, AnnounceKindEnum kind, bool assertive );
Public Sub Announce( ByVal text As String )
Public Sub Announce( ByVal text As String, ByVal kind As AnnounceKindEnum, ByVal assertive As Boolean )

Parameters

text

The message.

kind

The kind of message. The default is AnnounceKindEnum.Info.

assertive

True to interrupt the screen reader, False to let it finish what it is reading. The default is False.

Comments

Announces a status message to screen readers.

Use the Announce method for short messages about changes that are not otherwise visible to screen reader users, such as "3 rows added", "Filter cleared" or "Saved".

The message is sent as a UI Automation notification. It is ignored if no screen reader or other UI Automation client is running, if the control has no window yet, and on Windows versions before Windows 10 version 1709.

See Also SftTree Class | Classes | SftTree/NET 3.0