RichEditDocument Class

Defines a document in the Rich Text Editor.

Declaration

export class RichEditDocument extends RichEditDocumentBase

Inherited Members

fields

fonts

hyperlinks

interval

isProtected

length

lists

paragraphs

rangePermissions

sections

tables

checkProtectionPassword(password)

deleteText(interval)

getCharacterProperties(interval)

getDefaultCharacterProperties

getParagraphProperties(interval)

getText

insertColumnBreak(position)

insertLineBreak(position)

insertPageBreak(position)

insertParagraph(position)

insertPicture(position, base64)

insertSectionBreak(position, type)

insertText(position, text)

protect(password)

setCharacterProperties(interval, characterProperties)

setParagraphProperties(interval, paragraphProperties)

unprotect

Inheritance

RichEditDocumentBase

RichEditDocument

Properties

bookmarks Property

Provide access to the document’s collection of bookmarks.

Declaration

readonly bookmarks: BookmarkCollectionBase

Property Value

Type	Description
BookmarkCollectionBase	A collection of bookmarks.

Remarks

JS

var bookmark = richEdit.document.bookmarks.find('bookmarkName')[0];
if (bookmark)
    bookmark.goTo();

images Property

Provides access to the document’s images.

Declaration

readonly images: Images

Property Value

Type	Description
Images	An object that allows you to manage document images.

modified Property

Specifies whether the document has unsaved changes.

Declaration

modified: boolean

Property Value

Type	Description
boolean	true if the document has unsaved changes; otherwise, false.

Remarks

It is not possible to set the modified property to true to mark the document as modified. You can use the hasUnsavedChanges property to specify the Save button availability.

subDocuments Property

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

Declaration

readonly subDocuments: SubDocumentCollectionBase

Property Value

Type	Description
SubDocumentCollectionBase	A collection of sub-documents.

Methods

setDefaultCharacterProperties(characterProperties) Method

Sets the document’s default character properties.

Declaration

setDefaultCharacterProperties(
    characterProperties: ICharacterProperties
): void

Parameters

Name	Type	Description
characterProperties	ICharacterProperties	A CharacterProperties object that implements the ICharacterProperties interface and contains character properties.

Remarks

JS

const charProps = richEdit.document.getDefaultCharacterProperties();
charProps.fontName = "Segoe UI";
richEdit.document.setDefaultCharacterProperties(charProps);