Class RichTextEditorExportWord

A class used for configuring the export word document settings in the SfRichTextEditor. It facilitates exporting editor content into a Word document format using a specified service URL.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
RichTextEditorExportWord
Implements
Inherited Members
Namespace: Syncfusion.Blazor.RichTextEditor
Assembly: Syncfusion.Blazor.dll
Syntax
public class RichTextEditorExportWord : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

RichTextEditorExportWord()

Declaration
public RichTextEditorExportWord()

Properties

FileName

Gets or sets the file name for the exported Word document.

Declaration
[Parameter]
public string? FileName { get; set; }
Property Value
Type Description
string

A string specifying the name of the exported Word file. The default value is Sample.docx.
Remarks

The specified file name will be applied to the Word document generated during the export process. Ensure that a valid ServiceUrl is configured to apply the specified file name correctly during the export process.

Examples

This example demonstrates how to configure the FileName:

<SfRichTextEditor>
    <RichTextEditorExportWord FileName="@exportWordFileName" ServiceUrl="@exportWordServiceUrl"/>
</SfRichTextEditor>
@code {
    private string exportWordServiceUrl = "Enter the service URL here";
    private string exportWordFileName = "Result.docx";
}

ServiceUrl

Gets or sets the URL of the service used to export the Rich Text Editor content to Word files.

Declaration
[Parameter]
public string? ServiceUrl { get; set; }
Property Value
Type Description
string

A string representing the URL of the service responsible for exporting Rich Text Editor content to a Word file. The default value is String.Empty.
Remarks

The service URL should point to a server endpoint capable of processing export requests and returning the generated Word file in response.

Examples

This example demonstrates how to configure the ServiceUrl:

<SfRichTextEditor>
    <RichTextEditorExportWord ServiceUrl="@exportWordServiceUrl" />
</SfRichTextEditor>
@code {
    private string exportWordServiceUrl = "Enter the service URL here";
}

Stylesheet

Gets or sets the stylesheet to be applied to the exported Word file.

Declaration
[Parameter]
public string? Stylesheet { get; set; }
Property Value
Type Description
string

A string containing the stylesheet used when exporting Rich Text Editor content to a Word file. The default value is String.Empty.
Remarks

The stylesheet enables the application of custom CSS styles to the exported Word file. Ensure that a valid ServiceUrl is configured to apply the specified stylesheet correctly during the export process.

Examples

This example demonstrates how to configure the Stylesheet:

<SfRichTextEditor>
    <RichTextEditorExportWord Stylesheet="@exportWordStylesheet" ServiceURL="@exportWordServiceUrl"/>
</SfRichTextEditor>
@code {
    private string exportWordServiceUrl = "Enter the service URL here";
    private string exportWordStylesheet = ".e-rte-content { font-size: 1em; font-weight: 400; margin: 0; }"; 
}

Methods

Dispose(bool)

Dispose unmanaged resources in the Syncfusion Blazor component.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

Boolean value to dispose the object.
Overrides

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

Implements