Class SfDocumentEditor
Document Editor component.
Inheritance
Implements
Namespace: Syncfusion.Blazor.DocumentEditor
Assembly: Syncfusion.Blazor.DocumentEditor.dll
Syntax
public class SfDocumentEditor : SfBaseComponent, IDocumentEditor
Constructors
SfDocumentEditor()
Declaration
public SfDocumentEditor()
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 |
|
Container
Document Editor Container component.
Declaration
public SfDocumentEditorContainer Container { get; set; }
Property Value
Type | Description |
---|---|
SfDocumentEditorContainer | An instance of the SfDocumentEditorContainer class that represents the Document Editor Container. |
ContextMenu
Gets the context menu object of the document editor.
Declaration
public ContextMenuModule ContextMenu { get; }
Property Value
Type | Description |
---|---|
ContextMenuModule | An instance of the ContextMenuModule class that represents the context menu of the document editor. |
CurrentUser
Current User.
Declaration
public string CurrentUser { get; set; }
Property Value
Type | Description |
---|---|
System.String | Accepts the string value. The default value is empty. |
DefaultContainer
For internal purpose. Gets the SfDocumentEditorContainer instance, linked to the SfDocumentEditor component.
Declaration
public SfDocumentEditorContainer DefaultContainer { get; set; }
Property Value
Type | Description |
---|---|
SfDocumentEditorContainer | An instance of the SfDocumentEditorContainer class that represents the container linked to the SfDocumentEditor component. |
DefaultPasteOption
Default Paste Formatting Options.
Declaration
public PasteOptions DefaultPasteOption { get; set; }
Property Value
Type | Description |
---|---|
PasteOptions | The default paste formatting options for the DocumentEditorContainer. The default value is KeepSourceFormatting. |
DocumentEditorSettings
Defines the settings for DocumentEditor customization.
Declaration
public DocumentEditorSettingsModel DocumentEditorSettings { get; set; }
Property Value
Type | Description |
---|---|
DocumentEditorSettingsModel | A DocumentEditorSettingsModel object that defines the settings for customizing the DocumentEditor. |
DocumentName
Gets or sets the name of the document.
Declaration
public string DocumentName { get; set; }
Property Value
Type | Description |
---|---|
System.String | Accepts the string value. The default value is empty. |
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;
Editor
Gets the editor object of the document editor.
Declaration
public EditorModule Editor { get; }
Property Value
Type | Description |
---|---|
EditorModule | An instance of the EditorModule class that represents the editor object of the document editor. |
EditorHistory
Gets the editor history object of the document editor.
Declaration
public EditorHistoryModule EditorHistory { get; }
Property Value
Type | Description |
---|---|
EditorHistoryModule | An instance of the EditorHistoryModule class that represents the editor history object of the document editor. |
EnableAutoFocus
Gets or sets a value indicating whether the automatic focus behavior is enabled for Document editor or not. The default value is false.
Declaration
public bool EnableAutoFocus { get; set; }
Property Value
Type |
---|
System.Boolean |
Remarks
By default, the Document editor gets focused automatically when the page loads. If you want the Document editor not to be focused automatically, then set this property to false.
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 |
|
EnableChunkMessages
Gets or sets a Boolean value indicating whether to allow processing large files without increasing the maximum message size of a single incoming hub message (MaximumReceiveMessageSize 32KB). The default value is false.
Declaration
public bool EnableChunkMessages { get; set; }
Property Value
Type |
---|
System.Boolean |
EnableColumnsDialog
Gets or sets a value indicating whether margin dialog is enabled or not.
Declaration
public bool EnableColumnsDialog { 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 |
|
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 |
|
EnableNotesDialog
Gets or sets a value indicating whether Notes dialog is enabled or not.
Declaration
public bool EnableNotesDialog { 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 object[] Headers { get; set; }
Property Value
Type | Description |
---|---|
System.Object[] | An array of objects representing custom headers to be added to the XMLHttpRequest. |
Height
Defines the height of the DocumentEditor component.
Declaration
public string Height { get; set; }
Property Value
Type | Description |
---|---|
System.String | Accepts the string value. The default value is |
ID
Defines the ID of the component.
Declaration
public string ID { get; set; }
Property Value
Type | Description |
---|---|
System.String | Accepts the string value. |
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 |
|
LayoutType
Layout Type.
Declaration
public LayoutType LayoutType { get; set; }
Property Value
Type | Description |
---|---|
LayoutType | One of the LayoutType enumeration values that specifies the type of layout. The default value is <LayoutType.Pages></LayoutType.Pages>. |
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 | Accepts the string value. The default value is empty. |
PageGap
Gets or sets the page gap value in document editor.
Declaration
public double PageGap { get; set; }
Property Value
Type | Description |
---|---|
System.Double | Accepts the double value representing the page gap of document editor. The default value is |
PageOutline
Gets or sets the page outline color.
Declaration
public string PageOutline { get; set; }
Property Value
Type | Description |
---|---|
System.String | Accepts the string value. The default value is |
Search
Gets the search object of the document editor.
Declaration
public SearchModule Search { get; }
Property Value
Type | Description |
---|---|
SearchModule | The search object of the document editor, which allows searching for and highlighting text within the document. |
Selection
Gets the selection object of the document editor.
Declaration
public SelectionModule Selection { get; }
Property Value
Type | Description |
---|---|
SelectionModule | The selection object of the document editor, which allows manipulating the selection of text within the document. |
ServerActionSettings
Defines the settings of the DocumentEditor services.
Declaration
public ServerActionSettingsModel ServerActionSettings { get; set; }
Property Value
Type | Description |
---|---|
ServerActionSettingsModel | A object representing the settings of the DocumentEditor services. |
ServiceUrl
Sfdt Service URL.
Declaration
public string ServiceUrl { get; set; }
Property Value
Type | Description |
---|---|
System.String | Accepts the string value. The default value is empty. |
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 |
|
SpellChecker
Gets the spell check object of the document editor.
Declaration
public SpellCheckerModule SpellChecker { get; }
Property Value
Type | Description |
---|---|
SpellCheckerModule | The spell check object of the document editor, which allows for spell checking within the document. |
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 | Accepts the string value. The default value is |
Width
Defines the width of the DocumentEditor component.
Declaration
public string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String | Accepts the string value. The default value is |
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 | Accepts the double value that specifies the z-orders of the component. The default value is |
ZoomFactor
Gets or sets the zoom factor in document editor.
Declaration
public double ZoomFactor { get; set; }
Property Value
Type | Description |
---|---|
System.Double | Accepts the double value that specifies the zoom factor of the component. The default value is |
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type | Name | Description |
---|---|---|
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder | __builder |
ExportAsImageAsync(Stream, Int32, ImageFormat)
Exports the specified page as image.
Declaration
public Task ExportAsImageAsync(Stream stream, int pageNumber, ImageFormat imageFormat)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | The stream to store the exported image. |
System.Int32 | pageNumber | The page number to be exported as image. The page number should start from 1 to total page count. |
ImageFormat | imageFormat | The format type of the image to be exported. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A task that represents the asynchronous operation to export the specified page as image. |
Examples
The following code example demonstrates how to export a page as image in Blazor Document editor component.
FileStream fileStream = new FileStream("Page1.png", FileMode.CreateNew, FileAccess.ReadWrite);
//Exports page as image.
await sfDocumentEditorContainer.DocumentEditor.ExportAsImageAsync(fileStream, 1, ImageFormat.Png);
fileStream.Dispose();
ExportFormDataAsync()
Export form field values.
Declaration
public Task<List<FormFieldData>> ExportFormDataAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<FormFieldData>> | A System.Threading.Tasks.Task representing the asynchronous operation. |
FitPageAsync(Nullable<PageFitType>)
Fits the page based on given fit type.
Declaration
public Task FitPageAsync(Nullable<PageFitType> pageFitType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<PageFitType> | pageFitType | Specifies the page fit type. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
FocusAsync()
Shifts the focus to the document.
Declaration
public Task FocusAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetBookmarksAsync()
Gets the bookmarks.
Declaration
public Task<List<string>> GetBookmarksAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<System.String>> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetFormFieldInfoAsync(String)
Get form field by name.
Declaration
public Task<FormFieldInfo> GetFormFieldInfoAsync(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Specifies the form field name. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<FormFieldInfo> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetFormFieldNamesAsync()
Get all form field names.
Declaration
public Task<List<string>> GetFormFieldNamesAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<System.String>> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetIsDocumentEmptyAsync()
Describes whether Document contains any content or not
Declaration
public Task<bool> GetIsDocumentEmptyAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Boolean> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetPageCountAsync()
Gets the total number of pages.
Declaration
public Task<int> GetPageCountAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Int32> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetStyleNamesAsync(Nullable<StyleType>)
Gets the style names based on given style type.
Declaration
public Task<List<string>> GetStyleNamesAsync(Nullable<StyleType> styleType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<StyleType> | styleType | Specifies the style type. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<System.String>> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetStylesAsync(Nullable<StyleType>)
Gets the style objects on given style type.
Declaration
public Task<List<object>> GetStylesAsync(Nullable<StyleType> styleType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<StyleType> | styleType | Specifies the style type. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<System.Object>> | A System.Threading.Tasks.Task representing the asynchronous operation. |
ImportFormDataAsync(List<FormFieldData>)
Import form field values.
Declaration
public Task ImportFormDataAsync(List<FormFieldData> formData)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<FormFieldData> | formData | Specifies the form field data. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
OnAfterRenderAsync(Boolean)
Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | firstRender |
Returns
Type |
---|
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 |
---|
System.Threading.Tasks.Task |
OnParametersSetAsync()
Declaration
protected override Task OnParametersSetAsync()
Returns
Type |
---|
System.Threading.Tasks.Task |
OpenAsync(Stream, ImportFormatType)
Opens the given stream.
Declaration
public Task OpenAsync(Stream stream, ImportFormatType formatType)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | Specifies the file stream. |
Syncfusion.Blazor.DocumentEditor.ImportFormatType | formatType | Specifies the format type. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
OpenAsync(String)
Opens the given Sfdt text.
Declaration
public Task OpenAsync(string sfdtText)
Parameters
Type | Name | Description |
---|---|---|
System.String | sfdtText | Specifies the sfdt text. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
OpenBlankAsync()
Opens a blank document.
Declaration
public Task OpenBlankAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
OpenDialog(DialogType)
Opens the specified dialog.
Declaration
public void OpenDialog(DialogType dialogType)
Parameters
Type | Name | Description |
---|---|---|
DialogType | dialogType | Specifies the dialog type. |
OpenOptionsPane()
Opens the options pane.
Declaration
public void OpenOptionsPane()
PrintAsync()
Prints the document.
Declaration
public Task PrintAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
ResetFormFieldsAsync(String)
Reset form field value to default.
Declaration
public Task ResetFormFieldsAsync(string name = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Specifies the form field name. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
ResizeAsync(Nullable<Double>, Nullable<Double>)
Resizes the component and its sub elements based on given size or container 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. |
SaveAsBlobAsync(Nullable<FormatType>)
Saves the document as blob.
Declaration
public Task<string> SaveAsBlobAsync(Nullable<FormatType> formatType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<FormatType> | formatType | Specifies the format type. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.String> | A System.Threading.Tasks.Task representing the asynchronous operation. |
SaveAsync(Stream)
Saves the document as Stream.
Declaration
public Task SaveAsync(Stream stream)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | Specifies the file stream. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
SaveAsync(String, Nullable<FormatType>)
Saves the document.
Declaration
public Task SaveAsync(string fileName, Nullable<FormatType> formatType = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | fileName | Specifies the file name. |
System.Nullable<FormatType> | formatType | Specifies the format type. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
ScrollToPageAsync(Double)
Scrolls view to start of the given page number if exists.
Declaration
public Task<bool> ScrollToPageAsync(double pageNumber)
Parameters
Type | Name | Description |
---|---|---|
System.Double | pageNumber | Specifies the page number. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Boolean> | A System.Threading.Tasks.Task representing the asynchronous operation. |
SerializeAsync()
Serialize the data to JSON string.
Declaration
public Task<string> SerializeAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.String> | A System.Threading.Tasks.Task representing the asynchronous operation. |
SetDefaultCharacterFormatAsync(CharacterFormatProperties)
Set the default character format for document editor.
Declaration
public Task SetDefaultCharacterFormatAsync(CharacterFormatProperties characterFormat)
Parameters
Type | Name | Description |
---|---|---|
CharacterFormatProperties | characterFormat | Specifies the character format. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
SetDefaultParagraphFormatAsync(ParagraphFormatProperties)
Set the default paragraph format for document editor.
Declaration
public Task SetDefaultParagraphFormatAsync(ParagraphFormatProperties paragraphFormat)
Parameters
Type | Name | Description |
---|---|---|
ParagraphFormatProperties | paragraphFormat | Specifies the paragraph format. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
SetDefaultSectionFormatAsync(SectionFormatProperties)
Set the default section format for document editor.
Declaration
public Task SetDefaultSectionFormatAsync(SectionFormatProperties sectionFormat)
Parameters
Type | Name | Description |
---|---|---|
SectionFormatProperties | sectionFormat | Specifies the section format. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
SetFormFieldInfoAsync(String, FormFieldInfo)
Set form field.
Declaration
public Task SetFormFieldInfoAsync(string name, FormFieldInfo formFieldInfo)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Specifies the form field name. |
FormFieldInfo | formFieldInfo | Specifies the form field info. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
ShouldRender()
Declaration
protected override bool ShouldRender()
Returns
Type |
---|
System.Boolean |
UpdateFieldsAsync()
Updated fields in document. Currently cross reference field only supported.
Declaration
public Task UpdateFieldsAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |