Class DocumentEditorBase

Represents the Document editor base class.

Inheritance

System.Object

BaseComponent

DocumentEditorBase

DocumentEditorModule

Implements

System.IDisposable

Inherited Members

BaseComponent.CreateJsAdaptor()

BaseComponent.Dispose()

BaseComponent.Refresh()

BaseComponent.clearClientChanges(Boolean)

BaseComponent.InvokeSet<T>(String, String, Object[])

BaseComponent.InvokeGet<T>(String, String)

BaseComponent.WireObservableEvents(Object)

BaseComponent.getSerializedModel()

BaseComponent.getUpdateModel(Boolean)

BaseComponent.GetDataManager(Object, String)

BaseComponent.uniqueId

BaseComponent.jsRuntime

BaseComponent.EditContext

BaseComponent.mainParent

BaseComponent.DotNetObjectRef

Namespace: Syncfusion.Blazor.DocumentEditor

Assembly: Syncfusion.Blazor.dll

Syntax

public class DocumentEditorBase : BaseComponent, IDisposable

Constructors

DocumentEditorBase()

Declaration

public DocumentEditorBase()

Properties

AcceptTab

Gets or Sets a value indicating whether tab key can be accepted as input or not.

Declaration

public bool AcceptTab { get; set; }

Property Value

Type	Description
System.Boolean

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

DefaultPasteOption

Default Paste Formatting Options

Declaration

public PasteOptions DefaultPasteOption { get; set; }

Property Value

Type	Description
PasteOptions

DocumentEditorSettings

Defines the settings for DocumentEditor customization.

Declaration

public DocumentEditorSettingsModel DocumentEditorSettings { get; set; }

Property Value

Type	Description
DocumentEditorSettingsModel

DocumentName

Gets or sets the name of the document.

Declaration

public string DocumentName { get; set; }

Property Value

Type	Description
System.String

EnableBookmarkDialog

Gets or sets a value indicating whether bookmark dialog is enabled or not.

Declaration

public bool EnableBookmarkDialog { get; set; }

Property Value

Type	Description
System.Boolean

EnableBordersAndShadingDialog

Gets or sets a value indicating whether borders and shading dialog is enabled or not.

Declaration

public bool EnableBordersAndShadingDialog { get; set; }

Property Value

Type	Description
System.Boolean

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

EnableContextMenu

Gets or sets a value indicating whether context menu is enabled or not.

Declaration

public bool EnableContextMenu { get; set; }

Property Value

Type	Description
System.Boolean

EnableCursorOnReadOnly

Gets or sets a value indicating whether to enable cursor in document editor on read only state or not. The default value is false.

Declaration

public bool EnableCursorOnReadOnly { get; set; }

Property Value

Type	Description
System.Boolean

EnableEditor

Gets or sets a value indicating whether editor needs to be enabled or not.

Declaration

public bool EnableEditor { get; set; }

Property Value

Type	Description
System.Boolean

EnableEditorHistory

Gets or sets a value indicating whether editor history needs to be enabled or not.

Declaration

public bool EnableEditorHistory { get; set; }

Property Value

Type	Description
System.Boolean

EnableFontDialog

Gets or sets a value indicating whether font dialog is enabled or not.

Declaration

public bool EnableFontDialog { get; set; }

Property Value

Type	Description
System.Boolean

EnableFootnoteAndEndnoteDialog

Gets or sets a value indicating whether notes dialog is enabled or not.

Declaration

public bool EnableFootnoteAndEndnoteDialog { get; set; }

Property Value

Type	Description
System.Boolean

EnableFormField

Gets or set a value indicating whether form fields is enabled or not.

Declaration

public bool EnableFormField { get; set; }

Property Value

Type	Description
System.Boolean

EnableHyperlinkDialog

Gets or sets a value indicating whether hyperlink dialog is enabled or not.

Declaration

public bool EnableHyperlinkDialog { get; set; }

Property Value

