Class SfDocumentEditorContainer

Document Editor Container component.

Inheritance
System.Object
SfDocumentEditorContainer
Namespace: Syncfusion.Blazor.DocumentEditor
Assembly: Syncfusion.Blazor.DocumentEditor.dll
Syntax
public class SfDocumentEditorContainer : SfBaseComponent, IDocumentEditorContainer

Constructors

SfDocumentEditorContainer()

Declaration
public SfDocumentEditorContainer()

Properties

CurrentUser

Current User.

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

DocumentEditor

Gets DocumentEditor instance.

Declaration
public SfDocumentEditor DocumentEditor { get; }
Property Value
Type Description
SfDocumentEditor

DocumentEditorSettings

Defines the settings for DocumentEditor customization.

Declaration
public DocumentEditorSettingsModel DocumentEditorSettings { get; set; }
Property Value
Type Description
DocumentEditorSettingsModel

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

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 Dictionary<string, string> Headers { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.String>

Height

Defines the height of the DocumentEditorContainer component.

Declaration
public string Height { 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

RestrictEditing

Restrict editing operation.

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

ServerActionSettings

Defines the settings of the DocumentEditorContainer service.

Declaration
public ContainerServerActionSettingsModel ServerActionSettings { get; set; }
Property Value
Type Description
ContainerServerActionSettingsModel

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

Toolbar

Gets toolbar instance.

Declaration
public ToolbarModule Toolbar { get; }
Property Value
Type Description
ToolbarModule

ToolbarItems

Defines toolbar items for DocumentEditorContainer.

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

UserColor

User Selection Highlight Color.

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 double ZIndex { get; set; }
Property Value
Type Description
System.Double

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

GetDocumentEditor()

Gets DocumentEditor instance.

Declaration
public SfDocumentEditor GetDocumentEditor()
Returns
Type Description
SfDocumentEditor

Returns SfDocumentEditor Module.

GetToolbar()

Gets toolbar instance.

Declaration
public ToolbarModule GetToolbar()
Returns
Type Description
ToolbarModule

Returns ToolbarModule.

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
System.Boolean firstRender
Returns
Type Description
System.Threading.Tasks.Task

OnHybridInitialized()

Method invokes after component initialize.

Declaration
protected Task OnHybridInitialized()
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing the asynchronous operation.

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
System.Threading.Tasks.Task

ShouldRender()

Declaration
protected override bool ShouldRender()
Returns
Type Description
System.Boolean

Implements