Class DocumentEditorContainerBase

Represents the Document editor container base class.

Inheritance
System.Object
BaseComponent
DocumentEditorContainerBase
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.Blazor.DocumentEditorContainer
Assembly: Syncfusion.Blazor.dll
Syntax
public class DocumentEditorContainerBase : BaseComponent, IDisposable

Constructors

DocumentEditorContainerBase()

Declaration
public DocumentEditorContainerBase()

Properties

ChildContent

Child content.

Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment

CurrentUser

Current User

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

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

ID

Id variable.

Declaration
public override string ID { get; set; }
Property Value
Type Description
System.String
Overrides
Syncfusion.Blazor.BaseComponent.ID

jsProperty

Js property.

Declaration
protected override string jsProperty { get; set; }
Property Value
Type Description
System.String
Overrides

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

DocumentEditorContainer namespace.

Declaration
protected override string nameSpace { get; set; }
Property Value
Type Description
System.String
Overrides

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

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

GetDocumentEditor()

Gets DocumentEditor instance.

Declaration
public DocumentEditorModule GetDocumentEditor()
Returns
Type Description
DocumentEditorModule

GetJSNamespace()

Get the namespace value.

Declaration
public string GetJSNamespace()
Returns
Type Description
System.String

Namespace value.

GetToolbar()

Gets toolbar instance.

Declaration
public ToolbarModule GetToolbar()
Returns
Type Description
ToolbarModule

OnAfterRenderAsync(Boolean)

After component render.

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

Is the component rendered first time.
Returns
Type Description
System.Threading.Tasks.Task

Returns an asynchronous operation.
Overrides

OnInitializedAsync()

On control initialize.

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

Returns an asynchronous operation.
Overrides

OnParametersSetAsync()

On parameter set.

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

Resize(Nullable<Double>, Nullable<Double>)

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

Declaration
public Task Resize(Nullable<double> width = null, Nullable<double> height = null)
Parameters
Type Name Description
System.Nullable<System.Double> width
System.Nullable<System.Double> height
Returns
Type Description
System.Threading.Tasks.Task

SetDefaultCharacterFormat(CharacterFormatProperties)

Set the default character format for document editor container

Declaration
public Task SetDefaultCharacterFormat(CharacterFormatProperties characterFormat)
Parameters
Type Name Description
CharacterFormatProperties characterFormat
Returns
Type Description
System.Threading.Tasks.Task

SetDefaultParagraphFormat(ParagraphFormatProperties)

Set the default paragraph format for document editor container

Declaration
public Task SetDefaultParagraphFormat(ParagraphFormatProperties paragraphFormat)
Parameters
Type Name Description
ParagraphFormatProperties paragraphFormat
Returns
Type Description
System.Threading.Tasks.Task

SetDefaultSectionFormat(SectionFormatProperties)

Set the default section format for document editor container

Declaration
public Task SetDefaultSectionFormat(SectionFormatProperties sectionFormat)
Parameters
Type Name Description
SectionFormatProperties sectionFormat
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable