Class DocumentEditor

Inheritance
System.Object
Syncfusion.EJ2.EJTagHelper
DocumentEditor
Namespace: Syncfusion.EJ2.DocumentEditor
Assembly: Syncfusion.EJ2.dll
Syntax
public class DocumentEditor : EJTagHelper

Constructors

DocumentEditor()

Declaration
public DocumentEditor()

Properties

AcceptTab

Gets or sets a value indicating whether tab key can be accepted as input or not.

Declaration
public bool AcceptTab { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

ActionComplete

Triggers when the document editor collaborative actions (such as LockContent, SaveContent, UnlockContent) gets completed.

Declaration
public string ActionComplete { get; set; }
Property Value
Type Description
System.String

The default value is null

AfterFormFieldFill

Triggers after the form field fill.

Declaration
public string AfterFormFieldFill { get; set; }
Property Value
Type Description
System.String

The default value is null

AutoResizeOnVisibilityChange

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

Declaration
public bool AutoResizeOnVisibilityChange { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

BeforeAcceptRejectChanges

Triggers before accepting or rejecting changes.

Declaration
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
public string BeforeCommentAction { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeFileOpen

Triggers before a file is opened.

Declaration
public string BeforeFileOpen { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforeFormFieldFill

Triggers before the form field fill.

Declaration
public string BeforeFormFieldFill { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforePaneSwitch

Triggers before opening the comment pane.

Declaration
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
public object BeforeXmlHttpRequestSend { get; set; }
Property Value
Type Description
System.Object

The default value is null

CommentBegin

Triggers after inserting the comment.

Declaration
public string CommentBegin { get; set; }
Property Value
Type Description
System.String

The default value is null

CommentDelete

Triggers after deleting the comment.

Declaration
public string CommentDelete { get; set; }
Property Value
Type Description
System.String

The default value is null

CommentEnd

Triggers after posting the comment.

Declaration
public string CommentEnd { get; set; }
Property Value
Type Description
System.String

The default value is null

ContentChange

Triggers whenever the content changes in the document editor.

Declaration
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
public string ContentControl { get; set; }
Property Value
Type Description
System.String

The default value is null

Created

Triggers when the component is created.

Declaration
public string Created { get; set; }
Property Value
Type Description
System.String

The default value is null

CurrentUser

Gets or sets the current user.

Declaration
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
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
public string CustomContextMenuSelect { get; set; }
Property Value
Type Description
System.String

The default value is null

DefaultPasteOption

Gets or sets the default Paste Formatting Options

Declaration
public PasteOptions DefaultPasteOption { get; set; }
Property Value
Type Description
PasteOptions

The default value is PasteOptions.KeepSourceFormatting

Destroyed

Triggers when the component is destroyed.

Declaration
public string Destroyed { get; set; }
Property Value
Type Description
System.String

The default value is null

DocumentChange

Triggers whenever the document changes in the document editor.

Declaration
public string DocumentChange { get; set; }
Property Value
Type Description
System.String

The default value is null

DocumentEditorSettings

Defines the settings for DocumentEditor customization.

Declaration
public object DocumentEditorSettings { get; set; }
Property Value
Type Description
System.Object

The default value is null

DocumentLoadFailed

Triggers when SFDT is failed to load in the document editor

Declaration
public object DocumentLoadFailed { get; set; }
Property Value
Type Description
System.Object

The default value is null

DocumentName

Gets or sets the name of the document.

Declaration
public string DocumentName { get; set; }
Property Value
Type Description
System.String

The default value is ""

DocumentSettings

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

Declaration
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
public bool EnableAutoFocus { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

EnableBookmarkDialog

Gets or sets a value indicating whether bookmark dialog is enabled or not.

Declaration
public bool EnableBookmarkDialog { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableBordersAndShadingDialog

Gets or sets a value indicating whether borders and shading dialog is enabled or not.

Declaration
public bool EnableBordersAndShadingDialog { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableCollaborativeEditing

Enable collaborative editing in document editor.

Declaration
public bool EnableCollaborativeEditing { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableColumnsDialog

Gets or sets a value indicating whether margin dialog is enabled or not.

Declaration
public bool EnableColumnsDialog { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableComment

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

Declaration
public bool EnableComment { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableContextMenu

Gets or sets a value indicating whether context menu is enabled or not.

Declaration
public bool EnableContextMenu { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableCursorOnReadOnly

Gets or sets a value indicating whether to enable cursor in document editor on read only state or not. The default value is false.

Declaration
public bool EnableCursorOnReadOnly { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableEditor

Gets or sets a value indicating whether editor needs to be enabled or not.

Declaration
public bool EnableEditor { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableEditorHistory

Gets or sets a value indicating whether editor history needs to be enabled or not.

Declaration
public bool EnableEditorHistory { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableFontDialog

Gets or sets a value indicating whether font dialog is enabled or not.

Declaration
public bool EnableFontDialog { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableFootnoteAndEndnoteDialog

Gets or sets a value indicating whether notes dialog is enabled or not.

Declaration
public bool EnableFootnoteAndEndnoteDialog { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableFormField

Gets or sets a value indicating whether form fields is enabled or not.

Declaration
public bool EnableFormField { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableHyperlinkDialog

Gets or sets a value indicating whether hyperlink dialog is enabled or not.

Declaration
public bool EnableHyperlinkDialog { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableImageResizer

Gets or sets a value indicating whether image resizer is enabled or not.

Declaration
public bool EnableImageResizer { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableListDialog

Gets or sets a value indicating whether list dialog is enabled or not.

Declaration
public bool EnableListDialog { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableLocalPaste

Gets or sets a value indicating whether local paste needs to be enabled or not.

Declaration
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
public bool EnableLockAndEdit { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableOptionsPane

Gets or sets a value indicating whether options pane is enabled or not.

Declaration
public bool EnableOptionsPane { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnablePageSetupDialog

Gets or sets a value indicating whether font dialog is enabled or not.

Declaration
public bool EnablePageSetupDialog { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableParagraphDialog

Gets or sets a value indicating whether paragraph dialog is enabled or not.

Declaration
public bool EnableParagraphDialog { 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
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnablePrint

Gets or sets a value indicating whether print needs to be enabled or not.

Declaration
public bool EnablePrint { 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
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableSearch

Gets or sets a value indicating whether search module is enabled or not.

Declaration
public bool EnableSearch { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableSelection

Gets or sets a value indicating whether selection needs to be enabled or not.

Declaration
public bool EnableSelection { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableSfdtExport

Gets or sets a value indicating whether Sfdt export needs to be enabled or not.

Declaration
public bool EnableSfdtExport { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableSpellCheck

Gets or sets a value indicating whether editor need to be spell checked.

Declaration
public bool EnableSpellCheck { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableStyleDialog

Gets or sets a value indicating whether font dialog is enabled or not.

Declaration
public bool EnableStyleDialog { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableTableDialog

Gets or sets a value indicating whether table dialog is enabled or not.

Declaration
public bool EnableTableDialog { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableTableOfContentsDialog

Gets or sets a value indicating whether table of contents dialog is enabled or not.

Declaration
public bool EnableTableOfContentsDialog { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableTableOptionsDialog

Gets or sets a value indicating whether table options dialog is enabled or not.

Declaration
public bool EnableTableOptionsDialog { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableTablePropertiesDialog

Gets or sets a value indicating whether table properties dialog is enabled or not.

Declaration
public bool EnableTablePropertiesDialog { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableTextExport

Gets or sets a value indicating whether text export needs to be enabled or not.

Declaration
public bool EnableTextExport { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableTrackChanges

Gets or sets a value indicating whether track changes is enabled or not

Declaration
public bool EnableTrackChanges { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableWordExport

Gets or sets a value indicating whether word export needs to be enabled or not.

Declaration
public bool EnableWordExport { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

Headers

Adds the custom headers to XMLHttpRequest.

Declaration
public object Headers { get; set; }
Property Value
Type Description
System.Object

The default value is null

Height

Defines the height of the DocumentEditor component.

Declaration
public string Height { get; set; }
Property Value
Type Description
System.String

The default value is "200px"

HtmlAttributes

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

Declaration
public object HtmlAttributes { get; set; }
Property Value
Type
System.Object

IsReadOnly

Gets or sets a value indicating whether the document editor is in read only state or not.

Declaration
public bool IsReadOnly { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

KeyDown

Triggers whenever the key is pressed in the document editor.

Declaration
public string KeyDown { get; set; }
Property Value
Type Description
System.String

The default value is null

LayoutType

Gets or sets the Layout Type.

Declaration
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
public string Locale { get; set; }
Property Value
Type Description
System.String

The default value is ""

PageGap

Gets or sets the page gap value in document editor.

Declaration
public double PageGap { get; set; }
Property Value
Type Description
System.Double

The default value is 20

PageOutline

Gets or sets the page outline color.

Declaration
public string PageOutline { get; set; }
Property Value
Type Description
System.String

The default value is "#000000"

RequestNavigate

Triggers whenever the hyperlink is clicked or tapped in the document editor.

Declaration
public string RequestNavigate { get; set; }
Property Value
Type Description
System.String

The default value is null

SearchResultsChange

Triggers whenever search results changes in the document editor.

Declaration
public string SearchResultsChange { get; set; }
Property Value
Type Description
System.String

The default value is null

SelectionChange

Triggers whenever the selection changes in the document editor.

Declaration
public string SelectionChange { get; set; }
Property Value
Type Description
System.String

The default value is null

ServerActionSettings

Defines the settings of the DocumentEditor services

Declaration
public object ServerActionSettings { get; set; }
Property Value
Type Description
System.Object

The default value is null

ServiceFailure

Triggers when the server side action fails.

Declaration
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
public string ServiceUrl { get; set; }
Property Value
Type Description
System.String

The default value is ""

ShowComments

Shows the comment in the document.

Declaration
public bool ShowComments { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

ShowRevisions

Shows the revision changes in the document.

Declaration
public bool ShowRevisions { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

TrackChange

Triggers when the trackChanges enabled / disabled.

Declaration
public string TrackChange { get; set; }
Property Value
Type Description
System.String

The default value is null

Gets or sets a value indicating whether holding Ctrl key is required to follow hyperlink on click. The default value is true.

Declaration
public bool UseCtrlClickToFollowHyperlink { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

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
public string UserColor { get; set; }
Property Value
Type Description
System.String

The default value is "#FFFF00"

ViewChange

Triggers whenever the container view changes in the document editor.

Declaration
public string ViewChange { get; set; }
Property Value
Type Description
System.String

The default value is null

Width

Defines the width of the DocumentEditor component.

Declaration
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
public int ZIndex { get; set; }
Property Value
Type Description
System.Int32

The default value is 2000

ZoomFactor

Gets or sets the zoom factor in document editor.

Declaration
public double ZoomFactor { get; set; }
Property Value
Type Description
System.Double

The default value is 1

ZoomFactorChange

Triggers whenever the zoom factor changes in the document editor.

Declaration
public string ZoomFactorChange { get; set; }
Property Value
Type Description
System.String

The default value is null