Class DocumentEditorBuilder

Inheritance
System.Object
ControlBuilder
DocumentEditorBuilder
Inherited Members
Namespace: Syncfusion.EJ2.DocumentEditor
Assembly: Syncfusion.EJ2.dll
Syntax
public class DocumentEditorBuilder : ControlBuilder

Constructors

DocumentEditorBuilder()

Declaration
public DocumentEditorBuilder()

DocumentEditorBuilder(DocumentEditor)

Declaration
public DocumentEditorBuilder(DocumentEditor model)
Parameters
Type Name Description
DocumentEditor model

Fields

model

Declaration
public DocumentEditor model
Field Value
Type Description
DocumentEditor

Properties

HtmlAttr

Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

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

Output

Declaration
public override TextWriter Output { get; set; }
Property Value
Type Description
System.IO.TextWriter
Overrides

Methods

AcceptTab(Boolean)

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

Declaration
public DocumentEditorBuilder AcceptTab(bool acceptTab = true)
Parameters
Type Name Description
System.Boolean acceptTab
Returns
Type Description
DocumentEditorBuilder

ActionComplete(String)

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

Declaration
public DocumentEditorBuilder ActionComplete(string actionComplete)
Parameters
Type Name Description
System.String actionComplete
Returns
Type Description
DocumentEditorBuilder

AfterFormFieldFill(String)

Triggers after form field fill.

Declaration
public DocumentEditorBuilder AfterFormFieldFill(string afterFormFieldFill)
Parameters
Type Name Description
System.String afterFormFieldFill
Returns
Type Description
DocumentEditorBuilder

BeforeCommentAction(String)

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

Declaration
public DocumentEditorBuilder BeforeCommentAction(string beforeCommentAction)
Parameters
Type Name Description
System.String beforeCommentAction
Returns
Type Description
DocumentEditorBuilder

BeforeFileOpen(String)

Triggers before a file is opened.

Declaration
public DocumentEditorBuilder BeforeFileOpen(string beforeFileOpen)
Parameters
Type Name Description
System.String beforeFileOpen
Returns
Type Description
DocumentEditorBuilder

BeforeFormFieldFill(String)

Triggers before form field fill.

Declaration
public DocumentEditorBuilder BeforeFormFieldFill(string beforeFormFieldFill)
Parameters
Type Name Description
System.String beforeFormFieldFill
Returns
Type Description
DocumentEditorBuilder

BeforePaneSwitch(String)

Triggers before opening comment pane.

Declaration
public DocumentEditorBuilder BeforePaneSwitch(string beforePaneSwitch)
Parameters
Type Name Description
System.String beforePaneSwitch
Returns
Type Description
DocumentEditorBuilder

CommentBegin(String)

Triggers after inserting comment.

Declaration
public DocumentEditorBuilder CommentBegin(string commentBegin)
Parameters
Type Name Description
System.String commentBegin
Returns
Type Description
DocumentEditorBuilder

CommentDelete(String)

Triggers after inserting comment.

Declaration
public DocumentEditorBuilder CommentDelete(string commentDelete)
Parameters
Type Name Description
System.String commentDelete
Returns
Type Description
DocumentEditorBuilder

CommentEnd(String)

Triggers after posting comment.

Declaration
public DocumentEditorBuilder CommentEnd(string commentEnd)
Parameters
Type Name Description
System.String commentEnd
Returns
Type Description
DocumentEditorBuilder

ContentChange(String)

Triggers whenever content changes in the document editor.

Declaration
public DocumentEditorBuilder ContentChange(string contentChange)
Parameters
Type Name Description
System.String contentChange
Returns
Type Description
DocumentEditorBuilder

ContentControl(String)

Triggers when user interaction prevented in content control.

Declaration
public DocumentEditorBuilder ContentControl(string contentControl)
Parameters
Type Name Description
System.String contentControl
Returns
Type Description
DocumentEditorBuilder

Created(String)

Triggers when the component is created

Declaration
public DocumentEditorBuilder Created(string created)
Parameters
Type Name Description
System.String created
Returns
Type Description
DocumentEditorBuilder

CurrentUser(String)

Current User

Declaration
public DocumentEditorBuilder CurrentUser(string currentUser)
Parameters
Type Name Description
System.String currentUser
Returns
Type Description
DocumentEditorBuilder