Type	Description
System.Boolean

EnableImageResizer

Gets or sets a value indicating whether image resizer is enabled or not.

Declaration

public bool EnableImageResizer { get; set; }

Property Value

Type	Description
System.Boolean

EnableListDialog

Gets or sets a value indicating whether list dialog is enabled or not.

Declaration

public bool EnableListDialog { get; set; }

Property Value

Type	Description
System.Boolean

EnableLocalPaste

Gets or sets a value indicating whether local paste needs to be enabled or not.

Declaration

public bool EnableLocalPaste { get; set; }

Property Value

Type	Description
System.Boolean

EnableOptionsPane

Gets or sets a value indicating whether options pane is enabled or not.

Declaration

public bool EnableOptionsPane { get; set; }

Property Value

Type	Description
System.Boolean

EnablePageSetupDialog

Gets or sets a value indicating whether margin dialog is enabled or not.

Declaration

public bool EnablePageSetupDialog { get; set; }

Property Value

Type	Description
System.Boolean

EnableParagraphDialog

Gets or sets a value indicating whether paragraph dialog is enabled or not.

Declaration

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

EnablePrint

Gets or sets a value indicating whether print needs to be enabled or not.

Declaration

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

EnableSearch

Gets or sets a value indicating whether search module is enabled or not.

Declaration

public bool EnableSearch { get; set; }

Property Value

Type	Description
System.Boolean

EnableSelection

Gets or sets a value indicating whether selection needs to be enabled or not.

Declaration

public bool EnableSelection { get; set; }

Property Value

Type	Description
System.Boolean

EnableSfdtExport

Gets or sets a value indicating whether Sfdt export needs to be enabled or not.

Declaration

public bool EnableSfdtExport { get; set; }

Property Value

Type	Description
System.Boolean

EnableSpellCheck

Gets or sets a value indicating whether editor need to be spell checked.

Declaration

public bool EnableSpellCheck { get; set; }

Property Value

Type	Description
System.Boolean

EnableStyleDialog

Gets or sets a value indicating whether font dialog is enabled or not.

Declaration

public bool EnableStyleDialog { get; set; }

Property Value

Type	Description
System.Boolean

EnableTableDialog

Gets or sets a value indicating whether table dialog is enabled or not.

Declaration

public bool EnableTableDialog { get; set; }

Property Value

Type	Description
System.Boolean

EnableTableOfContentsDialog

Gets or sets a value indicating whether table of contents dialog is enabled or not.

Declaration

public bool EnableTableOfContentsDialog { get; set; }

Property Value

Type	Description
System.Boolean

EnableTableOptionsDialog

Gets or sets a value indicating whether table options dialog is enabled or not.

Declaration

public bool EnableTableOptionsDialog { get; set; }

Property Value

Type	Description
System.Boolean

EnableTablePropertiesDialog

Gets or sets a value indicating whether table properties dialog is enabled or not.

Declaration

public bool EnableTablePropertiesDialog { get; set; }

Property Value

Type	Description
System.Boolean

EnableTextExport

Gets or sets a value indicating whether text export needs to be enabled or not.

Declaration

public bool EnableTextExport { get; set; }

Property Value

Type	Description
System.Boolean

EnableTrackChanges

Gets or set a value indicating whether track changes is enabled or not.

Declaration

public bool EnableTrackChanges { get; set; }

Property Value

Type	Description
System.Boolean

EnableWordExport

Gets or sets a value indicating whether word export needs to be enabled or not.

Declaration

