Represents the Essential JS 2 VueJS Document Editor Container
<ejs-documenteditor-container id='container'></ejs-documenteditor-container> 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.
Defaults to false
EmitType<XmlHttpRequestEventArgs>
Triggers before a server request is started, allows you to modify the XMLHttpRequest object (setting additional headers, if needed).
string
Gets or sets the current user.
Defaults to ”
Gets the DocumentEditor instance.
Defines the settings for DocumentEditor customization.
Defaults to {}
Gets the settings and properties of the document that is opened in Document editor component.
Defaults to {}
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.
Defaults to true
boolean
Gets or sets a value indicating whether comment is enabled or not
Defaults to true
boolean
Enables the rendering with strict Content Security policy.
boolean
Enables the local paste.
Defaults to false
boolean
Enables the partial lock and edit module.
Defaults to false
boolean
Enable or disable persisting component’s state between page reloads.
Defaults to false
boolean
Enable or disable rendering component in right to left direction.
Defaults to false
boolean
Enable or disable the spell checker in document editor container.
Defaults to false
boolean
Enable or disable the toolbar in document editor container.
Defaults to true
boolean
Enable or disable the track changes in document editor container.
Defaults to false
any[]
Adds the custom headers to XMLHttpRequest.
Defaults to []
string
Defines the height of the DocumentEditorContainer component
Defaults to ‘320px’
Gets or sets the Layout Type.
Defaults to Pages
string
Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.
Defaults to ”
boolean
Specifies the restrict editing operation.
Defaults to false
ContainerServerActionSettingsModel
Defines the settings of the DocumentEditorContainer service.
string
Gets or sets the Sfdt service URL.
Defaults to ”
boolean
Show or hide properties pane.
Defaults to true
Gets the toolbar instance.
[]
Defines toolbar items for DocumentEditorContainer.
Defaults to [‘New’,‘Open’,‘Separator’,‘Undo’,‘Redo’,‘Separator’,‘Image’,‘Table’,‘Hyperlink’,‘Bookmark’,‘TableOfContents’,‘Separator’,‘Header’,‘Footer’,‘PageSetup’,‘PageNumber’,‘Break’,‘InsertFootnote’,‘InsertEndnote’,‘Separator’,‘Find’,‘Separator’,‘Comments’,‘TrackChanges’,‘LocalClipboard’,‘RestrictEditing’,‘Separator’,‘FormFields’,‘UpdateFields’]
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.
Defaults to ‘#FFFF00’
string
Defines the width of the DocumentEditorContainer component
Defaults to ‘100%’
number
Specifies the z-order for rendering that determines whether the dialog is displayed in front or behind of another component.
Defaults to 2000
Destroys all managed resources used by this object.
Returns void
Resizes the container component and its sub elements based on given size or client size.
| Parameter | Type | Description |
|---|---|---|
| width (optional) | number |
The width to be applied. |
| height (optional) | number |
The height to be applied. |
Returns void
Set the default character format for document editor container
| Parameter | Type | Description |
|---|---|---|
| characterFormat | CharacterFormatProperties |
Specify the character format properties to be applied for document editor. |
Returns void
Set the default paragraph format for document editor container
| Parameter | Type | Description |
|---|---|---|
| paragraphFormat | ParagraphFormatProperties |
Specify the paragraph format properties to be applied for document editor. |
Returns void
Set the default section format for document editor container
| Parameter | Type | Description |
|---|---|---|
| sectionFormat | SectionFormatProperties |
Specify the section format properties to be applied for document editor. |
Returns void
EmitType<RevisionActionEventArgs>
Triggers before accepting or rejecting changes.
EmitType<CommentActionEventArgs>
Triggers on comment actions(Post, edit, reply, resolve, reopen).
EmitType<BeforePaneSwitchEventArgs>
Trigger before switching panes in DocumentEditor.
EmitType<CommentDeleteEventArgs>
Triggers on deleting a comment.
EmitType<ContainerContentChangeEventArgs>
Triggers whenever the content changes in the document editor container.
EmitType<Object>
Triggers when user interaction prevented in content control.
EmitType<Object>
Triggers when the component is created
EmitType<BeforeOpenCloseCustomContentMenuEventArgs>
Triggers before opening the custom context-menu option.
EmitType<CustomContentMenuEventArgs>
Triggers while selecting the custom context-menu option.
EmitType<Object>
Triggers when the component is destroyed.
EmitType<ContainerDocumentChangeEventArgs>
Triggers whenever document changes in the document editor container.
EmitType<ContainerSelectionChangeEventArgs>
Triggers whenever selection changes in the document editor container.
Triggers when the server action fails.
EmitType<ClickEventArgs>
Triggers when toolbar item is clicked.
EmitType<TrackChangeEventArgs>
Triggers Keyboard shortcut of TrackChanges.