Search results

DocumentEditorContainerComponent

Represents react Document Editor Container

<DocumentEditorContainer></DocumentEditorContainer>

Properties

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.

Defaults to

documentEditor

DocumentEditor

Gets the DocumentEditor instance.

documentEditorSettings

DocumentEditorSettingsModel

Defines the settings for DocumentEditor customization.

Defaults to {}

documentSettings

DocumentSettingsModel

Gets the settings and properties of the document that is opened in Document editor component.

Defaults to {}

enableComment

boolean

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

Defaults to true

enableCsp

boolean

Enables the rendering with strict Content Security policy.

enableLocalPaste

boolean

Enables the local paste.

Defaults to false

enableLockAndEdit

boolean

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

Defaults to false

enableToolbar

boolean

Enable or disable the toolbar in document editor container.

Defaults to true

enableTrackChanges

boolean

Enable or disable the track changes in document editor container.

Defaults to false

headers

any[]

Adds the custom headers to XMLHttpRequest.

Defaults to []

height

string

Defines the height of the DocumentEditorContainer component

Defaults to ‘320px’

layoutType

LayoutType

Gets or sets the 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

Specifies the restrict editing operation.

Defaults to false

serverActionSettings

ContainerServerActionSettingsModel

Defines the settings of the DocumentEditorContainer service.

serviceUrl

string

Gets or sets the Sfdt service URL.

Defaults to

showPropertiesPane

boolean

Show or hide properties pane.

Defaults to true

toolbar

Toolbar

Gets the toolbar instance.

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’,‘InsertFootnote’,‘InsertEndnote’,‘Separator’,‘Find’,‘Separator’,‘Comments’,‘TrackChanges’,‘LocalClipboard’,‘RestrictEditing’,‘Separator’,‘FormFields’,‘UpdateFields’]

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.

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

Methods

destroy

Destroys all managed resources used by this object.

Returns void

resize

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

setDefaultCharacterFormat

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

setDefaultParagraphFormat

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

setDefaultSectionFormat

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

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.