DocumentEditorContainer

Document Editor container component.

Properties

currentUser

string

Current User

Defaults to ”

documentEditorSettings

DocumentEditorSettingsModel

Defines the settings for DocumentEditor customization.

Defaults to {}

enableComment

boolean

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

Defaults to true

enableCsp

boolean

Enable rendering with strict Content Security policy.

enableLocalPaste

boolean

Enable local paste

Defaults to false

enableLockAndEdit

boolean

Enable partial lock and edit module.

Defaults to false

enablePersistence

boolean

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

Defaults to false

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

enableSpellCheck

boolean

Enable or disable spell checker in document editor container.

Defaults to false

enableToolbar

boolean

Enable or disable toolbar in document editor container.

Defaults to true

enableTrackChanges

boolean

Enable or disable track changes in document editor container.

Defaults to false

headers

any[]

Add custom headers to XMLHttpRequest.

Defaults to []

height

string

Defines the height of the DocumentEditorContainer component

Defaults to ‘320px’

layoutType

string

Layout Type

Defaults to Pages

locale

string

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

Defaults to ”

restrictEditing

boolean

Restrict editing operation.

Defaults to false

serverActionSettings

ContainerServerActionSettingsModel

Defines the settings of the DocumentEditorContainer service.

serviceUrl

string

Sfdt service URL.

Defaults to ”

showPropertiesPane

boolean

Show or hide properties pane.

Defaults to true

toolbarItems

[]

Defines toolbar items for DocumentEditorContainer.

Defaults to [‘New’,‘Open’,‘Separator’,‘Undo’,‘Redo’,‘Separator’,‘Image’,‘Table’,‘Hyperlink’,‘Bookmark’,‘TableOfContents’,‘Separator’,‘Header’,‘Footer’,‘PageSetup’,‘PageNumber’,‘Break’,‘Separator’,‘Find’,‘Separator’,‘Comments’,‘TrackChanges’,‘LocalClipboard’,‘RestrictEditing’,‘Separator’,‘FormFields’]

userColor

string

User Selection Highlight Color

Defaults to ‘#FFFF00’

width

string

Defines the width of the DocumentEditorContainer component

Defaults to ‘100%’

zIndex

number

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

Defaults to 2000

documentEditor DocumentEditor

Gets DocumentEditor instance.

toolbar Toolbar

Gets toolbar instance.

Methods

addEventListener

Adds the handler to the given event listener.

Returns void

appendTo

Appends the control within the given HTML element

Parameter	Type	Description
selector (optional)	string | HTMLElement	Target element where control needs to be appended

Returns void

dataBind

When invoked, applies the pending property changes immediately to the component.

Returns void

destroy

Destroys all managed resources used by this object.

Returns void

getLocalData

Returns the persistence data for component

Returns any

getRootElement

Returns the route element of the component

Returns HTMLElement

refresh

Applies all the pending property changes and render the component again.

Returns void

removeEventListener

Removes the handler from the given event listener.

Returns void

resize

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

Returns void

setDefaultCharacterFormat

Set the default character format for document editor container

Parameter	Type	Description
characterFormat	CharacterFormatProperties

Returns void

setDefaultParagraphFormat

Set the default paragraph format for document editor container

Parameter	Type	Description
paragraphFormat	ParagraphFormatProperties

Returns void

setDefaultSectionFormat

Set the default section format for document editor container

Parameter	Type	Description
sectionFormat	SectionFormatProperties

Returns void

Inject

Dynamically injects the required modules to the component.

Returns void

Events

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.