Class DocumentEditorContainerBuilder

Inheritance

System.Object

ControlBuilder

DocumentEditorContainerBuilder

Inherited Members

ControlBuilder.Context

Namespace: Syncfusion.EJ2.DocumentEditor

Assembly: Syncfusion.EJ2.dll

Syntax

public class DocumentEditorContainerBuilder : ControlBuilder

Constructors

DocumentEditorContainerBuilder()

Declaration

public DocumentEditorContainerBuilder()

DocumentEditorContainerBuilder(DocumentEditorContainer)

Declaration

public DocumentEditorContainerBuilder(DocumentEditorContainer model)

Parameters

Type	Name	Description
DocumentEditorContainer	model

Fields

model

Declaration

public DocumentEditorContainer model

Field Value

Type	Description
DocumentEditorContainer

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

ControlBuilder.Output

Methods

BeforeCommentAction(String)

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

Declaration

public DocumentEditorContainerBuilder BeforeCommentAction(string beforeCommentAction)

Parameters

Type	Name	Description
System.String	beforeCommentAction

Returns

Type	Description
DocumentEditorContainerBuilder

BeforePaneSwitch(String)

Trigger before switching panes in DocumentEditor.

Declaration

public DocumentEditorContainerBuilder BeforePaneSwitch(string beforePaneSwitch)

Parameters

Type	Name	Description
System.String	beforePaneSwitch

Returns

Type	Description
DocumentEditorContainerBuilder

BeforeXmlHttpRequestSend(Object)

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

Declaration

public DocumentEditorContainerBuilder BeforeXmlHttpRequestSend(object beforeXmlHttpRequestSend)

Parameters

Type	Name	Description
System.Object	beforeXmlHttpRequestSend

Returns

Type	Description
DocumentEditorContainerBuilder

CommentDelete(String)

Triggers on deleting a comment.

Declaration

public DocumentEditorContainerBuilder CommentDelete(string commentDelete)

Parameters

Type	Name	Description
System.String	commentDelete

Returns

Type	Description
DocumentEditorContainerBuilder

ContentChange(String)

Triggers whenever the content changes in the document editor container.

Declaration

public DocumentEditorContainerBuilder ContentChange(string contentChange)

Parameters

Type	Name	Description
System.String	contentChange

Returns

Type	Description
DocumentEditorContainerBuilder

ContentControl(String)

Triggers when user interaction prevented in content control.

Declaration

public DocumentEditorContainerBuilder ContentControl(string contentControl)

Parameters

Type	Name	Description
System.String	contentControl

Returns

Type	Description
DocumentEditorContainerBuilder

Created(String)

Triggers when the component is created

Declaration

public DocumentEditorContainerBuilder Created(string created)

Parameters

Type	Name	Description
System.String	created

Returns

Type	Description
DocumentEditorContainerBuilder

CurrentUser(String)

Gets or sets the current user.

Declaration

public DocumentEditorContainerBuilder CurrentUser(string currentUser)

Parameters

Type	Name	Description
System.String	currentUser

Returns

Type	Description
DocumentEditorContainerBuilder

CustomContextMenuBeforeOpen(String)

Triggers before opening the custom context-menu option.

Declaration

public DocumentEditorContainerBuilder CustomContextMenuBeforeOpen(string customContextMenuBeforeOpen)

Parameters

Type	Name	Description
System.String	customContextMenuBeforeOpen

Returns

Type	Description
DocumentEditorContainerBuilder

CustomContextMenuSelect(String)

Triggers while selecting the custom context-menu option.

Declaration

public DocumentEditorContainerBuilder CustomContextMenuSelect(string customContextMenuSelect)

Parameters

Type	Name	Description
System.String	customContextMenuSelect

Returns

Type	Description
DocumentEditorContainerBuilder

Destroyed(String)

Triggers when the component is destroyed.

Declaration

public DocumentEditorContainerBuilder Destroyed(string destroyed)

Parameters

Type	Name	Description
System.String	destroyed

Returns

