Schema Explorer
RichTextBlock
Defines an array of inlines, allowing for inline text formatting.
Introduced in version 1.2
Property | Type | Required | Description | Version |
---|---|---|---|---|
type | "RichTextBlock" |
Yes | Must be "RichTextBlock" . |
1.2 |
inlines | Inline[] |
Yes | The array of inlines. | 1.2 |
horizontalAlignment | HorizontalAlignment |
No | Controls the horizontal text alignment. | 1.2 |
Inherited properties
Property | Type | Required | Description | Version |
---|---|---|---|---|
fallback | Element , FallbackOption |
No | Describes what to do when an unknown element is encountered or the requires of this or any children can’t be met. | 1.2 |
height | BlockElementHeight |
No | Specifies the height of the element. | 1.1 |
separator | boolean |
No | When true , draw a separating line at the top of the element. |
1.2 |
spacing | Spacing |
No | Controls the amount of spacing between this element and the preceding element. | 1.2 |
id | string |
No | A unique identifier associated with the item. | 1.2 |
isVisible | boolean |
No, default: true |
If false , this item will be removed from the visual tree. |
1.2 |
requires | Dictionary<string> |
No | A series of key/value pairs indicating features that the item requires with corresponding minimum version. When a feature is missing or of insufficient version, fallback is triggered. | 1.2 |
Example
Properties
inlines
The array of inlines.
- Type:
Inline[]
- Required: Yes
- Allowed values:
TextRun
string
horizontalAlignment
Controls the horizontal text alignment.
- Type:
HorizontalAlignment
- Required: No
- Allowed values:
"left"
"center"
"right"
fallback
Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
- Type:
Element
,FallbackOption
- Required: No
- Allowed values:
ActionSet
ColumnSet
Container
FactSet
Image
ImageSet
Input.ChoiceSet
Input.Date
Input.Number
Input.Text
Input.Time
Input.Toggle
Media
RichTextBlock
TextBlock
"drop"
: Causes this element to be dropped immediately when unknown elements are encountered. The unknown element doesn't bubble up any higher.
height
Specifies the height of the element.
- Type:
BlockElementHeight
- Version : 1.1
- Required: No
- Allowed values:
"auto"
: The height of the container will be determined by the height of its contents."stretch"
: The container will stretch its height to the available remaining height of the parent container.
separator
When true
, draw a separating line at the top of the element.
- Type:
boolean
- Required: No
spacing
Controls the amount of spacing between this element and the preceding element.
- Type:
Spacing
- Required: No
- Allowed values:
"default"
"none"
"small"
"medium"
"large"
"extraLarge"
"padding"
id
A unique identifier associated with the item.
- Type:
string
- Required: No
isVisible
If false
, this item will be removed from the visual tree.
- Type:
boolean
- Required: No, default:
true
requires
A series of key/value pairs indicating features that the item requires with corresponding minimum version. When a feature is missing or of insufficient version, fallback is triggered.
- Type:
Dictionary<string>
- Required: No