| layout | post |
|---|---|
| title | Getting Started with Blazor Web App DOCX Editor | Syncfusion |
| description | Learn how to create a DOCX Editor in a Blazor Web App application using the Syncfusion® Document Editor control to create, edit, and view Word documents. |
| component | DocumentEditor |
| documentation | ug |
Syncfusion® Blazor 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.
This section explains about how to include the Document Editor component in a Blazor Web App using Visual Studio and Visual Studio Code.
{% tabcontents %}
{% tabcontent 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.
To add 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
Alternatively, you can utilize the following package manager command to achieve the same.
{% tabs %} {% highlight C# tabtitle="Package Manager" %}
Install-Package Syncfusion.Blazor.WordProcessor Install-Package Syncfusion.Blazor.Themes
{% endhighlight %} {% endtabs %}
{% endtabcontent %}
{% tabcontent 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.
{% tabs %} {% highlight c# tabtitle="Blazor Web App" %}
dotnet new blazor -o BlazorWebApp -int Auto cd BlazorWebApp cd BlazorWebApp.Client
{% endhighlight %} {% endtabs %}
N> For more information on creating a Blazor Web App with various interactive modes and locations, refer to this link.
If you utilize WebAssembly or Auto render modes in the Blazor Web App need to be install Document 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
.csprojfile is located. - Run the following command to install
{% tabs %}
{% highlight c# tabtitle="Package Manager" %}
dotnet add package Syncfusion.Blazor.WordProcessor dotnet add package Syncfusion.Blazor.Themes dotnet restore
{% endhighlight %}
{% endtabs %}
{% endtabcontent %}
{% endtabcontents %}
| 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.
{% tabs %} {% highlight C# tabtitle="~/_Imports.razor" %}
@using Syncfusion.Blazor @using Syncfusion.Blazor.DocumentEditor
{% endhighlight %} {% endtabs %}
Register the Syncfusion® Blazor service in the Program.cs file of your Blazor Web App.
{% tabs %} {% highlight c# tabtitle="Program.cs" %}
// Other code Snippet
using Syncfusion.Blazor;
// Register Syncfusion Blazor services along with other service registrations builder.Services.AddSyncfusionBlazor();
// Other code Snippet
{% endhighlight %} {% endtabs %}
N> If the Interactive Render Mode is set to WebAssembly or Auto, register the Syncfusion® Blazor service in Program.cs files of both the server and client projects in your Blazor Web App.
The theme stylesheet and script can be accessed from NuGet through Static Web Assets.
Include the stylesheet reference in the <head> section of the ~/Components/App.razor file as shown below:
{% tabs %} {% highlight razor tabtitle="~/App.razor" %}
{% endhighlight %} {% endtabs %}
Include the script reference at the end of the <body> section in the ~/Components/App.razor file.
{% tabs %} {% highlight razor tabtitle="~/App.razor" %}
<script src="_content/Syncfusion.Blazor.WordProcessor/scripts/syncfusion-blazor-documenteditor.min.js" type="text/javascript"></script>{% endhighlight %} {% endtabs %}
N> 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 Document Editor component in the ~/Components/Pages/*.razor file. 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 | --- |
N> 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.
{% tabs %} {% highlight razor tabtitle="Home.razor" %}
@* desired render mode define here *@ @rendermode InteractiveAuto
@using Syncfusion.Blazor.DocumentEditor
{% endhighlight %} {% endtabs %}
Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. This will render the Document Editor in your default web browser. The output will appear as follows:
