DocumentEditorModel API in JavaScript DocumentEditor API control

Interface for a class DocumentEditor

Properties

actionComplete

EmitType<CollaborativeEditingEventArgs>

Triggers when the document editor collaborative actions (such as LockContent, SaveContent, UnlockContent) gets completed.

afterFormFieldFill

EmitType<FormFieldFillEventArgs>

Triggers after the form field fill.

beforeAcceptRejectChanges

EmitType<RevisionActionEventArgs>

Triggers before accepting or rejecting changes.

beforeCommentAction

EmitType<CommentActionEventArgs>

Triggers on comment actions(Post, edit, reply, resolve, reopen).

beforeFileOpen

EmitType<BeforeFileOpenArgs>

Triggers before a file is opened.

beforeFormFieldFill

EmitType<FormFieldFillEventArgs>

Triggers before the form field fill.

beforePaneSwitch

EmitType<BeforePaneSwitchEventArgs>

Triggers before opening the comment pane.

commentBegin

EmitType<Object>

Triggers after inserting the comment.

commentDelete

EmitType<CommentDeleteEventArgs>

Triggers after deleting the comment.

commentEnd

EmitType<Object>

Triggers after posting the comment.

contentChange

EmitType<ContentChangeEventArgs>

Triggers whenever the content changes in the document editor.

contentControl

EmitType<Object>

Triggers when user interaction prevented in content control.

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 the document changes in the document editor.

keyDown

EmitType<DocumentEditorKeyDownEventArgs>

Triggers whenever the key is pressed in the document editor.

requestNavigate

EmitType<RequestNavigateEventArgs>

Triggers whenever the 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 the selection changes in the document editor.

serviceFailure

EmitType<ServiceFailureArgs>

Triggers when the server side action fails.

trackChange

EmitType<TrackChangeEventArgs>

Triggers when the trackChanges enabled / disabled.

viewChange

EmitType<ViewChangeEventArgs>

Triggers whenever the container view changes in the document editor.

zoomFactorChange

EmitType<ZoomFactorChangeEventArgs>

Triggers whenever the zoom factor changes in the document editor.

acceptTab

boolean

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

autoResizeOnVisibilityChange

boolean

Gets or sets a value indicating whether to start automatic resize with the specified time interval and iteration count.

• Resize action triggers automatically for the specified number of iterations, or till the parent element’s height and width is non-zero.

• If the parent element’s height and width is zero even in the last iteration, then the default height and width (200) is allocated for the Document editor.

beforeXmlHttpRequestSend

EmitType<XmlHttpRequestEventArgs>

Triggers before a server request is started, allows you to modify the XMLHttpRequest object (setting additional headers, if needed).

currentUser

string

Gets or sets the current user.

defaultPasteOption

PasteOptions

Gets or sets the default Paste Formatting Options

documentEditorSettings

DocumentEditorSettingsModel

Defines the settings for DocumentEditor customization.

documentName

string

Gets or sets the name of the document.

documentSettings

DocumentSettingsModel

Gets the settings and properties of the document that is opened in Document editor component.

enableAutoFocus

boolean

Gets or sets a value indicating whether the automatic focus behavior is enabled for Document editor or not.

By default, the Document editor gets focused automatically when the page loads. If you want the Document editor not to be focused automatically, then set this property to false.

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.

enableColumnsDialog

boolean

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

enableComment

boolean

Gets or sets a value indicating whether comment 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.

enableFootnoteAndEndnoteDialog

boolean

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

enableFormField

boolean

Gets or sets a value indicating whether form fields 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.

enableLockAndEdit

boolean

Enables the partial lock and edit module.

enableOptionsPane

boolean

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

enablePageSetupDialog

boolean

Gets or sets a value indicating whether font 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.

enableTrackChanges

boolean

Gets or sets a value indicating whether track changes is enabled or not

enableWordExport

boolean

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

headers

any[]

Adds the custom headers to XMLHttpRequest.

height

string

Defines the height of the DocumentEditor component.

isReadOnly

boolean

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

layoutType

LayoutType

Gets or sets the Layout Type.

locale

string

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

pageGap

number

Gets or sets the page gap value in document editor.

pageOutline

string

Gets or sets the page outline color.

serverActionSettings

ServerActionSettingsModel

Defines the settings of the DocumentEditor services

serviceUrl

string

Gets or sets the Sfdt Service URL.

showComments

boolean

Shows the comment in the document.

showRevisions

boolean

Shows the revision changes in the document.

useCtrlClickToFollowHyperlink

boolean

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

userColor

string

Gets or sets the color used for highlighting the editable ranges or regions of the currentUser in Document Editor. The default value is “#FFFF00”.

If the visibility of text affected due this highlight color matching with random color applied for the track changes, then modify the color value of this property to resolve text visibility problem.

width

string

Defines the width of the DocumentEditor component.

zIndex

number

Specifies the z-order for rendering that determines whether the dialog is displayed in front or behind of another component.

zoomFactor

number

Gets or sets the zoom factor in document editor.