Class RichTextDocument
Index
Constructors
Accessors
Methods
Constructors
constructor
Returns RichTextDocument
Methods
__ hint Image Id
Parameters
- image: RTDBaseInlineImageItem<"inMemory">
- imageId: string
Returns void
__ hint Instance Id
Parameters
- widget: Instance
- instanceId: string
Returns void
add Blocks
Parameters
- blocks: RTDSourceBlock[]
Optionaloptions: ImportOptions
Returns Promise<void>
build Blocks
Parameters
- inBlocks: RTDSourceBlock[]
Optionaloptions: ImportOptions
Returns Promise<RTDBlock[]>
export
get Excerpt
Returns plain text with blocks separated by linefeeds and whitespace within each block collapsed to single spaces. Includes table captions and cells, but omits images and widgets.
Parameters
Optionaloptions: { maxLength?: number }OptionalmaxLength?: numberMaximum string length (UTF-16 code units), without an ellipsis. Must be a non-negative safe integer. If omitted, returns all text. Truncation never splits a surrogate pair.
Returns string
is Empty
Returns boolean
A Rich Text Document (RTD)