DocumentEditorContainerModel API in JavaScript Document Editor Container API control

Interface for a class DocumentEditorContainer

Properties

beforeAcceptRejectChanges

EmitType<RevisionActionEventArgs>

Triggers before accepting or rejecting changes.

beforeCommentAction

EmitType<CommentActionEventArgs>

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

beforePaneSwitch

EmitType<BeforePaneSwitchEventArgs>

Trigger before switching panes in DocumentEditor.

commentDelete

EmitType<CommentDeleteEventArgs>

Triggers on deleting a comment.

contentChange

EmitType<ContainerContentChangeEventArgs>

Triggers whenever the content changes in the document editor container.

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<ContainerDocumentChangeEventArgs>

Triggers whenever document changes in the document editor container.

selectionChange

EmitType<ContainerSelectionChangeEventArgs>

Triggers whenever selection changes in the document editor container.

serviceFailure

EmitType<ServiceFailureArgs>

Triggers when the server action fails.

toolbarClick

EmitType<ClickEventArgs>

Triggers when toolbar item is clicked.

trackChange

EmitType<TrackChangeEventArgs>

Triggers Keyboard shortcut of TrackChanges.

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.

documentEditorSettings

DocumentEditorSettingsModel

Defines the settings for DocumentEditor customization.

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.

enableComment

boolean

Gets or sets a value indicating whether comment is enabled or not

enableCsp

boolean

Enables the rendering with strict Content Security policy.

enableLocalPaste

boolean

Enables the local paste.

enableLockAndEdit

boolean

Enables the partial lock and edit module.

enablePersistence

boolean

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

enableRtl

boolean

Enable or disable rendering component in right to left direction.

enableSpellCheck

boolean

Enable or disable the spell checker in document editor container.

enableToolbar

boolean

Enable or disable the toolbar in document editor container.

enableTrackChanges

boolean

Enable or disable the track changes in document editor container.

headers

object[]

Adds the custom headers to XMLHttpRequest.

height

string

Defines the height of the DocumentEditorContainer component

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’.

restrictEditing

boolean

Specifies the restrict editing operation.

serverActionSettings

ContainerServerActionSettingsModel

Defines the settings of the DocumentEditorContainer service.

serviceUrl

string

Gets or sets the Sfdt service URL.

showPropertiesPane

boolean

Show or hide properties pane.

toolbarItems

[]

Defines toolbar items for DocumentEditorContainer.

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 DocumentEditorContainer component

zIndex

number

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