RichTextDocument | WebHare Platform SDK

Class RichTextDocument

A Rich Text Document (RTD)

Index

Constructors

Accessors

Methods

__getRawHTML __hintImageId __hintInstanceId addBlock addBlocks addList export isEmpty

Constructors

constructor

new RichTextDocument(): RichTextDocument
Returns RichTextDocument
- Defined in jssdk/services/src/richdocument.ts:336

Accessors

blocks

get blocks(): RTDBlock[]
Returns RTDBlock[]
- Defined in jssdk/services/src/richdocument.ts:331

Methods

__getRawHTML

__getRawHTML(): Promise<string>
Returns Promise<string>
Deprecated
Use exportRTDToRawHTML in hscompat
- Defined in jssdk/services/src/richdocument.ts:594

__hintImageId

__hintImageId(image: RTDBaseInlineImageItem<"inMemory">, imageId: string): void
Parameters
- image: RTDBaseInlineImageItem<"inMemory">
- imageId: string
Returns void
- Defined in jssdk/services/src/richdocument.ts:602

__hintInstanceId

__hintInstanceId(widget: Instance, instanceId: string): void
Parameters
- widget: Instance
- instanceId: string
Returns void
- Defined in jssdk/services/src/richdocument.ts:598

addBlock

addBlock(
    tag: string,
    className: undefined | string,
    items?: RTDSourceInlineItems,
    options?: ImportOptions,
): Promise<void>
Parameters
- tag: string
- className: undefined | string
- Optionalitems: RTDSourceInlineItems
- Optionaloptions: ImportOptions
Returns Promise<void>
- Defined in jssdk/services/src/richdocument.ts:437

addBlocks

addBlocks(blocks: RTDSourceBlock[], options?: ImportOptions): Promise<void>
Parameters
- blocks: RTDSourceBlock[]
- Optionaloptions: ImportOptions
Returns Promise<void>
- Defined in jssdk/services/src/richdocument.ts:482

addList

addList(
    tag: string,
    className: undefined | string,
    listItems: RTDSourceListItems,
    options?: ImportOptions,
): Promise<void>
Parameters
- tag: string
- className: undefined | string
- listItems: RTDSourceListItems
- Optionaloptions: ImportOptions
Returns Promise<void>
- Defined in jssdk/services/src/richdocument.ts:467

export

export(options?: ExportOptions): Promise<RTDExport>
Export as buildable RTD
Parameters
- Optionaloptions: ExportOptions
Returns Promise<RTDExport>
- Defined in jssdk/services/src/richdocument.ts:589

isEmpty

isEmpty(): boolean
Returns boolean
- Defined in jssdk/services/src/richdocument.ts:339