Class SfDocumentEditorContainer

Document Editor Container component.

Inheritance

System.Object

SfDocumentEditorContainer

Implements

IDocumentEditorContainer

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; set; }

Property Value

Type	Description
SfDocumentEditor

DocumentEditorSettings

Defines the settings for DocumentEditor customization.

Declaration

public DocumentEditorSettingsModel DocumentEditorSettings { get; set; }

Property Value

Type	Description
DocumentEditorSettingsModel

DocumentSettings

Gets the DocumentSettings instance of the document that is opened in Document editor component.

Declaration

public DocumentSettings DocumentSettings { get; set; }

Property Value

Type	Description
DocumentSettings	The DocumentSettings intance of the document.

Remarks

This property provides an option to modify the compatibility mode of the active document, when a new document is created, or an existing document is opened. You can modify it in DocumentEditorEvents event.

Examples

The following code example demonstrates how to modify compatibility mode for the document opened in Syncfusion Word Processor (Document editor) component.

//Sets compatibility mode for the active document as Word 2010.
sfDocumentEditor.DocumentSettings.CompatibilityMode = CompatibilityMode.Word2010;

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

UseDefaultEditor

Gets or sets a value that indicates whether to display the default SfDocumentEditor instance initialized within the SfDocumentEditorContainer or the SfDocumentEditor instance defined in the application.

Declaration

public bool UseDefaultEditor { get; set; }

Property Value

Type	Description
System.Boolean	True The default value is true Otherwise False SfDocumentEditor instance defined in the application level (Razor file) should be rendered instead of the default SfDocumentEditor instance initialized within the SfDocumentEditorContainer component.

Examples

The following code example demonstrates how to define the SfDocumentEditor instance in the Blazor application level Razor file.

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

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

ResizeAsync(Nullable<Double>, Nullable<Double>)

Resizes the container component and its sub elements based on given size or client size.

Declaration

public Task ResizeAsync(Nullable<double> width = null, Nullable<double> height = null)

Parameters

Type	Name	Description
System.Nullable<System.Double>	width	Specifies the width.
System.Nullable<System.Double>	height	Specifies the height.

Returns

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

ShouldRender()

Declaration

protected override bool ShouldRender()

Returns

Type	Description
System.Boolean

Implements

IDocumentEditorContainer