CustomContextMenuBeforeOpen(String)

Triggers before opening the custom context-menu option.

Declaration
public DocumentEditorBuilder CustomContextMenuBeforeOpen(string customContextMenuBeforeOpen)
Parameters
Type Name Description
System.String customContextMenuBeforeOpen
Returns
Type Description
DocumentEditorBuilder

CustomContextMenuSelect(String)

Triggers while selecting the custom context-menu option.

Declaration
public DocumentEditorBuilder CustomContextMenuSelect(string customContextMenuSelect)
Parameters
Type Name Description
System.String customContextMenuSelect
Returns
Type Description
DocumentEditorBuilder

DefaultPasteOption(PasteOptions)

Default Paste Formatting Options

Declaration
public DocumentEditorBuilder DefaultPasteOption(PasteOptions defaultPasteOption)
Parameters
Type Name Description
PasteOptions defaultPasteOption
Returns
Type Description
DocumentEditorBuilder

Destroyed(String)

Triggers when the component is destroyed.

Declaration
public DocumentEditorBuilder Destroyed(string destroyed)
Parameters
Type Name Description
System.String destroyed
Returns
Type Description
DocumentEditorBuilder

DocumentChange(String)

Triggers whenever document changes in the document editor.

Declaration
public DocumentEditorBuilder DocumentChange(string documentChange)
Parameters
Type Name Description
System.String documentChange
Returns
Type Description
DocumentEditorBuilder

DocumentEditorSettings(Object)

Defines the settings for DocumentEditor customization.

Declaration
public DocumentEditorBuilder DocumentEditorSettings(object documentEditorSettings)
Parameters
Type Name Description
System.Object documentEditorSettings
Returns
Type Description
DocumentEditorBuilder

DocumentName(String)

Gets or sets the name of the document.

Declaration
public DocumentEditorBuilder DocumentName(string documentName)
Parameters
Type Name Description
System.String documentName
Returns
Type Description
DocumentEditorBuilder

EnableBookmarkDialog(Boolean)

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

Declaration
public DocumentEditorBuilder EnableBookmarkDialog(bool enableBookmarkDialog = true)
Parameters
Type Name Description
System.Boolean enableBookmarkDialog
Returns
Type Description
DocumentEditorBuilder

EnableBordersAndShadingDialog(Boolean)

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

Declaration
public DocumentEditorBuilder EnableBordersAndShadingDialog(bool enableBordersAndShadingDialog = true)
Parameters
Type Name Description
System.Boolean enableBordersAndShadingDialog
Returns
Type Description
DocumentEditorBuilder

EnableComment(Boolean)

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

Declaration
public DocumentEditorBuilder EnableComment(bool enableComment = true)
Parameters
Type Name Description
System.Boolean enableComment
Returns
Type Description
DocumentEditorBuilder

EnableContextMenu(Boolean)

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

Declaration
public DocumentEditorBuilder EnableContextMenu(bool enableContextMenu = true)
Parameters
Type Name Description
System.Boolean enableContextMenu
Returns
Type Description
DocumentEditorBuilder

EnableCursorOnReadOnly(Boolean)

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 DocumentEditorBuilder EnableCursorOnReadOnly(bool enableCursorOnReadOnly = true)
Parameters
Type Name Description
System.Boolean enableCursorOnReadOnly
Returns
Type Description
DocumentEditorBuilder

EnableEditor(Boolean)

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

Declaration
public DocumentEditorBuilder EnableEditor(bool enableEditor = true)
Parameters
Type Name Description
System.Boolean enableEditor
Returns
Type Description
DocumentEditorBuilder

EnableEditorHistory(Boolean)

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

Declaration
public DocumentEditorBuilder EnableEditorHistory(bool enableEditorHistory = true)
Parameters
Type Name Description
System.Boolean enableEditorHistory
Returns
Type Description
DocumentEditorBuilder

EnableFontDialog(Boolean)

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

Declaration
public DocumentEditorBuilder EnableFontDialog(bool enableFontDialog = true)
Parameters
Type Name Description
System.Boolean enableFontDialog
Returns
Type Description
DocumentEditorBuilder

EnableFootnoteAndEndnoteDialog(Boolean)

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

