Getting Started with Blazor DOCX Editor in Web App

29 Apr 20269 minutes to read

Syncfusion® DOCX Editor (Document Editor) enables you to create, edit, view, and print Word documents in web applications. This section guides you through the steps to get started and create a DOCX Editor in a Blazor WebAssembly (WASM) application.

Steps to create a Blazor Web App DOCX Editor

This section explains about how to include the Blazor Document Editor component in a Blazor Web App using Visual Studio and Visual Studio Code.

• Visual Studio
• Visual Studio Code

Prerequisites

• System requirements for Blazor components

Create a new Blazor Web App in Visual Studio

You can create a Blazor Web App using Visual Studio 2022 via Microsoft Templates.

You need to configure the corresponding Interactive render mode and Interactivity location while creating the Blazor Web App.

Install Syncfusion^® Blazor Nuget packages

To add Blazor Document Editor component in the application, follow the steps below.

• open NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution),
• search and install the following packages
  • Syncfusion.Blazor.WordProcessor
  • Syncfusion.Blazor.Themes

Alternatively, you can utilize the following package manager command to achieve the same.

Package Manager

Install-Package Syncfusion.Blazor.WordProcessor -Version 33.2.3
Install-Package Syncfusion.Blazor.Themes -Version 33.2.3

NOTE

Syncfusion^® Blazor DOCX Editor are available in nuget.org. Refer to NuGet packages topic for available NuGet packages list with component details.

Prerequisites

• System requirements for Blazor components

Create a new Blazor Web App in Visual Studio Code

You can create a Blazor Web App using Visual Studio Code via Microsoft Templates.

You need to configure the corresponding Interactive render mode and Interactivity location while creating a Blazor Web Application.

For example, in a Blazor Web App with the Auto interactive render mode, use the following commands.

Blazor Web App

dotnet new blazor -o BlazorWebApp -int Auto
cd BlazorWebApp
cd BlazorWebApp.Client

NOTE

For more information on creating a Blazor Web App with various interactive modes and locations, refer to this link.

Install Syncfusion^® Blazor Nuget packages

If you utilize WebAssembly or Auto render modes in the Blazor Web App need to be install Syncfusion^® Blazor DOCX Editor NuGet packages within the client project.

• Press Ctrl+` to open the integrated terminal in Visual Studio Code.
• Ensure the terminal is in the project root directory where the .csproj file is located.
• Run the following command to install
  • Syncfusion.Blazor.WordProcessor
  • Syncfusion.Blazor.Themes

Package Manager

dotnet add package Syncfusion.Blazor.WordProcessor -v 33.2.3
dotnet add package Syncfusion.Blazor.Themes -v 33.2.3
dotnet restore

NOTE

Syncfusion^® Blazor DOCX Editor are available on nuget.org. Refer to the NuGet packages topic for the complete list of packages and component details.

Register Syncfusion^® Blazor Services

Interactive Render Mode	Description
WebAssembly or Auto	Open ~/_Imports.razor file from the client project.
Server	Open ~/_import.razor file, which is located in the Components folder.

Import the Syncfusion.Blazor and Syncfusion.Blazor.DocumentEditor namespaces.

~/_Imports.razor

@using Syncfusion.Blazor
@using Syncfusion.Blazor.DocumentEditor

Now, register the Syncfusion^® Blazor service in the ~/Program.cs file of your Blazor Web App.

If the Interactive Render Mode is set to WebAssembly or Auto, you need to register the Syncfusion^® Blazor service in both ~/Program.cs files of the Blazor Web App.

Server(~/_Program.cs)

...
...
using Syncfusion.Blazor;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorComponents()
    .AddInteractiveServerComponents()
    .AddInteractiveWebAssemblyComponents();
builder.Services.AddSyncfusionBlazor();

var app = builder.Build();
....

Client(~/_Program.cs)

...
using Syncfusion.Blazor;

var builder = WebAssemblyHostBuilder.CreateDefault(args);
builder.Services.AddSyncfusionBlazor();

await builder.Build().RunAsync();

If the Interactive Render Mode is set to Server, your project will contain a single ~/Program.cs file. So, you should register the Syncfusion^® Blazor Service only in that ~/Program.cs file.

~/_Program.cs

...
using Syncfusion.Blazor;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorComponents()
    .AddInteractiveServerComponents();
builder.Services.AddSyncfusionBlazor();

var app = builder.Build();
....

Add Themes and Script References

The theme stylesheet and script can be accessed from NuGet through Static Web Assets. Include the stylesheet reference in the <head> section and the script reference at the end of the <body> in the ~/Components/App.razor file as shown below:

<head>
    ....
    <link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
</head>
....
<body>
    ....
    <script src="_content/Syncfusion.Blazor.WordProcessor/scripts/syncfusion-blazor-documenteditor.min.js" type="text/javascript"></script>
</body>

NOTE

Check out the Blazor Themes topic to discover various methods (Static Web Assets, CDN, and CRG) for referencing themes in your Blazor application. Also, check out the Adding Script Reference topic to learn different approaches for adding script references in your Blazor application.

Add the Syncfusion^® Document Editor component

Add the Syncfusion^® Blazor Document Editor component in .razor file inside the Pages folder. If an interactivity location as Per page/component in the web app, define a render mode at top of the component, as follows:

Interactivity location	RenderMode	Code
Per page/component	Auto	@rendermode InteractiveAuto
	WebAssembly	@rendermode InteractiveWebAssembly
	Server	@rendermode InteractiveServer
	None	—

RAZOR

@* desired render mode define here *@
@rendermode InteractiveAuto

NOTE

Supported render modes are @rendermode InteractiveAuto, @rendermode InteractiveServer, @rendermode InteractiveWebAssembly. If an interactivity location as Global no need to mention render mode. Set the interactivity mode for whole sample. Check out the Blazor Render Modes for other Render Modes.

RAZOR

<SfDocumentEditorContainer EnableToolbar=true></SfDocumentEditorContainer>

Run the application

Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. This will render the Syncfusion^® Blazor DocumentEditor component in your default web browser.

Load an Existing document

To load an existing document during control initialization, use the following code example, which opens a Word document. Convert it to SFDT and load in the editor.

RAZOR

@using System.IO;
@using Syncfusion.Blazor.DocumentEditor;

<SfDocumentEditorContainer @ref="container" EnableToolbar=true>
    <DocumentEditorContainerEvents Created="OnCreated"></DocumentEditorContainerEvents>
</SfDocumentEditorContainer>

@code {
    SfDocumentEditorContainer container;

    public void OnCreated(object args)
    {
        string filePath = "wwwroot/data/GettingStarted.docx";
        using (FileStream fileStream = new FileStream(filePath, System.IO.FileMode.Open, System.IO.FileAccess.Read))
        {
            WordDocument document = WordDocument.Load(fileStream, ImportFormatType.Docx);
            string json = JsonSerializer.Serialize(document);
            document.Dispose();
            //To observe the memory go down, null out the reference of document variable.
            document = null;
            SfDocumentEditor editor = container.DocumentEditor;
            editor.OpenAsync(json);
            //To observe the memory go down, null out the reference of json variable.
            json = null;
        }
    }
}

You can download a complete working sample from GitHub.