public bool EnableWordExport { 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 DocumentEditor 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

IsReadOnly

Gets or sets a value indicating whether the document editor is in read only state or not.

Declaration

public bool IsReadOnly { get; set; }

Property Value

Type	Description
System.Boolean

jsProperty

Js property.

Declaration

protected override string jsProperty { get; set; }

Property Value

Type	Description
System.String

Overrides

BaseComponent.jsProperty

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

DocumentEditor namespace.

Declaration

protected override string nameSpace { get; set; }

Property Value

Type	Description
System.String

Overrides

BaseComponent.nameSpace

PageGap

Gets or sets the page gap value in document editor

Declaration

public double PageGap { get; set; }

Property Value

Type	Description
System.Double

PageOutline

Gets or sets the page outline color.

Declaration

public string PageOutline { get; set; }

Property Value

Type	Description
System.String

ServerActionSettings

Defines the settings of the DocumentEditor services

Declaration

public ServerActionSettingsModel ServerActionSettings { get; set; }

Property Value

Type	Description
ServerActionSettingsModel

ServiceUrl

Sfdt Service URL

Declaration

public string ServiceUrl { get; set; }

Property Value

Type	Description
System.String

ShowComments

Show comment in the document.

Declaration

public bool ShowComments { get; set; }

Property Value

Type	Description
System.Boolean

ShowRevisions

Shows revision changes in the document.

Declaration

public bool ShowRevisions { get; set; }

Property Value

Type	Description
System.Boolean

UseCtrlClickToFollowHyperlink

Gets or Sets a value indicating whether holding Ctrl key is required to follow hyperlink on click. The default value is true.

Declaration

public bool UseCtrlClickToFollowHyperlink { get; set; }

Property Value

Type	Description
System.Boolean

UserColor

User Selection Highlight Color

Declaration

public string UserColor { get; set; }

Property Value

Type	Description
System.String

Width

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

ZoomFactor

Gets or sets the zoom factor in document editor.

Declaration

public double ZoomFactor { get; set; }

Property Value

Type	Description
System.Double

Methods

EnableAllModules()

Enables all the modules.

Declaration

public Task EnableAllModules()

Returns

Type	Description
System.Threading.Tasks.Task

ExportFormData()

Export form field values.

Declaration

public Task<List<FormFieldData>> ExportFormData()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<FormFieldData>>

FitPage(Nullable<PageFitType>)

Fits the page based on given fit type.

Declaration

public Task FitPage(Nullable<PageFitType> pageFitType = null)

Parameters

Type	Name	Description
System.Nullable<PageFitType>	pageFitType

Returns

Type	Description
System.Threading.Tasks.Task

FocusIn()

Shifts the focus to the document.

Declaration

public Task FocusIn()

Returns

Type	Description
System.Threading.Tasks.Task

GetBookmarks()

Gets the bookmarks.

Declaration

public Task<List<string>> GetBookmarks()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.String>>

GetContextMenu()

Gets the context menu object of the document editor.

Declaration

public ContextMenuModule GetContextMenu()

Returns

Type	Description
ContextMenuModule

GetEditor()

Gets the editor object of the document editor.

Declaration

public EditorModule GetEditor()

Returns

Type	Description
EditorModule

GetEditorHistory()

Gets the editor history object of the document editor.

Declaration

public EditorHistoryModule GetEditorHistory()

Returns

Type	Description
EditorHistoryModule

GetFormFieldInfo(String)

Get form field by name

Declaration

public Task<FormFieldInfo> GetFormFieldInfo(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Threading.Tasks.Task<FormFieldInfo>

GetFormFieldNames()

Get all form field names.

Declaration

public Task<List<string>> GetFormFieldNames()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.String>>

GetJSNamespace()

Get the namespace value.

Declaration

public string GetJSNamespace()

Returns

Type	Description
System.String	Namespace value.

GetPageCount()

Gets the total number of pages.

Declaration

public Task<int> GetPageCount()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

GetSearch()

Gets the search object of the document editor.

Declaration

public SearchModule GetSearch()

Returns

Type	Description
SearchModule

GetSelection()

Gets the selection object of the document editor.

Declaration

public SelectionModule GetSelection()

Returns

Type	Description
SelectionModule

GetSpellChecker()

Gets the spell check object of the document editor.

Declaration

public SpellCheckerModule GetSpellChecker()

Returns

Type	Description
SpellCheckerModule

GetStyleNames(Nullable<StyleType>)

Gets the style names based on given style type.

Declaration

public Task<List<string>> GetStyleNames(Nullable<StyleType> styleType = null)

Parameters

Type	Name	Description
System.Nullable<StyleType>	styleType

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.String>>

GetStyles(Nullable<StyleType>)

Gets the style objects on given style type.

Declaration

public Task<List<object>> GetStyles(Nullable<StyleType> styleType = null)

Parameters

Type	Name	Description
System.Nullable<StyleType>	styleType

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.Object>>

ImportFormData(List<FormFieldData>)

Import form field values.

Declaration

public Task ImportFormData(List<FormFieldData> formData)

Parameters

Type	Name	Description
System.Collections.Generic.List<FormFieldData>	formData

Returns

Type	Description
System.Threading.Tasks.Task

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

BaseComponent.OnAfterRenderAsync(Boolean)

OnInitializedAsync()

On control initialize.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Returns an asynchronous operation.

Overrides

BaseComponent.OnInitializedAsync()

OnParametersSetAsync()

On parameter set.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Returns an asynchronous operation.

Open(String)

Opens the given Sfdt text.

Declaration

public Task Open(string sfdtText)

Parameters

Type	Name	Description
System.String	sfdtText

Returns

Type	Description
System.Threading.Tasks.Task

OpenBlank()

Opens a blank document.

Declaration

public Task OpenBlank()

Returns

Type	Description
System.Threading.Tasks.Task

Print()

Prints the document.

Declaration

public Task Print()

Returns

Type	Description
System.Threading.Tasks.Task

ResetFormFields(String)

Reset form field value to default.

Declaration

public Task ResetFormFields(string name = null)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Threading.Tasks.Task

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

Resizes the component and its sub elements based on given size or container 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

Save(String, Nullable<FormatType>)

Saves the document.

Declaration

public Task Save(string fileName, Nullable<FormatType> formatType = null)

Parameters

Type	Name	Description
System.String	fileName
System.Nullable<FormatType>	formatType

Returns

Type	Description
System.Threading.Tasks.Task

SaveAsBlob(Nullable<FormatType>)

Saves the document as blob.

Declaration

public Task<string> SaveAsBlob(Nullable<FormatType> formatType = null)

Parameters

Type	Name	Description
System.Nullable<FormatType>	formatType

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

ScrollToPage(Double)

Scrolls view to start of the given page number if exists.

Declaration

public Task<bool> ScrollToPage(double pageNumber)

Parameters

Type	Name	Description
System.Double	pageNumber

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

Serialize()

Serialize the data to JSON string.

Declaration

public Task<string> Serialize()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

SetDefaultCharacterFormat(CharacterFormatProperties)

Set the default character format for document editor

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

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

Declaration

public Task SetDefaultSectionFormat(SectionFormatProperties sectionFormat)

Parameters

Type	Name	Description
SectionFormatProperties	sectionFormat

Returns

Type	Description
System.Threading.Tasks.Task

SetFormFieldInfo(String, FormFieldInfo)

Set form field.

Declaration

public Task SetFormFieldInfo(string name, FormFieldInfo formFieldInfo)

Parameters

Type	Name	Description
System.String	name
FormFieldInfo	formFieldInfo

Returns

Type	Description
System.Threading.Tasks.Task

ShowDialog(DialogType)

Shows the dialog.

Declaration

public Task ShowDialog(DialogType dialogType)

Parameters

Type	Name	Description
DialogType	dialogType

Returns

Type	Description
System.Threading.Tasks.Task

ShowOptionsPane()

Shows the options pane.

Declaration

public Task ShowOptionsPane()

Returns

Type	Description
System.Threading.Tasks.Task

UpdateFields()

Updated fields in document. Currently cross reference field only supported.

Declaration

public Task UpdateFields()

Returns

Type	Description
System.Threading.Tasks.Task

Implements

System.IDisposable