Setup in .NET 6 or Higher

Startup.cs file

Within the Startup.cs file of a .NET Core project, these lines of code define a middleware pipeline configuration using the MapWhen method. The provided predicate checks if the incoming request path ends with DocImage.axd. Inside this block, the UseDoconut method is called with a DoconutOptions object as an argument.

app.MapWhen(
    ctx => ctx.Request.Path.Value?.EndsWith("DocImage.axd", StringComparison.OrdinalIgnoreCase) == true,
    branch => branch.UseDoconut());

Add Doconut Namespaces

In your project, add the following using statements:

using Doconut;
using Doconut.Configs;
using Doconut.Clouds;

Instantiate Viewer object

This line instantiates a new instance of the Viewer class, allowing you to create a viewer object within your code.

// License is configured via AddDoconut; obtain the viewer from DI.
var docViewer = app.Services.GetRequiredService<Viewer>();

Setup a DocOptions object

Example initialization of a DocOptions object with specific configurations:

```csharp
// Document opening options – password and session timeout
var docOptions = new DocOptions
{
    Password = string.Empty,
    TimeOut = 30
};

// Per‑format rendering options – set image resolution via the format‑specific config
var pdfConfig = new PdfConfig
{
    ImageResolution = 200
};
```

Setup a config object

Initialize a new PdfConfig object with specific configurations for handling PDF documents:

var config = new PdfConfig { DefaultRender = true, ExtractHyperlinks = true };

Open your document

This line invokes the OpenDocument method of the viewer object, passing the path of the document file located on the server and the previously configured PdfConfig and DocOptions objects as parameters.

var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true,
    ImageResolution = 150
});

Add the viewer in your HTML

<div id="div_ctlDoc"></div>

Add CSS and JavaScript files

Add the following CSS and JavaScript files in the page. These scripts are included in the ZIP file with code samples.

<!-- Main Viewer Related Scripts -->
<script src="scripts/splitter.js"></script>
<script src="scripts/docViewer.js"></script>
<script src="scripts/documentLinks.js"></script>

<!-- Viewer functions -->
<script src="scripts/docViewer.UI.js?v=1"></script>

Required NuGet Packages

To ensure your project is fully compatible with .NET Core Standard, the following NuGet packages need to be included, listed in alphabetical order.

• MessagePack - Version 2.5.140
• Microsoft.Bcl.AsyncInterfaces - Version 8.0.0
• Microsoft.Extensions.Caching.Abstractions - Version 8.0.0
• Microsoft.Extensions.Configuration - Version 8.0.0
• Microsoft.Extensions.Configuration.Abstractions - Version 8.0.0
• Microsoft.Extensions.Configuration.FileExtensions - Version 8.0.0
• Microsoft.Extensions.Configuration.Json - Version 8.0.0
• Microsoft.Extensions.FileProviders.Abstractions - Version 8.0.0
• Microsoft.Extensions.FileProviders.Physical - Version 8.0.0
• Microsoft.Extensions.FileSystemGlobbing - Version 8.0.0
• Microsoft.Extensions.Primitives - Version 8.0.0
• System.Buffers - Version 4.5.1
• System.Formats.Asn1 - Version 8.0.0
• System.Numerics.Vectors - Version 4.5.0
• System.Security.Cryptography.Cng - Version 5.0.0
• System.Security.Cryptography.Pkcs - Version 8.0.0
• System.Text.Encoding.CodePages - Version 8.0.0
• System.Text.Encodings.Web - Version 8.0.0
• System.Text.Json - Version 8.0.3
• System.Threading.Tasks.Extensions - Version 4.5.4

Render Configuration Options

You can configure the rendering behavior using the following options:

• CadConfig: Used for DWG, DXF, and DGN files.
• EmailConfig: Used for EML, EMLX, and MSG files.
• EpubConfig: Used for EPUB files.
• ExcelConfig: Used for Excel and CSV files.
• MhtConfig: Used for MHT files.
• PptConfig: Used for PowerPoint files.
• ProjectConfig: Used for MPP files.
• PsdConfig: Used for PSD files.
• TxtConfig: Used for TXT files.
• TiffConfig: Used for TIFF files.

Render Options Configuration

The render options are configured using the DefaultRender property:

• DefaultRender = true : This option offers higher quality rendering but uses more server memory and processing time.
• DefaultRender = false : This option provides faster rendering at the expense of slightly reduced quality.

Custom Fonts in Word documents

The FontFolders property in the WordConfig class specifies custom directories where the application will search for fonts. This is particularly useful for processing Word documents that rely on fonts not installed in the system's default font directories.

var config = new WordConfig
{
    FontFolders = new string[] { "C:\\CustomFonts", "D:\\SharedFonts" }
};

Important Update for Doconut 25.2.0

It is essential to update the System.Text.Json package to version 8.0.5 in all your projects. This update is crucial to ensure compatibility with the latest features and to address important security improvements.

Email Encoding

The EmailEncoding property in the EmailConfig class specifies the preferred encoding for both the email's subject and body.

var emailConfig = new EmailConfig {
    EmailEncoding = Encoding.UTF8 // Set preferred email encoding
};

Subject & Body Encoding

The SubjectEncoding and BodyEncoding properties in the EmailConfig class define the encoding used for the subject and body of an email, respectively.

var emailConfig = new EmailConfig {
    SubjectEncoding = Encoding.UTF8, // Set encoding for the subject
    BodyEncoding = Encoding.UTF8     // Set encoding for the body
};

Word Viewer Culture Support

The DocumentCulture property in the WordConfig class allows you to explicitly define the culture for DOC and DOCX files. This ensures that localized content—such as dates, currencies, and numbers—renders exactly as it does in Microsoft Word. This is particularly useful for languages with specific formatting requirements.

var config = new WordConfig { DocumentCulture = "he-IL" }; // Hebrew (Israel)
var config = new WordConfig { DocumentCulture = "ar-SA" }; // Arabic (Saudi Arabia)
var config = new WordConfig { DocumentCulture = "th-TH" }; // Thai (Thailand)
var config = new WordConfig { DocumentCulture = "ja-JP" }; // Japanese (Japan)