Declaration
public DocumentEditorBuilder EnableFootnoteAndEndnoteDialog(bool enableFootnoteAndEndnoteDialog = true)
Parameters
Type Name Description
System.Boolean enableFootnoteAndEndnoteDialog
Returns
Type Description
DocumentEditorBuilder

EnableFormField(Boolean)

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

Declaration
public DocumentEditorBuilder EnableFormField(bool enableFormField = true)
Parameters
Type Name Description
System.Boolean enableFormField
Returns
Type Description
DocumentEditorBuilder

EnableHyperlinkDialog(Boolean)

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

Declaration
public DocumentEditorBuilder EnableHyperlinkDialog(bool enableHyperlinkDialog = true)
Parameters
Type Name Description
System.Boolean enableHyperlinkDialog
Returns
Type Description
DocumentEditorBuilder

EnableImageResizer(Boolean)

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

Declaration
public DocumentEditorBuilder EnableImageResizer(bool enableImageResizer = true)
Parameters
Type Name Description
System.Boolean enableImageResizer
Returns
Type Description
DocumentEditorBuilder

EnableListDialog(Boolean)

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

Declaration
public DocumentEditorBuilder EnableListDialog(bool enableListDialog = true)
Parameters
Type Name Description
System.Boolean enableListDialog
Returns
Type Description
DocumentEditorBuilder

EnableLocalPaste(Boolean)

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

Declaration
public DocumentEditorBuilder EnableLocalPaste(bool enableLocalPaste = true)
Parameters
Type Name Description
System.Boolean enableLocalPaste
Returns
Type Description
DocumentEditorBuilder

EnableLockAndEdit(Boolean)

Enable partial lock and edit module.

Declaration
public DocumentEditorBuilder EnableLockAndEdit(bool enableLockAndEdit = true)
Parameters
Type Name Description
System.Boolean enableLockAndEdit
Returns
Type Description
DocumentEditorBuilder

EnableOptionsPane(Boolean)

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

Declaration
public DocumentEditorBuilder EnableOptionsPane(bool enableOptionsPane = true)
Parameters
Type Name Description
System.Boolean enableOptionsPane
Returns
Type Description
DocumentEditorBuilder

EnablePageSetupDialog(Boolean)

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

Declaration
public DocumentEditorBuilder EnablePageSetupDialog(bool enablePageSetupDialog = true)
Parameters
Type Name Description
System.Boolean enablePageSetupDialog
Returns
Type Description
DocumentEditorBuilder

EnableParagraphDialog(Boolean)

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

Declaration
public DocumentEditorBuilder EnableParagraphDialog(bool enableParagraphDialog = true)
Parameters
Type Name Description
System.Boolean enableParagraphDialog
Returns
Type Description
DocumentEditorBuilder

EnablePersistence(Boolean)

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

Declaration
public DocumentEditorBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type Name Description
System.Boolean enablePersistence
Returns
Type Description
DocumentEditorBuilder

EnablePrint(Boolean)

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

Declaration
public DocumentEditorBuilder EnablePrint(bool enablePrint = true)
Parameters
Type Name Description
System.Boolean enablePrint
Returns
Type Description
DocumentEditorBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration
public DocumentEditorBuilder EnableRtl(bool enableRtl = true)
Parameters
Type Name Description
System.Boolean enableRtl
Returns
Type Description
DocumentEditorBuilder

EnableSearch(Boolean)

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

Declaration
public DocumentEditorBuilder EnableSearch(bool enableSearch = true)
Parameters
Type Name Description
System.Boolean enableSearch
Returns
Type Description
DocumentEditorBuilder

EnableSelection(Boolean)

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

Declaration
public DocumentEditorBuilder EnableSelection(bool enableSelection = true)
Parameters
Type Name Description
System.Boolean enableSelection
Returns
Type Description
DocumentEditorBuilder

EnableSfdtExport(Boolean)

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

Declaration
public DocumentEditorBuilder EnableSfdtExport(bool enableSfdtExport = true)
Parameters
Type Name Description
System.Boolean enableSfdtExport
Returns
Type Description
DocumentEditorBuilder

EnableSpellCheck(Boolean)

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

Declaration
public DocumentEditorBuilder EnableSpellCheck(bool enableSpellCheck = true)
Parameters
Type Name Description
System.Boolean enableSpellCheck
Returns
Type Description
DocumentEditorBuilder

