Class DocumentEditorContainer

Inheritance
System.Object
TagHelper
EJTagHelper
DocumentEditorContainer
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.EJ2.DocumentEditor
Assembly: Syncfusion.EJ2.dll
Syntax
public class DocumentEditorContainer : EJTagHelper

Constructors

DocumentEditorContainer()

Declaration
public DocumentEditorContainer()

Properties

AutoResizeOnVisibilityChange

Gets or sets a value indicating whether to start automatic resize with the specified time interval and iteration count.

Declaration
[HtmlAttributeName("autoResizeOnVisibilityChange")]
public bool AutoResizeOnVisibilityChange { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

BeforeAcceptRejectChanges

Triggers before accepting or rejecting changes.

Declaration
[HtmlAttributeName("beforeAcceptRejectChanges")]
public string BeforeAcceptRejectChanges { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeCommentAction

Triggers on comment actions(Post, edit, reply, resolve, reopen).

Declaration
[HtmlAttributeName("beforeCommentAction")]
public string BeforeCommentAction { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforePaneSwitch

Trigger before switching panes in DocumentEditor.

Declaration
[HtmlAttributeName("beforePaneSwitch")]
public string BeforePaneSwitch { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeXmlHttpRequestSend

Triggers before a server request is started, allows you to modify the XMLHttpRequest object (setting additional headers, if needed).

Declaration
[HtmlAttributeName("beforeXmlHttpRequestSend")]
public object BeforeXmlHttpRequestSend { get; set; }
Property Value
Type Description
System.Object

The default value is null

CommentDelete

Triggers on deleting a comment.

Declaration
[HtmlAttributeName("commentDelete")]
public string CommentDelete { get; set; }
Property Value
Type Description
System.String

The default value is null

ContentChange

Triggers whenever the content changes in the document editor container.

Declaration
[HtmlAttributeName("contentChange")]
public string ContentChange { get; set; }
Property Value
Type Description
System.String

The default value is null

ContentControl

Triggers when user interaction prevented in content control.

Declaration
[HtmlAttributeName("contentControl")]
public string ContentControl { get; set; }
Property Value
Type Description
System.String

The default value is null

Created

Triggers when the component is created

Declaration
[HtmlAttributeName("created")]
public string Created { get; set; }
Property Value
Type Description
System.String

The default value is null

CurrentUser

Gets or sets the current user.

Declaration
[HtmlAttributeName("currentUser")]
public string CurrentUser { get; set; }
Property Value
Type Description
System.String

The default value is ""

CustomContextMenuBeforeOpen

Triggers before opening the custom context-menu option.

Declaration
[HtmlAttributeName("customContextMenuBeforeOpen")]
public string CustomContextMenuBeforeOpen { get; set; }
Property Value
Type Description
System.String

The default value is null

CustomContextMenuSelect

Triggers while selecting the custom context-menu option.

Declaration
[HtmlAttributeName("customContextMenuSelect")]
public string CustomContextMenuSelect { get; set; }
Property Value
Type Description
System.String

The default value is null

Destroyed

Triggers when the component is destroyed.

Declaration
[HtmlAttributeName("destroyed")]
public string Destroyed { get; set; }
Property Value
Type Description
System.String

The default value is null

DocumentChange

Triggers whenever document changes in the document editor container.

Declaration
[HtmlAttributeName("documentChange")]
public string DocumentChange { get; set; }
Property Value
Type Description
System.String

The default value is null

DocumentEditorSettings

Defines the settings for DocumentEditor customization.

Declaration
[HtmlAttributeName("documentEditorSettings")]
public object DocumentEditorSettings { get; set; }
Property Value
Type Description
System.Object

The default value is null

DocumentSettings

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

Declaration
[HtmlAttributeName("documentSettings")]
public object DocumentSettings { get; set; }
Property Value
Type Description
System.Object

The default value is null

EnableAutoFocus

Gets or sets a value indicating whether the automatic focus behavior is enabled for Document editor or not.

Declaration
[HtmlAttributeName("enableAutoFocus")]
public bool EnableAutoFocus { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

EnableComment

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

Declaration
[HtmlAttributeName("enableComment")]
public bool EnableComment { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

EnableCsp

Enables the rendering with strict Content Security policy.

Declaration
[HtmlAttributeName("enableCsp")]
public bool EnableCsp { get; set; }
Property Value
Type Description
System.Boolean

The default value is null

EnableLocalPaste

Enables the local paste.

Declaration
[HtmlAttributeName("enableLocalPaste")]
public bool EnableLocalPaste { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableLockAndEdit

Enables the partial lock and edit module.

Declaration
[HtmlAttributeName("enableLockAndEdit")]
public bool EnableLockAndEdit { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnablePersistence

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

Declaration
[HtmlAttributeName("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableSpellCheck

Enable or disable the spell checker in document editor container.

Declaration
[HtmlAttributeName("enableSpellCheck")]
public bool EnableSpellCheck { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableToolbar

Enable or disable the toolbar in document editor container.

Declaration
[HtmlAttributeName("enableToolbar")]
public bool EnableToolbar { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

EnableTrackChanges

Enable or disable the track changes in document editor container.

Declaration
[HtmlAttributeName("enableTrackChanges")]
public bool EnableTrackChanges { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

Headers

Adds the custom headers to XMLHttpRequest.

Declaration
[HtmlAttributeName("headers")]
public object Headers { get; set; }
Property Value
Type Description
System.Object

The default value is null

Height

Defines the height of the DocumentEditorContainer component

Declaration
[HtmlAttributeName("height")]
public string Height { get; set; }
Property Value
Type Description
System.String

The default value is "320px"

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

LayoutType

Gets or sets the Layout Type.

Declaration
[HtmlAttributeName("layoutType")]
public LayoutType LayoutType { get; set; }
Property Value
Type Description
LayoutType

The default value is LayoutType.Pages

Locale

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

Declaration
[HtmlAttributeName("locale")]
public string Locale { get; set; }
Property Value
Type Description
System.String

The default value is ""

RestrictEditing

Specifies the restrict editing operation.

Declaration
[HtmlAttributeName("restrictEditing")]
public bool RestrictEditing { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

SelectionChange

Triggers whenever selection changes in the document editor container.

Declaration
[HtmlAttributeName("selectionChange")]
public string SelectionChange { get; set; }
Property Value
Type Description
System.String

The default value is null

ServerActionSettings

Defines the settings of the DocumentEditorContainer service.

Declaration
[HtmlAttributeName("serverActionSettings")]
public object ServerActionSettings { get; set; }
Property Value
Type Description
System.Object

The default value is null

ServiceFailure

Triggers when the server action fails.

Declaration
[HtmlAttributeName("serviceFailure")]
public string ServiceFailure { get; set; }
Property Value
Type Description
System.String

The default value is null

ServiceUrl

Gets or sets the Sfdt service URL.

Declaration
[HtmlAttributeName("serviceUrl")]
public string ServiceUrl { get; set; }
Property Value
Type Description
System.String

The default value is ""

ShowPropertiesPane

Show or hide properties pane.

Declaration
[HtmlAttributeName("showPropertiesPane")]
public bool ShowPropertiesPane { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

ToolbarClick

Triggers when toolbar item is clicked.

Declaration
[HtmlAttributeName("toolbarClick")]
public string ToolbarClick { get; set; }
Property Value
Type Description
System.String

The default value is null

ToolbarItems

Defines toolbar items for DocumentEditorContainer.

Declaration
[HtmlAttributeName("toolbarItems")]
public object ToolbarItems { get; set; }
Property Value
Type Description
System.Object

The default value is null

TrackChange

Triggers Keyboard shortcut of TrackChanges.

Declaration
[HtmlAttributeName("trackChange")]
public string TrackChange { get; set; }
Property Value
Type Description
System.String

The default value is null

UserColor

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.

Declaration
[HtmlAttributeName("userColor")]
public string UserColor { get; set; }
Property Value
Type Description
System.String

The default value is "#FFFF00"

Width

Defines the width of the DocumentEditorContainer component

Declaration
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type Description
System.String

The default value is "100%"

ZIndex

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

Declaration
[HtmlAttributeName("zIndex")]
public int ZIndex { get; set; }
Property Value
Type Description
System.Int32

The default value is 2000