Search results

DocumentEditorComponent

Represents the Essential JS 2 VueJS Document Editor Component

<ejs-documenteditor id='container'></ejs-documenteditor>

Properties

acceptTab

boolean

Gets or Sets a value indicating whether tab key can be accepted as input or not.

contextMenu

ContextMenu

Gets the context menu object of the document editor.

currentUser

string

Current User

defaultPasteOption

string

Default Paste Formatting Options

documentName

string

Gets or sets the name of the document.

editor

Editor

Gets the editor object of the document editor.

editorHistory

EditorHistory

Gets the editor history object of the document editor.

enableBookmarkDialog

boolean

Gets or sets a value indicating whether bookmark dialog is enabled or not.

enableBordersAndShadingDialog

boolean

Gets or sets a value indicating whether borders and shading dialog is enabled or not.

enableContextMenu

boolean

Gets or sets a value indicating whether context menu is enabled or not.

enableCursorOnReadOnly

boolean

Gets or sets a value indicating whether to enable cursor in document editor on read only state or not. The default value is false.

enableEditor

boolean

Gets or sets a value indicating whether editor needs to be enabled or not.

enableEditorHistory

boolean

Gets or sets a value indicating whether editor history needs to be enabled or not.

enableFontDialog

boolean

Gets or sets a value indicating whether font dialog is enabled or not.

enableHyperlinkDialog

boolean

Gets or sets a value indicating whether hyperlink dialog is enabled or not.

enableImageResizer

boolean

Gets or sets a value indicating whether image resizer is enabled or not.

enableListDialog

boolean

Gets or sets a value indicating whether list dialog is enabled or not.

enableLocalPaste

boolean

Gets or sets a value indicating whether local paste needs to be enabled or not.

enableOptionsPane

boolean

Gets or sets a value indicating whether options pane is enabled or not.

enablePageSetupDialog

boolean

Gets or sets a value indicating whether margin dialog is enabled or not.

enableParagraphDialog

boolean

Gets or sets a value indicating whether paragraph dialog is enabled or not.

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

enablePrint

boolean

Gets or sets a value indicating whether print needs to be enabled or not.

enableRtl

boolean

Enable or disable rendering component in right to left direction.

enableSearch

boolean

Gets or sets a value indicating whether search module is enabled or not.

enableSelection

boolean

Gets or sets a value indicating whether selection needs to be enabled or not.

enableSfdtExport

boolean

Gets or sets a value indicating whether Sfdt export needs to be enabled or not.

enableSpellCheck

boolean

Gets or sets a value indicating whether editor need to be spell checked.

enableStyleDialog

boolean

Gets or sets a value indicating whether font dialog is enabled or not.

enableTableDialog

boolean

Gets or sets a value indicating whether table dialog is enabled or not.

enableTableOfContentsDialog

boolean

Gets or sets a value indicating whether table of contents dialog is enabled or not.

enableTableOptionsDialog

boolean

Gets or sets a value indicating whether table options dialog is enabled or not.

enableTablePropertiesDialog

boolean

Gets or sets a value indicating whether table properties dialog is enabled or not.

enableTextExport

boolean

Gets or sets a value indicating whether text export needs to be enabled or not.

enableWordExport

boolean

Gets or sets a value indicating whether word export needs to be enabled or not.

isReadOnly

boolean

Gets or sets a value indicating whether the document editor is in read only state or not.

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

pageCount

number

Gets the total number of pages.

pageGap

number

Gets or sets the page gap value in document editor

pageOutline

string

Gets or sets the page outline color.

Gets the search object of the document editor.

selection

Selection

Gets the selection object of the document editor.

serverActionSettings

ServerActionSettingsModel

Defines the settings of the DocumentEditor services

serviceUrl

string

Sfdt Service URL

spellCheckDialog

SpellCheckDialog

Gets the spell check dialog object of the document editor.

spellChecker

SpellChecker

Gets the spell check object of the document editor.

Gets or Sets a value indicating whether holding Ctrl key is required to follow hyperlink on click. The default value is true.

userColor

string

User Selection Highlight Color

zoomFactor

number

Gets or sets the zoom factor in document editor.

Methods

destroy

Destroys all managed resources used by this object.

Returns void

enableAllModules

Enables all the modules.

Returns void

fitPage

Fits the page based on given fit type.

Returns void

focusIn

Shifts the focus to the document.

Returns void

getBookmarks

Gets the bookmarks.

Returns string[]

getStyleNames

Gets the style names based on given style type.

Parameter Type Description
styleType (optional) string

Returns string[]

getStyles

Gets the style objects on given style type.

Parameter Type Description
styleType (optional) string

Returns Object[]

open

Opens the given Sfdt text.

Returns void

openBlank

Opens a blank document.

Returns void

print

Prints the document.

Returns void

resize

Resizes the component and its sub elements based on given size or container size.

Returns void

save

Saves the document.

Returns void

saveAsBlob

Saves the document as blob.

Parameter Type Description
formatType (optional) string

Returns Promise

scrollToPage

Scrolls view to start of the given page number if exists.

Returns boolean

serialize

Serialize the data to JSON string.

Returns string

setDefaultCharacterFormat

Set the default character format for document editor

Parameter Type Description
characterFormat CharacterFormatProperties

Returns void

setDefaultParagraphFormat

Set the default paragraph format for document editor

Parameter Type Description
paragraphFormat ParagraphFormatProperties

Returns void

showDialog

Shows the dialog.

Returns void

showOptionsPane

Shows the options pane.

Returns void

Events

contentChange

EmitType<ContentChangeEventArgs>

Triggers whenever content changes in the document editor.

created

EmitType<Object>

Triggers when the component is created

customContextMenuBeforeOpen

EmitType<BeforeOpenCloseCustomContentMenuEventArgs>

Triggers before opening the custom context-menu option.

customContextMenuSelect

EmitType<CustomContentMenuEventArgs>

Triggers while selecting the custom context-menu option.

destroyed

EmitType<Object>

Triggers when the component is destroyed.

documentChange

EmitType<DocumentChangeEventArgs>

Triggers whenever document changes in the document editor.

keyDown

EmitType<DocumentEditorKeyDownEventArgs>

Triggers whenever key is pressed in the document editor.

requestNavigate

EmitType<RequestNavigateEventArgs>

Triggers whenever hyperlink is clicked or tapped in the document editor.

searchResultsChange

EmitType<SearchResultsChangeEventArgs>

Triggers whenever search results changes in the document editor.

selectionChange

EmitType<SelectionChangeEventArgs>

Triggers whenever selection changes in the document editor.

viewChange

EmitType<ViewChangeEventArgs>

Triggers whenever container view changes in the document editor.

zoomFactorChange

EmitType<ZoomFactorChangeEventArgs>

Triggers whenever zoom factor changes in the document editor.