RichEditDocument Class
Defines a document in the Rich Text Editor.
#Declaration
export class RichEditDocument extends RichEditDocumentBase
#Inherited Members
#Inheritance
#Properties
#bookmarks Property
Provide access to the document’s collection of bookmarks.
#Declaration
get bookmarks(): BookmarkCollectionBase
#Property Value
Type | Description |
---|---|
Bookmark |
A collection of bookmarks. |
#Remarks
#images Property
Provides access to the document’s images.
#Declaration
get 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
get modified(): boolean
set modified(value: boolean)
#Property Value
Type | Description |
---|---|
boolean |
|
#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
get subDocuments(): SubDocumentCollectionBase
#Property Value
Type | Description |
---|---|
Sub |
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 |
---|---|---|
character |
ICharacter |
A Character |
#Remarks
const charProps = richEdit.document.getDefaultCharacterProperties();
charProps.fontName = "Segoe UI";
richEdit.document.setDefaultCharacterProperties(charProps);