Configurazione in .NET Standard / Core

Utilizzare la tua licenzaAttiva e applica la tua licenza Doconut.

File Startup.cs

Nell file Startup.cs di un progetto .NET Core, queste righe di codice definiscono una configurazione della pipeline middleware utilizzando il metodo MapWhen. Il predicato fornito verifica se il percorso della richiesta in arrivo termina con DocImage.axd. All'interno di questo blocco, il metodo UseDoconut viene chiamato con un oggetto DoconutOptions come argomento.

Startup.cs
app.MapWhen(
    context => context.Request.Path.ToString().EndsWith("DocImage.axd"),
    appBranch =>
    {
        appBranch.UseDoconut(new DoconutOptions { UnsafeMode = false, ShowDoconutInfo = false });
    }
);

Aggiungi gli spazi dei nomi Doconut

Nel tuo progetto, aggiungi le seguenti istruzioni using:

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

// TODO: implement licence loading, viewer registration, document opening, conversion using current API

Istanzia l'oggetto Viewer

Questa riga istanzia una nuova istanza della classe Viewer, consentendoti di creare un oggetto viewer nel tuo codice.

Instantiation
// Viewer is injected; no explicit construction required in Doconut.NETStandard 26.9.0

Configura un oggetto DocOptions

Esempio di inizializzazione di un oggetto DocOptions con configurazioni specifiche:

DocOptions
var documentOptions = new DocOptions
{
    Password = "",
    // ImageResolution is obsolete; omitted.
    TimeOut = 30
};

Configura un oggetto config

Inizializza un nuovo oggetto PdfConfig con configurazioni specifiche per la gestione dei documenti PDF:

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

Apri il tuo documento

Questa riga invoca il metodo OpenDocument dell'oggetto viewer, passando il percorso del file del documento situato sul server e gli oggetti PdfConfig e DocOptions precedentemente configurati come parametri.

OpenDocument
dynamic viewer = null;
var token = viewer.LoadDocument(path, null, null);

Aggiungi il viewer nel tuo HTML

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

Aggiungi file CSS e JavaScript

Aggiungi i seguenti file CSS e JavaScript nella pagina. Questi script sono inclusi nel file ZIP con esempi di codice.

HTML Headers
<link rel="stylesheet" href="css/viewer.css" />

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

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

Aggiungi licenze al tuo progetto

Rilevamento automatico delle licenze

Per inizializzare il docViewer con il rilevamento automatico delle licenze, usa la seguente riga:

C#
```csharp
// Create a Viewer instance using the current API (no constructor arguments required).
var docViewer = new Viewer();
```

Aggiungi licenza predefinita manuale

Puoi specificare manualmente il percorso a un singolo file di licenza predefinita durante l'inizializzazione del viewer.

C#
using System.IO;
using Microsoft.Extensions.DependencyInjection;
using Doconut;

var licenseFilePath = Path.Combine(builder.Environment.WebRootPath, "path/to/your/license");
var docViewer = app.Services.GetRequiredService<Viewer>();

Aggiungi licenza tramite stream

Questo metodo utilizza il sovraccarico Viewer.DoconutLicense(Stream licenseStream) per aggiungere una licenza usando uno stream.

C#
using System.IO;
using Doconut.Infrastructure.Licensing;

using (var licenseStream = new FileStream("path/to/your/license", FileMode.Open, FileAccess.Read))
{
    var license = new DoconutLicense { DocBytes = new BinaryReader(licenseStream).ReadBytes((int)licenseStream.Length) };
}

Aggiungi licenza tramite documento XML

Questo metodo utilizza il sovraccarico Viewer.DoconutLicense(XMLDocument licence) per aggiungere una licenza usando un documento XML.

C#
using System.Xml;
using Doconut.Infrastructure.Licensing;

var xmlDoc = new XmlDocument(); // load the license XML
xmlDoc.Load("path/to/your/license.xml");
var license = new DoconutLicense(); // instantiate license object (populate properties as needed)

Licenze plugin multiple predefinite manuali

Se è necessario specificare più licenze, è possibile fornire un elenco di percorsi di file all'inizializzazione del viewer.

C#
```csharp
// Prepare the paths to the viewer licence files (kept for reference; the current API loads them automatically)
var licenseFilePaths = new List<string>
{
    Path.Combine(_hostingEnvironment.WebRootPath, "Doconut.Viewer.lic"),
    Path.Combine(_hostingEnvironment.WebRootPath, "Doconut.Viewer.Annotation.lic"),
    Path.Combine(_hostingEnvironment.WebRootPath, "Doconut.Viewer.Search.lic")
};

// The Viewer class no longer requires the licences in its constructor.
// Create an instance with the default constructor.
var docViewer = new Viewer();

// Open a document (e.g., a PDF) and obtain a token that represents the opened file.
string token = await docViewer.OpenDocumentAsync(
    filePath: Path.Combine(_hostingEnvironment.WebRootPath, "sample.pdf"),
    options: new DocOptions(),
    ct: CancellationToken.None);
```

Aggiungi licenza plugin tramite stream

Questo metodo utilizza il sovraccarico Viewer.SetLicensePlugin(Stream pluginLicence) per aggiungere una licenza plugin usando uno stream.

