Class DocumentEditorContainer

Inheritance

System.Object

EJTagHelper

DocumentEditorContainer

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 DocumentEditorContainer : EJTagHelper

Constructors

DocumentEditorContainer()

Declaration

public DocumentEditorContainer()

Properties

BeforeCommentAction

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

Declaration

public string BeforeCommentAction { get; set; }

Property Value

Type	Description
System.String

BeforePaneSwitch

Trigger before switching panes in DocumentEditor.

Declaration

public string BeforePaneSwitch { get; set; }

Property Value

Type	Description
System.String

BeforeXmlHttpRequestSend

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

Declaration

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

EJTagHelper.ClassName

CommentDelete

Triggers on deleting a comment.

Declaration

public string CommentDelete { get; set; }

Property Value

Type	Description
System.String

ContentChange

Triggers whenever the content changes in the document editor container.

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

Gets or sets the 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

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 container.

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

DocumentSettings

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

Declaration

public object DocumentSettings { get; set; }

Property Value

Type	Description
System.Object

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

EnableCsp

Enable rendering with strict Content Security policy.

Declaration

public bool EnableCsp { get; set; }

Property Value

Type	Description
System.Boolean

EnableLocalPaste

Enable local paste

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

EnablePersistence

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

Declaration

public bool EnablePersistence { 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

EnableSpellCheck

Enable or disable spell checker in document editor container.

Declaration

public bool EnableSpellCheck { get; set; }

Property Value

Type	Description
System.Boolean

EnableToolbar

Enable or disable toolbar in document editor container.

Declaration

public bool EnableToolbar { get; set; }

Property Value

Type	Description
System.Boolean

EnableTrackChanges

Enable or disable track changes in document editor container.

Declaration

public bool EnableTrackChanges { 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 DocumentEditorContainer 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

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

RestrictEditing

Restrict editing operation.

Declaration

public bool RestrictEditing { get; set; }

Property Value

Type	Description
System.Boolean

SelectionChange

Triggers whenever selection changes in the document editor container.

Declaration

public string SelectionChange { get; set; }

Property Value

Type	Description
System.String

ServerActionSettings

Defines the settings of the DocumentEditorContainer service.

Declaration

public object ServerActionSettings { get; set; }

Property Value

Type	Description
System.Object

ServiceFailure

Triggers when the server 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

ShowPropertiesPane

Show or hide properties pane.

Declaration

public bool ShowPropertiesPane { get; set; }

Property Value

Type	Description
System.Boolean

TagName

Declaration

protected override string TagName { get; }

Property Value

Type	Description
System.String

Overrides

EJTagHelper.TagName

ToolbarClick

Triggers when toolbar item is clicked.

Declaration

public string ToolbarClick { get; set; }

Property Value

Type	Description
System.String

ToolbarItems

Defines toolbar items for DocumentEditorContainer.

Declaration

public object ToolbarItems { get; set; }

Property Value

Type	Description
System.Object

TrackChange

Triggers Keyboard shortcut of TrackChanges.

Declaration

public string TrackChange { get; set; }

Property Value

Type	Description
System.String

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

public string UserColor { get; set; }

Property Value

Type	Description
System.String

Width

Defines the width of the DocumentEditorContainer 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