EnableStyleDialog(Boolean)

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

Declaration
public DocumentEditorBuilder EnableStyleDialog(bool enableStyleDialog = true)
Parameters
Type Name Description
System.Boolean enableStyleDialog
Returns
Type Description
DocumentEditorBuilder

EnableTableDialog(Boolean)

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

Declaration
public DocumentEditorBuilder EnableTableDialog(bool enableTableDialog = true)
Parameters
Type Name Description
System.Boolean enableTableDialog
Returns
Type Description
DocumentEditorBuilder

EnableTableOfContentsDialog(Boolean)

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

Declaration
public DocumentEditorBuilder EnableTableOfContentsDialog(bool enableTableOfContentsDialog = true)
Parameters
Type Name Description
System.Boolean enableTableOfContentsDialog
Returns
Type Description
DocumentEditorBuilder

EnableTableOptionsDialog(Boolean)

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

Declaration
public DocumentEditorBuilder EnableTableOptionsDialog(bool enableTableOptionsDialog = true)
Parameters
Type Name Description
System.Boolean enableTableOptionsDialog
Returns
Type Description
DocumentEditorBuilder

EnableTablePropertiesDialog(Boolean)

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

Declaration
public DocumentEditorBuilder EnableTablePropertiesDialog(bool enableTablePropertiesDialog = true)
Parameters
Type Name Description
System.Boolean enableTablePropertiesDialog
Returns
Type Description
DocumentEditorBuilder

EnableTextExport(Boolean)

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

Declaration
public DocumentEditorBuilder EnableTextExport(bool enableTextExport = true)
Parameters
Type Name Description
System.Boolean enableTextExport
Returns
Type Description
DocumentEditorBuilder

EnableTrackChanges(Boolean)

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

Declaration
public DocumentEditorBuilder EnableTrackChanges(bool enableTrackChanges = true)
Parameters
Type Name Description
System.Boolean enableTrackChanges
Returns
Type Description
DocumentEditorBuilder

EnableWordExport(Boolean)

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

Declaration
public DocumentEditorBuilder EnableWordExport(bool enableWordExport = true)
Parameters
Type Name Description
System.Boolean enableWordExport
Returns
Type Description
DocumentEditorBuilder

Headers(Object)

Add custom headers to XMLHttpRequest.

Declaration
public DocumentEditorBuilder Headers(object headers)
Parameters
Type Name Description
System.Object headers
Returns
Type Description
DocumentEditorBuilder

Height(String)

Defines the height of the DocumentEditor component

Declaration
public DocumentEditorBuilder Height(string height)
Parameters
Type Name Description
System.String height
Returns
Type Description
DocumentEditorBuilder

HtmlAttributes(Object)

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

Declaration
public DocumentEditorBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type Name Description
System.Object htmlAttributes
Returns
Type Description
DocumentEditorBuilder

IsReadOnly(Boolean)

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

Declaration
public DocumentEditorBuilder IsReadOnly(bool isReadOnly = true)
Parameters
Type Name Description
System.Boolean isReadOnly
Returns
Type Description
DocumentEditorBuilder

KeyDown(String)

Triggers whenever key is pressed in the document editor.

Declaration
public DocumentEditorBuilder KeyDown(string keyDown)
Parameters
Type Name Description
System.String keyDown
Returns
Type Description
DocumentEditorBuilder

LayoutType(LayoutType)

Layout Type

Declaration
public DocumentEditorBuilder LayoutType(LayoutType layoutType)
Parameters
Type Name Description
LayoutType layoutType
Returns
Type Description
DocumentEditorBuilder

Locale(String)

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

Declaration
public DocumentEditorBuilder Locale(string locale)
Parameters
Type Name Description
System.String locale
Returns
Type Description
DocumentEditorBuilder

PageGap(Double)

Gets or sets the page gap value in document editor

Declaration
public DocumentEditorBuilder PageGap(double pageGap)
Parameters
Type Name Description
System.Double pageGap
Returns
Type Description
DocumentEditorBuilder

PageOutline(String)

Gets or sets the page outline color.

Declaration
public DocumentEditorBuilder PageOutline(string pageOutline)
Parameters
Type Name Description
System.String pageOutline
Returns
Type Description
DocumentEditorBuilder