C#
using (var pluginLicenseStream = new FileStream("path/to/your/plugin-license.lic", FileMode.Open))
{
    // In Doconut.NETStandard 26.9.0 the license is supplied via the configuration
    // passed to OpenDocumentAsync (BaseConfig), so the explicit SetLicensePlugin call
    // is no longer required. Keep the license file accessible to the viewer or
    // include it in your BaseConfig as shown in other samples.
}

Aggiungi licenza plugin tramite documento XML

Questo metodo utilizza il sovraccarico Viewer.SetLicensePlugin(XMLDocument xmlPluginLicence) per aggiungere una licenza plugin usando un documento XML.

C#
// The license XML is discovered automatically by the viewer in Doconut.NETStandard 26.9.0.
// No explicit API call is required to register it.

string token = await Viewer.OpenDocumentAsync(
    "path/to/your/document.pdf",
    null, // DocOptions – use default settings
    CancellationToken.None);

Pacchetti NuGet richiesti

Per garantire che il tuo progetto sia pienamente compatibile con .NET Core Standard, è necessario includere i seguenti pacchetti NuGet, elencati in ordine alfabetico.

  • 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

Opzioni di configurazione del rendering

Puoi configurare il comportamento del rendering utilizzando le seguenti opzioni:

  • CadConfig: Utilizzato per file DWG, DXF e DGN.
  • EmailConfig: Utilizzato per file EML, EMLX e MSG.
  • EpubConfig: Utilizzato per file EPUB.
  • ExcelConfig: Utilizzato per file Excel e CSV.
  • MhtConfig: Utilizzato per file MHT.
  • PptConfig: Utilizzato per file PowerPoint.
  • ProjectConfig: Utilizzato per file MPP.
  • PsdConfig: Utilizzato per file PSD.
  • TxtConfig: Utilizzato per file TXT.
  • TiffConfig: Utilizzato per file TIFF.

Configurazione delle opzioni di rendering

Le opzioni di rendering sono configurate usando la proprietà DefaultRender:

  • DefaultRender = true : Questa opzione offre un rendering di qualità superiore ma utilizza più memoria del server e tempo di elaborazione.
  • DefaultRender = false : Questa opzione fornisce un rendering più veloce a scapito di una leggera riduzione della qualità.

Come aggiungere un'annotazione immagine

In C#

1. Apri il documento e ottieni le dimensioni della prima pagina. 2. Inizializza l'AnnotationManager con le dimensioni della pagina. 3. Crea un ImageAnnotation, impostando il percorso dell'immagine in imgUrl, e specifica la posizione e le dimensioni all'interno di Rectangle. 4. Aggiungi l'annotazione al manager e caricala nel visualizzatore di documenti per visualizzarla.

C#
using Doconut.Annotations;
using System.Drawing;

// Placeholder: open the document and obtain page dimensions using the current Doconut.NETStandard API.
// Placeholder: create an annotation manager for the page size.

string imgUrl = "img/sample.png";
var imgAnn = new ImageAnnotation(
    1,
    new Rectangle(600, 700, 750, 300),
    imgUrl
);

// Placeholder: add the annotation to the manager and load the annotation XML back into the viewer using the current API.

In JavaScript

1. Assicurati che YourController sia disponibile. 2. Crea un nuovo ImageAnnotation, impostando il percorso dell'immagine con SetNote. 3. Aggiungi e dipingi l'annotazione per renderla sul documento.

JavaScript
function ImageStamp() {
    if (null != objctlDoc.YourController()) {
        var objStampImage = new ImageAnnotation({ left: 200, top: 200, width: 260, height: 55 });
        objctlDoc.YourController().AddAnnotation(null, objStampImage, null);

        objStampImage.SetNote('/images/Approved_Stamp.png');
        objStampImage.Paint();
    }
}

Font personalizzati nei documenti Word

La proprietà FontFolders nella classe WordConfig specifica directory personalizzate dove l'applicazione cercherà i font. Questo è particolarmente utile per elaborare documenti Word che dipendono da font non installati nelle directory di font predefinite del sistema.

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

Aggiornamento importante per Doconut 25.2.0

È fondamentale aggiornare il pacchetto System.Text.Json alla versione 8.0.5 in tutti i tuoi progetti. Questo aggiornamento è cruciale per garantire la compatibilità con le ultime funzionalità e per affrontare importanti miglioramenti di sicurezza.

Codifica email

La proprietà EmailEncoding nella classe EmailConfig specifica la codifica preferita sia per l'oggetto che per il corpo dell'email.

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

Codifica oggetto e corpo

Le proprietà SubjectEncoding e BodyEncoding nella classe EmailConfig definiscono la codifica utilizzata rispettivamente per l'oggetto e il corpo di un'email.

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

Supporto alla cultura del visualizzatore Word

La proprietà DocumentCulture nella classe WordConfig consente di definire esplicitamente la cultura per i file DOC e DOCX. Questo garantisce che i contenuti localizzati—come date, valute e numeri—vengano visualizzati esattamente come avviene in Microsoft Word. È particolarmente utile per le lingue con requisiti di formattazione specifici.

Usage
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)