Class DocumentEditorContainerBuilder
Inheritance
System.Object
DocumentEditorContainerBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class DocumentEditorContainerBuilder : ControlBuilder
Constructors
DocumentEditorContainerBuilder()
Declaration
public DocumentEditorContainerBuilder()
DocumentEditorContainerBuilder(DocumentEditorContainer)
Declaration
public DocumentEditorContainerBuilder(DocumentEditorContainer model)
Parameters
Fields
model
Declaration
public DocumentEditorContainer model
Field Value
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
Triggers on comment actions(Post, edit, reply, resolve, reopen).
Declaration
public DocumentEditorContainerBuilder BeforeCommentAction(string beforeCommentAction)
Parameters
Type |
Name |
Description |
System.String |
beforeCommentAction |
|
Returns
BeforePaneSwitch(String)
Trigger before switching panes in DocumentEditor.
Declaration
public DocumentEditorContainerBuilder BeforePaneSwitch(string beforePaneSwitch)
Parameters
Type |
Name |
Description |
System.String |
beforePaneSwitch |
|
Returns
Triggers on deleting a comment.
Declaration
public DocumentEditorContainerBuilder CommentDelete(string commentDelete)
Parameters
Type |
Name |
Description |
System.String |
commentDelete |
|
Returns
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
ContentControl(String)
Triggers when user interaction prevented in content control.
Declaration
public DocumentEditorContainerBuilder ContentControl(string contentControl)
Parameters
Type |
Name |
Description |
System.String |
contentControl |
|
Returns
Created(String)
Triggers when the component is created
Declaration
public DocumentEditorContainerBuilder Created(string created)
Parameters
Type |
Name |
Description |
System.String |
created |
|
Returns
CurrentUser(String)
Declaration
public DocumentEditorContainerBuilder CurrentUser(string currentUser)
Parameters
Type |
Name |
Description |
System.String |
currentUser |
|
Returns
Triggers before opening the custom context-menu option.
Declaration
public DocumentEditorContainerBuilder CustomContextMenuBeforeOpen(string customContextMenuBeforeOpen)
Parameters
Type |
Name |
Description |
System.String |
customContextMenuBeforeOpen |
|
Returns
Triggers while selecting the custom context-menu option.
Declaration
public DocumentEditorContainerBuilder CustomContextMenuSelect(string customContextMenuSelect)
Parameters
Type |
Name |
Description |
System.String |
customContextMenuSelect |
|
Returns
Destroyed(String)
Triggers when the component is destroyed.
Declaration
public DocumentEditorContainerBuilder Destroyed(string destroyed)
Parameters
Type |
Name |
Description |
System.String |
destroyed |
|
Returns
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
DocumentEditorSettings(Object)
Defines the settings for DocumentEditor customization.
Declaration
public DocumentEditorContainerBuilder DocumentEditorSettings(object documentEditorSettings)
Parameters
Type |
Name |
Description |
System.Object |
documentEditorSettings |
|
Returns
Gets or set a value indicating whether comment is enabled or not
Declaration
public DocumentEditorContainerBuilder EnableComment(bool enableComment = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableComment |
|
Returns
EnableCsp(Boolean)
Enable rendering with strict Content Security policy.
Declaration
public DocumentEditorContainerBuilder EnableCsp(bool enableCsp = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableCsp |
|
Returns
EnableLocalPaste(Boolean)
Declaration
public DocumentEditorContainerBuilder EnableLocalPaste(bool enableLocalPaste = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableLocalPaste |
|
Returns
EnableLockAndEdit(Boolean)
Enable partial lock and edit module.
Declaration
public DocumentEditorContainerBuilder EnableLockAndEdit(bool enableLockAndEdit = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableLockAndEdit |
|
Returns
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
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
EnableSpellCheck(Boolean)
Enable or disable spell checker in document editor container.
Declaration
public DocumentEditorContainerBuilder EnableSpellCheck(bool enableSpellCheck = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableSpellCheck |
|
Returns
Enable or disable toolbar in document editor container.
Declaration
public DocumentEditorContainerBuilder EnableToolbar(bool enableToolbar = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableToolbar |
|
Returns
EnableTrackChanges(Boolean)
Enable or disable track changes in document editor container.
Declaration
public DocumentEditorContainerBuilder EnableTrackChanges(bool enableTrackChanges = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableTrackChanges |
|
Returns
Add custom headers to XMLHttpRequest.
Declaration
public DocumentEditorContainerBuilder Headers(object headers)
Parameters
Type |
Name |
Description |
System.Object |
headers |
|
Returns
Height(String)
Defines the height of the DocumentEditorContainer component
Declaration
public DocumentEditorContainerBuilder Height(string height)
Parameters
Type |
Name |
Description |
System.String |
height |
|
Returns
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
LayoutType(LayoutType)
Declaration
public DocumentEditorContainerBuilder LayoutType(LayoutType layoutType)
Parameters
Returns
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
Render()
Declaration
public HtmlString Render()
Returns
Type |
Description |
Microsoft.AspNetCore.Html.HtmlString |
|
RestrictEditing(Boolean)
Restrict editing operation.
Declaration
public DocumentEditorContainerBuilder RestrictEditing(bool restrictEditing = true)
Parameters
Type |
Name |
Description |
System.Boolean |
restrictEditing |
|
Returns
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
ServerActionSettings(Object)
Defines the settings of the DocumentEditorContainer service.
Declaration
public DocumentEditorContainerBuilder ServerActionSettings(object serverActionSettings)
Parameters
Type |
Name |
Description |
System.Object |
serverActionSettings |
|
Returns
ServiceFailure(String)
Triggers when the server action fails.
Declaration
public DocumentEditorContainerBuilder ServiceFailure(string serviceFailure)
Parameters
Type |
Name |
Description |
System.String |
serviceFailure |
|
Returns
ServiceUrl(String)
Declaration
public DocumentEditorContainerBuilder ServiceUrl(string serviceUrl)
Parameters
Type |
Name |
Description |
System.String |
serviceUrl |
|
Returns
ShowPropertiesPane(Boolean)
Show or hide properties pane.
Declaration
public DocumentEditorContainerBuilder ShowPropertiesPane(bool showPropertiesPane = true)
Parameters
Type |
Name |
Description |
System.Boolean |
showPropertiesPane |
|
Returns
Triggers when toolbar item is clicked.
Declaration
public DocumentEditorContainerBuilder ToolbarClick(string toolbarClick)
Parameters
Type |
Name |
Description |
System.String |
toolbarClick |
|
Returns
Defines toolbar items for DocumentEditorContainer.
Declaration
public DocumentEditorContainerBuilder ToolbarItems(object toolbarItems)
Parameters
Type |
Name |
Description |
System.Object |
toolbarItems |
|
Returns
TrackChange(String)
Triggers Keyboard shortcut of TrackChanges.
Declaration
public DocumentEditorContainerBuilder TrackChange(string trackChange)
Parameters
Type |
Name |
Description |
System.String |
trackChange |
|
Returns
UserColor(String)
User Selection Highlight Color
Declaration
public DocumentEditorContainerBuilder UserColor(string userColor)
Parameters
Type |
Name |
Description |
System.String |
userColor |
|
Returns
Width(String)
Defines the width of the DocumentEditorContainer component
Declaration
public DocumentEditorContainerBuilder Width(string width)
Parameters
Type |
Name |
Description |
System.String |
width |
|
Returns
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