Type	Description
DocumentEditorContainerBuilder

DocumentChange(String)

Triggers whenever document changes in the document editor container.

Declaration

public DocumentEditorContainerBuilder DocumentChange(string documentChange)

Parameters

Type	Name	Description
System.String	documentChange

Returns

Type	Description
DocumentEditorContainerBuilder

DocumentEditorSettings(Object)

Defines the settings for DocumentEditor customization.

Declaration

public DocumentEditorContainerBuilder DocumentEditorSettings(object documentEditorSettings)

Parameters

Type	Name	Description
System.Object	documentEditorSettings

Returns

Type	Description
DocumentEditorContainerBuilder

DocumentSettings(Object)

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

Declaration

public DocumentEditorContainerBuilder DocumentSettings(object documentSettings)

Parameters

Type	Name	Description
System.Object	documentSettings

Returns

Type	Description
DocumentEditorContainerBuilder

EnableAutoFocus(Boolean)

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

Declaration

public DocumentEditorContainerBuilder EnableAutoFocus(bool enableAutoFocus = true)

Parameters

Type	Name	Description
System.Boolean	enableAutoFocus

Returns

Type	Description
DocumentEditorContainerBuilder

EnableComment(Boolean)

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

Declaration

public DocumentEditorContainerBuilder EnableComment(bool enableComment = true)

Parameters

Type	Name	Description
System.Boolean	enableComment

Returns

Type	Description
DocumentEditorContainerBuilder

EnableCsp(Boolean)

Enables the rendering with strict Content Security policy.

Declaration

public DocumentEditorContainerBuilder EnableCsp(bool enableCsp = true)

Parameters

Type	Name	Description
System.Boolean	enableCsp

Returns

Type	Description
DocumentEditorContainerBuilder

EnableLocalPaste(Boolean)

Enables the local paste.

Declaration

public DocumentEditorContainerBuilder EnableLocalPaste(bool enableLocalPaste = true)

Parameters

Type	Name	Description
System.Boolean	enableLocalPaste

Returns

Type	Description
DocumentEditorContainerBuilder

EnableLockAndEdit(Boolean)

Enables the partial lock and edit module.

Declaration

public DocumentEditorContainerBuilder EnableLockAndEdit(bool enableLockAndEdit = true)

Parameters

Type	Name	Description
System.Boolean	enableLockAndEdit

Returns

Type	Description
DocumentEditorContainerBuilder

EnablePersistence(Boolean)

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

Declaration

public DocumentEditorContainerBuilder EnablePersistence(bool enablePersistence = true)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
DocumentEditorContainerBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration

public DocumentEditorContainerBuilder EnableRtl(bool enableRtl = true)

Parameters

Type	Name	Description
System.Boolean	enableRtl

Returns

Type	Description
DocumentEditorContainerBuilder

EnableSpellCheck(Boolean)

Enable or disable the spell checker in document editor container.

Declaration

public DocumentEditorContainerBuilder EnableSpellCheck(bool enableSpellCheck = true)

Parameters

Type	Name	Description
System.Boolean	enableSpellCheck

Returns

Type	Description
DocumentEditorContainerBuilder

EnableToolbar(Boolean)

Enable or disable the toolbar in document editor container.

Declaration

public DocumentEditorContainerBuilder EnableToolbar(bool enableToolbar = true)

Parameters

Type	Name	Description
System.Boolean	enableToolbar

Returns

Type	Description
DocumentEditorContainerBuilder

EnableTrackChanges(Boolean)

Enable or disable the track changes in document editor container.

Declaration

public DocumentEditorContainerBuilder EnableTrackChanges(bool enableTrackChanges = true)

Parameters

Type	Name	Description
System.Boolean	enableTrackChanges

Returns

Type	Description
DocumentEditorContainerBuilder

Headers(Object)

Adds the custom headers to XMLHttpRequest.

Declaration

public DocumentEditorContainerBuilder Headers(object headers)

Parameters

Type	Name	Description
System.Object	headers

Returns

