Document Editor container component.
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 ”
DocumentEditorSettingsModel
Defines the settings for DocumentEditor customization.
Defaults to {}
DocumentSettingsModel
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 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’
string
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
[]
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
DocumentEditorGets the DocumentEditor instance.
ToolbarGets the toolbar instance.
Adds the handler to the given event listener.
| Parameter | Type | Description |
|---|---|---|
| eventName | string |
A String that specifies the name of the event |
| handler | Function |
Specifies the call to run when the event occurs. |
Returns void
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
When invoked, applies the pending property changes immediately to the component.
Returns void
Destroys all managed resources used by this object.
Returns void
Returns the persistence data for component
Returns any
Returns the route element of the component
Returns HTMLElement
Applies all the pending property changes and render the component again.
Returns void
Removes the handler from the given event listener.
| Parameter | Type | Description |
|---|---|---|
| eventName | string |
A String that specifies the name of the event to remove |
| handler | Function |
Specifies the function to remove |
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
Dynamically injects the required modules to the component.
| Parameter | Type | Description |
|---|---|---|
| moduleList | Function[] |
? |
Returns void
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.
EmitType<ServiceFailureArgs>
Triggers when the server action fails.
EmitType<ClickEventArgs>
Triggers when toolbar item is clicked.
EmitType<TrackChangeEventArgs>
Triggers Keyboard shortcut of TrackChanges.