SubDocumentBaseApi Class

Defines a sub-document in a document.

Declaration

export class SubDocumentBaseApi extends SubDocument

Inherited Members

id

interval

length

paragraphs

parentSubDocument

type

deleteText(interval)

getCharacterProperties(interval)

getParagraphProperties(interval)

getText

insertLineBreak(position)

insertParagraph(position)

insertPicture(position, base64)

insertSectionBreak(position, type)

insertText(position, text)

setCharacterProperties(interval, characterProperties)

setParagraphProperties(interval, paragraphProperties)

Inheritance

SubDocument

SubDocumentBaseApi

Properties

bookmarks Property

Provide access to the sub-document’s collection of bookmarks.

Declaration

readonly bookmarks: BookmarkCollectionBase

Property Value

Type	Description
BookmarkCollectionBase	A collection of bookmarks.

fields Property

Provide access to the sub-document’s collection of fields.

Declaration

readonly fields: FieldCollection

Property Value

Type	Description
FieldCollection	A collection of fields.

Remarks

JS

richEdit.document.fields.updateAllFields();

hyperlinks Property

Provide access to the sub-document’s collection of hyperlinks.

Declaration

readonly hyperlinks: HyperlinkCollection

Property Value

Type	Description
HyperlinkCollection	A collection of hyperlinks.

tables Property

Provide access to the sub-document’s collection of tables.

Declaration

readonly tables: TableCollectionBaseApi

Property Value

Type	Description
TableCollectionBaseApi	A collection of tables.