Announce Method, SftTree Object
Announces short status text to attached screen readers via a UIA live region.
Syntax
| VB.NET | object.Announce(Text As String, Kind As SftTreeAnnounceConstants, Assertive As Boolean) |
| VB | object.Announce(Text As String, Kind As SftTreeAnnounceConstants, Assertive As Boolean) |
| C#.NET | void object.Announce(string Text, SftTreeAnnounceConstants Kind, bool Assertive); |
| VC++ | HRESULT object->Announce(_bstr_t Text, enum SftTreeAnnounceConstants Kind, VARIANT_BOOL Assertive); |
| C | HRESULT object->Announce(BSTR Text, enum SftTreeAnnounceConstants Kind, VARIANT_BOOL Assertive); |
object
A SftTree object.
Text
The status text to announce. An empty string is ignored.
Kind
The kind of announcement.
Assertive
Defines whether the announcement is delivered assertively.
| Boolean | Description |
|---|
| True | The announcement is delivered even if it would normally be dropped. |
| False | The announcement uses the default delivery for its kind. |
Comments
The Announce method announces short status text to attached screen readers via a UIA live region.
The text is delivered to attached screen readers (Narrator, NVDA, JAWS) as a live-region notification. It has no visual effect and is a no-op when no assistive technology is listening or when Text is empty.
See Also SftTree Object | Object Hierarchy | Accessibility (Screen Readers)
On
Off