Class DocumentEditor
Inheritance
System.Object
DocumentEditor
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()
Assembly: Syncfusion.EJ2.dll
Syntax
public class DocumentEditor : EJTagHelper
Constructors
DocumentEditor()
Declaration
Properties
AcceptTab
Gets or sets a value indicating whether tab key can be accepted as input or not.
Declaration
[HtmlAttributeName("acceptTab")]
public bool AcceptTab { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ActionComplete
Triggers when the document editor collaborative actions (such as LockContent, SaveContent, UnlockContent) gets completed.
Declaration
[HtmlAttributeName("actionComplete")]
public string ActionComplete { get; set; }
Property Value
Type |
Description |
System.String |
|
Triggers after the form field fill.
Declaration
[HtmlAttributeName("afterFormFieldFill")]
public string AfterFormFieldFill { get; set; }
Property Value
Type |
Description |
System.String |
|
Triggers on comment actions(Post, edit, reply, resolve, reopen).
Declaration
[HtmlAttributeName("beforeCommentAction")]
public string BeforeCommentAction { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeFileOpen
Triggers before a file is opened.
Declaration
[HtmlAttributeName("beforeFileOpen")]
public string BeforeFileOpen { get; set; }
Property Value
Type |
Description |
System.String |
|
Triggers before the form field fill.
Declaration
[HtmlAttributeName("beforeFormFieldFill")]
public string BeforeFormFieldFill { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforePaneSwitch
Triggers before opening the comment pane.
Declaration
[HtmlAttributeName("beforePaneSwitch")]
public string BeforePaneSwitch { get; set; }
Property Value
Type |
Description |
System.String |
|
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 |
|
ClassName
Declaration
protected override string ClassName { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
Triggers after inserting the comment.
Declaration
[HtmlAttributeName("commentBegin")]
public string CommentBegin { get; set; }
Property Value
Type |
Description |
System.String |
|
Triggers after deleting the comment.
Declaration
[HtmlAttributeName("commentDelete")]
public string CommentDelete { get; set; }
Property Value
Type |
Description |
System.String |
|
Triggers after posting the comment.
Declaration
[HtmlAttributeName("commentEnd")]
public string CommentEnd { get; set; }
Property Value
Type |
Description |
System.String |
|
ContentChange
Triggers whenever the content changes in the document editor.
Declaration
[HtmlAttributeName("contentChange")]
public string ContentChange { get; set; }
Property Value
Type |
Description |
System.String |
|
ContentControl
Triggers when user interaction prevented in content control.
Declaration
[HtmlAttributeName("contentControl")]
public string ContentControl { get; set; }
Property Value
Type |
Description |
System.String |
|
Created
Triggers when the component is created.
Declaration
[HtmlAttributeName("created")]
public string Created { get; set; }
Property Value
Type |
Description |
System.String |
|
CurrentUser
Gets or sets the current user.
Declaration
[HtmlAttributeName("currentUser")]
public string CurrentUser { get; set; }
Property Value
Type |
Description |
System.String |
|
Triggers before opening the custom context-menu option.
Declaration
[HtmlAttributeName("customContextMenuBeforeOpen")]
public string CustomContextMenuBeforeOpen { get; set; }
Property Value
Type |
Description |
System.String |
|
Triggers while selecting the custom context-menu option.
Declaration
[HtmlAttributeName("customContextMenuSelect")]
public string CustomContextMenuSelect { get; set; }
Property Value
Type |
Description |
System.String |
|
DefaultPasteOption
Gets or sets the default Paste Formatting Options
Declaration
[HtmlAttributeName("defaultPasteOption")]
public PasteOptions DefaultPasteOption { get; set; }
Property Value
Destroyed
Triggers when the component is destroyed.
Declaration
[HtmlAttributeName("destroyed")]
public string Destroyed { get; set; }
Property Value
Type |
Description |
System.String |
|
DocumentChange
Triggers whenever the document changes in the document editor.
Declaration
[HtmlAttributeName("documentChange")]
public string DocumentChange { get; set; }
Property Value
Type |
Description |
System.String |
|
DocumentEditorSettings
Defines the settings for DocumentEditor customization.
Declaration
[HtmlAttributeName("documentEditorSettings")]
public object DocumentEditorSettings { get; set; }
Property Value
Type |
Description |
System.Object |
|
DocumentName
Gets or sets the name of the document.
Declaration
[HtmlAttributeName("documentName")]
public string DocumentName { get; set; }
Property Value
Type |
Description |
System.String |
|
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 |
|
EnableBookmarkDialog
Gets or sets a value indicating whether bookmark dialog is enabled or not.
Declaration
[HtmlAttributeName("enableBookmarkDialog")]
public bool EnableBookmarkDialog { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableBordersAndShadingDialog
Gets or sets a value indicating whether borders and shading dialog is enabled or not.
Declaration
[HtmlAttributeName("enableBordersAndShadingDialog")]
public bool EnableBordersAndShadingDialog { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableColumnsDialog
Gets or sets a value indicating whether margin dialog is enabled or not.
Declaration
[HtmlAttributeName("enableColumnsDialog")]
public bool EnableColumnsDialog { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
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 |
|
Gets or sets a value indicating whether context menu is enabled or not.
Declaration
[HtmlAttributeName("enableContextMenu")]
public bool EnableContextMenu { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
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
[HtmlAttributeName("enableCursorOnReadOnly")]
public bool EnableCursorOnReadOnly { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableEditor
Gets or sets a value indicating whether editor needs to be enabled or not.
Declaration
[HtmlAttributeName("enableEditor")]
public bool EnableEditor { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableEditorHistory
Gets or sets a value indicating whether editor history needs to be enabled or not.
Declaration
[HtmlAttributeName("enableEditorHistory")]
public bool EnableEditorHistory { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableFontDialog
Gets or sets a value indicating whether font dialog is enabled or not.
Declaration
[HtmlAttributeName("enableFontDialog")]
public bool EnableFontDialog { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Gets or sets a value indicating whether notes dialog is enabled or not.
Declaration
[HtmlAttributeName("enableFootnoteAndEndnoteDialog")]
public bool EnableFootnoteAndEndnoteDialog { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Gets or sets a value indicating whether form fields is enabled or not.
Declaration
[HtmlAttributeName("enableFormField")]
public bool EnableFormField { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableHyperlinkDialog
Gets or sets a value indicating whether hyperlink dialog is enabled or not.
Declaration
[HtmlAttributeName("enableHyperlinkDialog")]
public bool EnableHyperlinkDialog { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableImageResizer
Gets or sets a value indicating whether image resizer is enabled or not.
Declaration
[HtmlAttributeName("enableImageResizer")]
public bool EnableImageResizer { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableListDialog
Gets or sets a value indicating whether list dialog is enabled or not.
Declaration
[HtmlAttributeName("enableListDialog")]
public bool EnableListDialog { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableLocalPaste
Gets or sets a value indicating whether local paste needs to be enabled or not.
Declaration
[HtmlAttributeName("enableLocalPaste")]
public bool EnableLocalPaste { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableLockAndEdit
Enables the partial lock and edit module.
Declaration
[HtmlAttributeName("enableLockAndEdit")]
public bool EnableLockAndEdit { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableOptionsPane
Gets or sets a value indicating whether options pane is enabled or not.
Declaration
[HtmlAttributeName("enableOptionsPane")]
public bool EnableOptionsPane { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnablePageSetupDialog
Gets or sets a value indicating whether font dialog is enabled or not.
Declaration
[HtmlAttributeName("enablePageSetupDialog")]
public bool EnablePageSetupDialog { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableParagraphDialog
Gets or sets a value indicating whether paragraph dialog is enabled or not.
Declaration
[HtmlAttributeName("enableParagraphDialog")]
public bool EnableParagraphDialog { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
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 |
|
EnablePrint
Gets or sets a value indicating whether print needs to be enabled or not.
Declaration
[HtmlAttributeName("enablePrint")]
public bool EnablePrint { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
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 |
|
EnableSearch
Gets or sets a value indicating whether search module is enabled or not.
Declaration
[HtmlAttributeName("enableSearch")]
public bool EnableSearch { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableSelection
Gets or sets a value indicating whether selection needs to be enabled or not.
Declaration
[HtmlAttributeName("enableSelection")]
public bool EnableSelection { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableSfdtExport
Gets or sets a value indicating whether Sfdt export needs to be enabled or not.
Declaration
[HtmlAttributeName("enableSfdtExport")]
public bool EnableSfdtExport { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableSpellCheck
Gets or sets a value indicating whether editor need to be spell checked.
Declaration
[HtmlAttributeName("enableSpellCheck")]
public bool EnableSpellCheck { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableStyleDialog
Gets or sets a value indicating whether font dialog is enabled or not.
Declaration
[HtmlAttributeName("enableStyleDialog")]
public bool EnableStyleDialog { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableTableDialog
Gets or sets a value indicating whether table dialog is enabled or not.
Declaration
[HtmlAttributeName("enableTableDialog")]
public bool EnableTableDialog { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableTableOfContentsDialog
Gets or sets a value indicating whether table of contents dialog is enabled or not.
Declaration
[HtmlAttributeName("enableTableOfContentsDialog")]
public bool EnableTableOfContentsDialog { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableTableOptionsDialog
Gets or sets a value indicating whether table options dialog is enabled or not.
Declaration
[HtmlAttributeName("enableTableOptionsDialog")]
public bool EnableTableOptionsDialog { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableTablePropertiesDialog
Gets or sets a value indicating whether table properties dialog is enabled or not.
Declaration
[HtmlAttributeName("enableTablePropertiesDialog")]
public bool EnableTablePropertiesDialog { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableTextExport
Gets or sets a value indicating whether text export needs to be enabled or not.
Declaration
[HtmlAttributeName("enableTextExport")]
public bool EnableTextExport { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableTrackChanges
Gets or sets a value indicating whether track changes is enabled or not
Declaration
[HtmlAttributeName("enableTrackChanges")]
public bool EnableTrackChanges { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableWordExport
Gets or sets a value indicating whether word export needs to be enabled or not.
Declaration
[HtmlAttributeName("enableWordExport")]
public bool EnableWordExport { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Adds the custom headers to XMLHttpRequest.
Declaration
[HtmlAttributeName("headers")]
public object Headers { get; set; }
Property Value
Type |
Description |
System.Object |
|
Height
Defines the height of the DocumentEditor component.
Declaration
[HtmlAttributeName("height")]
public string Height { get; set; }
Property Value
Type |
Description |
System.String |
|
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 |
|
IsFor
Declaration
protected override bool IsFor { get; }
Property Value
Type |
Description |
System.Boolean |
|
Overrides
IsReadOnly
Gets or sets a value indicating whether the document editor is in read only state or not.
Declaration
[HtmlAttributeName("isReadOnly")]
public bool IsReadOnly { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
KeyDown
Triggers whenever the key is pressed in the document editor.
Declaration
[HtmlAttributeName("keyDown")]
public string KeyDown { get; set; }
Property Value
Type |
Description |
System.String |
|
LayoutType
Gets or sets the Layout Type.
Declaration
[HtmlAttributeName("layoutType")]
public LayoutType LayoutType { get; set; }
Property Value
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 |
|
NameSpace
Declaration
protected override string NameSpace { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
PageGap
Gets or sets the page gap value in document editor.
Declaration
[HtmlAttributeName("pageGap")]
public double PageGap { get; set; }
Property Value
Type |
Description |
System.Double |
|
PageOutline
Gets or sets the page outline color.
Declaration
[HtmlAttributeName("pageOutline")]
public string PageOutline { get; set; }
Property Value
Type |
Description |
System.String |
|
RequestNavigate
Triggers whenever the hyperlink is clicked or tapped in the document editor.
Declaration
[HtmlAttributeName("requestNavigate")]
public string RequestNavigate { get; set; }
Property Value
Type |
Description |
System.String |
|
SearchResultsChange
Triggers whenever search results changes in the document editor.
Declaration
[HtmlAttributeName("searchResultsChange")]
public string SearchResultsChange { get; set; }
Property Value
Type |
Description |
System.String |
|
SelectionChange
Triggers whenever the selection changes in the document editor.
Declaration
[HtmlAttributeName("selectionChange")]
public string SelectionChange { get; set; }
Property Value
Type |
Description |
System.String |
|
ServerActionSettings
Defines the settings of the DocumentEditor services
Declaration
[HtmlAttributeName("serverActionSettings")]
public object ServerActionSettings { get; set; }
Property Value
Type |
Description |
System.Object |
|
ServiceFailure
Triggers when the server side action fails.
Declaration
[HtmlAttributeName("serviceFailure")]
public string ServiceFailure { get; set; }
Property Value
Type |
Description |
System.String |
|
ServiceUrl
Gets or sets the Sfdt Service URL.
Declaration
[HtmlAttributeName("serviceUrl")]
public string ServiceUrl { get; set; }
Property Value
Type |
Description |
System.String |
|
Shows the comment in the document.
Declaration
[HtmlAttributeName("showComments")]
public bool ShowComments { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ShowRevisions
Shows the revision changes in the document.
Declaration
[HtmlAttributeName("showRevisions")]
public bool ShowRevisions { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
TagName
Declaration
protected override string TagName { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
TrackChange
Triggers when the trackChanges enabled / disabled.
Declaration
[HtmlAttributeName("trackChange")]
public string TrackChange { get; set; }
Property Value
Type |
Description |
System.String |
|
UseCtrlClickToFollowHyperlink
Gets or sets a value indicating whether holding Ctrl key is required to follow hyperlink on click. The default value is true.
Declaration
[HtmlAttributeName("useCtrlClickToFollowHyperlink")]
public bool UseCtrlClickToFollowHyperlink { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
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 |
|
ViewChange
Triggers whenever the container view changes in the document editor.
Declaration
[HtmlAttributeName("viewChange")]
public string ViewChange { get; set; }
Property Value
Type |
Description |
System.String |
|
Width
Defines the width of the DocumentEditor component.
Declaration
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type |
Description |
System.String |
|
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 |
|
ZoomFactor
Gets or sets the zoom factor in document editor.
Declaration
[HtmlAttributeName("zoomFactor")]
public double ZoomFactor { get; set; }
Property Value
Type |
Description |
System.Double |
|
ZoomFactorChange
Triggers whenever the zoom factor changes in the document editor.
Declaration
[HtmlAttributeName("zoomFactorChange")]
public string ZoomFactorChange { get; set; }
Property Value
Type |
Description |
System.String |
|