ASP.NET Core - EJ2

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class DocumentEditor - ASP.NETCore-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class DocumentEditor

    Inheritance
    System.Object
    EJTagHelper
    DocumentEditor
    Inherited Members
    EJTagHelper.GetList()
    EJTagHelper.Process(TagHelperContext, TagHelperOutput)
    EJTagHelper.RegisterScript()
    EJTagHelper.GetSerializedProperties()
    EJTagHelper.GetScriptString()
    EJTagHelper.GetHtmlAttrString(IDictionary<String, Object>)
    EJTagHelper.ViewContext
    EJTagHelper.For
    EJTagHelper.Id
    EJTagHelper.IsChild
    EJTagHelper.IsComplex
    EJTagHelper.IsCollection
    EJTagHelper.ParentPropertyName
    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

    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

    AfterFormFieldFill

    Triggers after form field fill.

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

    BeforeCommentAction

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

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

    BeforeFileOpen

    Triggers before a file is opened.

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

    BeforeFormFieldFill

    Triggers before form field fill.

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

    BeforePaneSwitch

    Triggers before opening comment pane.

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

    ClassName

    Declaration
    protected override string ClassName { get; }
    Property Value
    Type Description
    System.String
    Overrides
    EJTagHelper.ClassName

    CommentBegin

    Triggers after inserting comment.

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

    CommentDelete

    Triggers after inserting comment.

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

    CommentEnd

    Triggers after posting comment.

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

    ContentChange

    Triggers whenever content changes in the document editor.

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

    ContentControl

    Triggers when user interaction prevented in content control.

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

    Created

    Triggers when the component is created

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

    CurrentUser

    Current User

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

    CustomContextMenuBeforeOpen

    Triggers before opening the custom context-menu option.

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

    CustomContextMenuSelect

    Triggers while selecting the custom context-menu option.

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

    DefaultPasteOption

    Default Paste Formatting Options

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

    Destroyed

    Triggers when the component is destroyed.

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

    DocumentChange

    Triggers whenever document changes in the document editor.

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

    DocumentEditorSettings

    Defines the settings for DocumentEditor customization.

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

    DocumentName

    Gets or sets the name of the document.

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

    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

    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

    EnableComment

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

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

    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

    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

    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

    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

    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

    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

    EnableFormField

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

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

    EnableLockAndEdit

    Enable partial lock and edit module.

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

    EnablePageSetupDialog

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

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

    EnablePersistence

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

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

    EnableRtl

    Enable or disable rendering component in right to left direction.

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

    EnableTrackChanges

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

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

    Headers

    Add custom headers to XMLHttpRequest.

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

    Height

    Defines the height of the DocumentEditor component

    Declaration
    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
    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
    EJTagHelper.IsFor

    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

    KeyDown

    Triggers whenever key is pressed in the document editor.

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

    LayoutType

    Layout Type

    Declaration
    public LayoutType LayoutType { get; set; }
    Property Value
    Type Description
    LayoutType

    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

    NameSpace

    Declaration
    protected override string NameSpace { get; }
    Property Value
    Type Description
    System.String
    Overrides
    EJTagHelper.NameSpace

    PageGap

    Gets or sets the page gap value in document editor

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

    PageOutline

    Gets or sets the page outline color.

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

    RequestNavigate

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

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

    SearchResultsChange

    Triggers whenever search results changes in the document editor.

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

    SelectionChange

    Triggers whenever selection changes in the document editor.

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

    ServerActionSettings

    Defines the settings of the DocumentEditor services

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

    ServiceFailure

    Triggers when the server side action fails.

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

    ServiceUrl

    Sfdt Service URL

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

    ShowComments

    Show comment in the document.

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

    ShowRevisions

    Shows revision changes in the document.

    Declaration
    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
    EJTagHelper.TagName

    TrackChange

    Triggers when TrackChanges enabled / disabled.

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

    UserColor

    User Selection Highlight Color

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

    ViewChange

    Triggers whenever container view changes in the document editor.

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

    Width

    Defines the width of the DocumentEditor component

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

    ZoomFactor

    Gets or sets the zoom factor in document editor.

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

    ZoomFactorChange

    Triggers whenever zoom factor changes in the document editor.

    Declaration
    public string ZoomFactorChange { get; set; }
    Property Value
    Type Description
    System.String
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved