Class ScreenReadableData
Definition
Namespace: StardewUI.ModIntegration
Assembly: StardewUI.dll
A screen readable bit of text. Although IScreenReadable is a vanilla interface, it does nothing by itself and will be used with screen reader mods.
Inheritance
Object ⇦ ScreenReadableData
Implements
IScreenReadable
Members
Constructors
| Name | Description |
|---|---|
| ScreenReadableData() | A screen readable bit of text. Although IScreenReadable is a vanilla interface, it does nothing by itself and will be used with screen reader mods. |
Properties
| Name | Description |
|---|---|
| Precedence | How prioritized this screen reader element is. The lowest precedence element will be read, even if the hover path has more specific elements. Custom screen read fields should use negative values. while screen read fields set by the View should have value 0 or greater. |
| ScreenReaderDescription | If set, a translated tooltip-like description for this component which can be displayed by screen readers, in addition to the ScreenReaderText. |
| ScreenReaderIgnore | Whether this is a purely visual component which should be ignored by screen readers. |
| ScreenReaderText | If set, the translated text which represents this component for a screen reader. This may be the displayed text (for a text component), or an equivalent representation (e.g. "exit" for an 'X' button). |
| ScreenReaderTextDelegate | A delegate used to modify |
Details
Constructors
ScreenReadableData()
A screen readable bit of text. Although IScreenReadable is a vanilla interface, it does nothing by itself and will be used with screen reader mods.
Properties
Precedence
How prioritized this screen reader element is. The lowest precedence element will be read, even if the hover path has more specific elements. Custom screen read fields should use negative values. while screen read fields set by the View should have value 0 or greater.
Property Value
ScreenReaderDescription
If set, a translated tooltip-like description for this component which can be displayed by screen readers, in addition to the ScreenReaderText.
Property Value
ScreenReaderIgnore
Whether this is a purely visual component which should be ignored by screen readers.
Property Value
ScreenReaderText
If set, the translated text which represents this component for a screen reader. This may be the displayed text (for a text component), or an equivalent representation (e.g. "exit" for an 'X' button).
Property Value
ScreenReaderTextDelegate
A delegate used to modify