Type	Description
DocumentEditorContainerBuilder

Height(String)

Defines the height of the DocumentEditorContainer component

Declaration

public DocumentEditorContainerBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height

Returns

Type	Description
DocumentEditorContainerBuilder

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 DocumentEditorContainerBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
DocumentEditorContainerBuilder

LayoutType(LayoutType)

Gets or sets the Layout Type.

Declaration

public DocumentEditorContainerBuilder LayoutType(LayoutType layoutType)

Parameters

Type	Name	Description
LayoutType	layoutType

Returns

Type	Description
DocumentEditorContainerBuilder

Locale(String)

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

Declaration

public DocumentEditorContainerBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
DocumentEditorContainerBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
Microsoft.AspNetCore.Html.HtmlString

RestrictEditing(Boolean)

Specifies the restrict editing operation.

Declaration

public DocumentEditorContainerBuilder RestrictEditing(bool restrictEditing = true)

Parameters

Type	Name	Description
System.Boolean	restrictEditing

Returns

Type	Description
DocumentEditorContainerBuilder

SelectionChange(String)

Triggers whenever selection changes in the document editor container.

Declaration

public DocumentEditorContainerBuilder SelectionChange(string selectionChange)

Parameters

Type	Name	Description
System.String	selectionChange

Returns

Type	Description
DocumentEditorContainerBuilder

ServerActionSettings(Object)

Defines the settings of the DocumentEditorContainer service.

Declaration

public DocumentEditorContainerBuilder ServerActionSettings(object serverActionSettings)

Parameters

Type	Name	Description
System.Object	serverActionSettings

Returns

Type	Description
DocumentEditorContainerBuilder

ServiceFailure(String)

Triggers when the server action fails.

Declaration

public DocumentEditorContainerBuilder ServiceFailure(string serviceFailure)

Parameters

Type	Name	Description
System.String	serviceFailure

Returns

Type	Description
DocumentEditorContainerBuilder

ServiceUrl(String)

Gets or sets the Sfdt service URL.

Declaration

public DocumentEditorContainerBuilder ServiceUrl(string serviceUrl)

Parameters

Type	Name	Description
System.String	serviceUrl

Returns

Type	Description
DocumentEditorContainerBuilder

ShowPropertiesPane(Boolean)

Show or hide properties pane.

Declaration

public DocumentEditorContainerBuilder ShowPropertiesPane(bool showPropertiesPane = true)

Parameters

Type	Name	Description
System.Boolean	showPropertiesPane

Returns

Type	Description
DocumentEditorContainerBuilder

ToolbarClick(String)

Triggers when toolbar item is clicked.

Declaration

public DocumentEditorContainerBuilder ToolbarClick(string toolbarClick)

Parameters

Type	Name	Description
System.String	toolbarClick

Returns

Type	Description
DocumentEditorContainerBuilder

ToolbarItems(Object)

Defines toolbar items for DocumentEditorContainer.

Declaration

public DocumentEditorContainerBuilder ToolbarItems(object toolbarItems)

Parameters

Type	Name	Description
System.Object	toolbarItems

Returns

Type	Description
DocumentEditorContainerBuilder

TrackChange(String)

Triggers Keyboard shortcut of TrackChanges.

Declaration

public DocumentEditorContainerBuilder TrackChange(string trackChange)

Parameters

Type	Name	Description
System.String	trackChange

Returns

Type	Description
DocumentEditorContainerBuilder

UserColor(String)

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 DocumentEditorContainerBuilder UserColor(string userColor)

Parameters

Type	Name	Description
System.String	userColor

Returns

Type	Description
DocumentEditorContainerBuilder

Width(String)

Defines the width of the DocumentEditorContainer component

Declaration

public DocumentEditorContainerBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
DocumentEditorContainerBuilder

ZIndex(Int32)

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

Declaration

public DocumentEditorContainerBuilder ZIndex(int zIndex)

Parameters

Type	Name	Description
System.Int32	zIndex

Returns

Type	Description
DocumentEditorContainerBuilder