8.8 released—CSS Media Query support, SF Symbols and much more...
Learn more
FormattedString
A class used to create a formatted (rich text) string.

Summary

Constructors

constructor

Properties

backgroundColor
color
fontFamily
fontSize
fontStyle
fontWeight
iosAccessibilityAdjustsFontSize
iosAccessibilityMaxFontScale
iosAccessibilityMinFontScale
spans
textDecoration

Methods

toString

Constructors

constructor

new FormattedString(): FormattedString

Properties

backgroundColor

backgroundColor: Color
Gets or sets the font background color which will be used for all spans that doesn't have a specific value.

color

color: Color
Gets or sets the font foreground color which will be used for all spans that doesn't have a specific value.

fontFamily

fontFamily: string
Gets or sets the font family which will be used for all spans that doesn't have a specific value.

fontSize

fontSize: number
Gets or sets the font size which will be used for all spans that doesn't have a specific value.

fontStyle

fontStyle: FontStyleType
Gets or sets the font style which will be used for all spans that doesn't have a specific value.

fontWeight

fontWeight: FontWeightType
Gets or sets the font weight which will be used for all spans that doesn't have a specific value.

iosAccessibilityAdjustsFontSize

iosAccessibilityAdjustsFontSize: boolean
Defines whether accessibility font scale should affect font size.

iosAccessibilityMaxFontScale

iosAccessibilityMaxFontScale: number
Gets or sets the maximum accessibility font scale.

iosAccessibilityMinFontScale

iosAccessibilityMinFontScale: number
Gets or sets the minimum accessibility font scale.

spans

An observable collection of Span objects used to define common text properties.

textDecoration

textDecoration: TextDecorationType
Gets or sets text decorations which will be used for all spans that doesn't have a specific value.

Methods

toString

toString(): string
A human readable representation of the formatted string.
Returns string
Previous
Font
Next
Frame