Search results

DocumentEditorContainerModel API in JavaScript (ES5) Document Editor Container API control

Interface for a class DocumentEditorContainer

Properties

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.

beforeXmlHttpRequestSend

EmitType<XmlHttpRequestEventArgs>

This event is triggered 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.

enableComment

boolean

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

enableCsp

boolean

Enable rendering with strict Content Security policy.

enableLocalPaste

boolean

Enable local paste

enableLockAndEdit

boolean

Enable 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 spell checker in document editor container.

enableToolbar

boolean

Enable or disable toolbar in document editor container.

enableTrackChanges

boolean

Enable or disable track changes in document editor container.

headers

any[]

Add custom headers to XMLHttpRequest.

height

string

Defines the height of the DocumentEditorContainer component

layoutType

string

Layout Type

locale

string

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

restrictEditing

boolean

Restrict editing operation.

serverActionSettings

ContainerServerActionSettingsModel

Defines the settings of the DocumentEditorContainer service.

serviceUrl

string

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”. Remarks: 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.