Render()

Declaration
public HtmlString Render()
Returns
Type Description
Microsoft.AspNetCore.Html.HtmlString

RequestNavigate(String)

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

Declaration
public DocumentEditorBuilder RequestNavigate(string requestNavigate)
Parameters
Type Name Description
System.String requestNavigate
Returns
Type Description
DocumentEditorBuilder

SearchResultsChange(String)

Triggers whenever search results changes in the document editor.

Declaration
public DocumentEditorBuilder SearchResultsChange(string searchResultsChange)
Parameters
Type Name Description
System.String searchResultsChange
Returns
Type Description
DocumentEditorBuilder

SelectionChange(String)

Triggers whenever selection changes in the document editor.

Declaration
public DocumentEditorBuilder SelectionChange(string selectionChange)
Parameters
Type Name Description
System.String selectionChange
Returns
Type Description
DocumentEditorBuilder

ServerActionSettings(Object)

Defines the settings of the DocumentEditor services

Declaration
public DocumentEditorBuilder ServerActionSettings(object serverActionSettings)
Parameters
Type Name Description
System.Object serverActionSettings
Returns
Type Description
DocumentEditorBuilder

ServiceFailure(String)

Triggers when the server side action fails.

Declaration
public DocumentEditorBuilder ServiceFailure(string serviceFailure)
Parameters
Type Name Description
System.String serviceFailure
Returns
Type Description
DocumentEditorBuilder

ServiceUrl(String)

Sfdt Service URL

Declaration
public DocumentEditorBuilder ServiceUrl(string serviceUrl)
Parameters
Type Name Description
System.String serviceUrl
Returns
Type Description
DocumentEditorBuilder

ShowComments(Boolean)

Show comment in the document.

Declaration
public DocumentEditorBuilder ShowComments(bool showComments = true)
Parameters
Type Name Description
System.Boolean showComments
Returns
Type Description
DocumentEditorBuilder

ShowRevisions(Boolean)

Shows revision changes in the document.

Declaration
public DocumentEditorBuilder ShowRevisions(bool showRevisions = true)
Parameters
Type Name Description
System.Boolean showRevisions
Returns
Type Description
DocumentEditorBuilder

TrackChange(String)

Triggers when TrackChanges enabled / disabled.

Declaration
public DocumentEditorBuilder TrackChange(string trackChange)
Parameters
Type Name Description
System.String trackChange
Returns
Type Description
DocumentEditorBuilder

UseCtrlClickToFollowHyperlink(Boolean)

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

Declaration
public DocumentEditorBuilder UseCtrlClickToFollowHyperlink(bool useCtrlClickToFollowHyperlink = true)
Parameters
Type Name Description
System.Boolean useCtrlClickToFollowHyperlink
Returns
Type Description
DocumentEditorBuilder

UserColor(String)

User Selection Highlight Color

Declaration
public DocumentEditorBuilder UserColor(string userColor)
Parameters
Type Name Description
System.String userColor
Returns
Type Description
DocumentEditorBuilder

ViewChange(String)

Triggers whenever container view changes in the document editor.

Declaration
public DocumentEditorBuilder ViewChange(string viewChange)
Parameters
Type Name Description
System.String viewChange
Returns
Type Description
DocumentEditorBuilder

Width(String)

Defines the width of the DocumentEditor component

Declaration
public DocumentEditorBuilder Width(string width)
Parameters
Type Name Description
System.String width
Returns
Type Description
DocumentEditorBuilder

ZIndex(Int32)

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

Declaration
public DocumentEditorBuilder ZIndex(int zIndex)
Parameters
Type Name Description
System.Int32 zIndex
Returns
Type Description
DocumentEditorBuilder

ZoomFactor(Double)

Gets or sets the zoom factor in document editor.

Declaration
public DocumentEditorBuilder ZoomFactor(double zoomFactor)
Parameters
Type Name Description
System.Double zoomFactor
Returns
Type Description
DocumentEditorBuilder

ZoomFactorChange(String)

Triggers whenever zoom factor changes in the document editor.

Declaration
public DocumentEditorBuilder ZoomFactorChange(string zoomFactorChange)
Parameters
Type Name Description
System.String zoomFactorChange
Returns
Type Description
DocumentEditorBuilder