Plugin di Conversione

Il plugin Converter trasforma Doconut in un servizio di conversione di documenti. Contribuisce al motore dietro la facciata pubblica DocumentConverter e — opzionale — un widget plug‑and‑play con il proprio contratto HTTP, così puoi convertire documenti da C#, dal widget o da un frontend che scrivi tu stesso.

Installa il pacchetto

Installa l'ultima versione stabile del plugin Converter:

dotnet add package Doconut.NET6.Converter

Per fissare il plugin alla versione corrente 26.7.0, passa la versione separatamente:

dotnet add package Doconut.NET6.Converter --version 26.7.0

Conserva il pacchetto Converter alla stessa versione di Doconut.NET6. L'ID del pacchetto è Doconut.NET6.Converter; .26.7.0 appare solo nel nome del file .nupkg scaricato.

Registra il plugin

Non esiste un metodo AddConverter() — il modello di plugin di Doconut è uniforme. Ogni plugin, incluso Converter, si registra allo stesso modo: chiama AddPlugin<TPlugin>() all'interno di AddDoconut(). ConverterPlugin è distribuito nel proprio pacchetto NuGet, Doconut.NET6.Converter, installato insieme al pacchetto base del visualizzatore.

builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
    options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
});

Questa chiamata genera un'eccezione all'avvio per una licenza mancante, un file legacy TRIAL o una licenza non temporanea che non concede la capacità Converter — un InvalidOperationException sollevato all'interno di AddDoconut(), prima che l'app gestisca le richieste. Le registrazioni temporanee Demo/NFR sono accettate; dopo la loro scadenza, la conversione rimane disponibile con output filigranato. Non esiste un livello gratuito silenzioso. Vedi Configurazione della licenza per come vengono caricate le licenze.

Converti da C#

Tutta conversione restituisce un MemoryStream ricercabile posizionato a 0, pronto per la lettura o la copia immediata. Risolvi DocumentConverter dal DI ovunque ne abbia bisogno — è senza stato per progettazione, quindi una singola istanza è sicura da riutilizzare tra le richieste.

// Inject DocumentConverter; its constructor is internal, so never `new` it.
Stream pdf = await converter.ConvertAsync("contract.docx", ConversionTarget.Pdf, ct: ct);

// sourceExtension includes the leading dot. password is null unless the document is protected.
Stream png = await converter.ConvertAsync(upload, ".xlsx", ConversionTarget.Png, password: null, ct: ct);

Stream html = await converter.WordToHtmlAsync("report.docx", ct);

Stream docx = await converter.HtmlToWordAsync(html, ConversionTarget.Docx, ct);

Due dettagli facili da sbagliare: sourceExtension nella sovraccarico dello stream deve includere il punto iniziale (".xlsx", non "xlsx") — il convertitore lo confronta con il catalogo dei formati e un'estensione senza punto non verrà risolta. E nonostante il nome, WordToHtmlAsync restituisce Task<Stream>, non Task<string> — ottieni il documento HTML (immagini incorporate come Base64) come stream, allo stesso modo di ogni altro risultato di conversione.

Formati di destinazione

Pdf, Docx, Doc, Html, Xlsx, Pptx, Png, Jpeg, Csv, Tiff, Bmp, Gif, Svg, Xml,
Txt, Xls, Jp2, Rtf, Odt, Ods, Odp, Epub, Xps, Webp

Non tutte le sorgenti si convertono in tutti i formati di destinazione — il plugin mappa ogni famiglia di formato della sorgente (Word, Excel, PowerPoint, PDF, CAD, Immagine, Email, Diagramma, Progetto/Attività, PSD, documento web) al proprio insieme fisso di destinazioni consentite. Non codificare rigidamente questo enum come elenco di destinazioni nella tua UI: ?convert=open restituisce gli effettivi allowedTargets per il file appena caricato, e questo è ciò che dovrebbe guidare il selettore.

Widget plug‑and‑play

Gli endpoint ?convert=open|run|download del widget sono opzionali e disabilitati di default — sicuri per impostazione predefinita. Abilitali lato server, insieme alla registrazione del plugin:

builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
    options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
    options.AddConverterWidget(widget =>
    {
        widget.MaxUploadMb = 25;
    });
});

<div id="doconut-convert"></div>
<script src="/doconut-res/js/doconutConverter.js"></script>
<script>
  Doconut.convert('#doconut-convert', { basePath: '/doconut', resPath: '/doconut-res', maxUploadMb: 25 });
</script>

Senza AddConverterWidget(), i tre endpoint ?convert= rispondono 404 — ma il file JS stesso viene comunque servito (è una semplice risorsa statica incorporata; solo gli endpoint a cui si collega sono protetti). AddConverterWidget() richiede comunque che il plugin Converter sia registrato e che una licenza conceda Converter — non concede diritti di conversione da solo.

Personalizza il widget

Opzioni di inizializzazione passate a Doconut.convert(selector, options):

Callback:

Doconut.convert() restituisce l'istanza del widget stessa — tienila a portata di mano per controllare il widget programmaticamente:

const conv = Doconut.convert('#doconut-convert', { basePath: '/doconut' });
conv.reset();         // back to the idle/drop screen; does not re-fire onReady
conv.loadFile(file);  // starts the flow with a File object; no-op unless currently idle
conv.destroy();       // removes listeners, empties the mount; the instance is unusable after this

Costruisci il tuo frontend

Il widget è solo un client per questo contratto HTTP — costruisci il tuo frontend direttamente contro di esso per un'esperienza utente diversa. Tutte e tre le rotte si trovano sotto il ramo ASP.NET dove UseDoconut() è montato (normalmente /doconut):

I byte della sorgente caricata sono conservati lato server con un TTL di 30 minuti; una volta scaduto questo intervallo, run risponde 404 e il file deve essere riaperto. Il risultato convertito vive nella stessa cache — downloadToken ottiene una nuova finestra di 30 minuti al completamento della conversione — mentre resultToken è un normale token di sessione del visualizzatore il cui tempo di vita segue la cache della sessione del visualizzatore, indipendente dalla cache.

sourceExt nella risposta open non ha il punto iniziale (es. "docx") — è l'opposto della convenzione del parametro sourceExtension su DocumentConverter.ConvertAsync, che ne richiede uno.

Modalità di errore, raggruppate per rotta

Proprietà delle risorse

Il converter restituisce un MemoryStream ricercabile posizionato a zero. Chi chiama possiede quello stream e dovrebbe eliminarlo dopo aver copiato o restituito il suo contenuto. Il servizio DocumentConverter stesso è senza stato e viene risolto dall'iniezione delle dipendenze; non costruire o eliminare manualmente il servizio.

Per il widget web, le cache di upload e download hanno TTL indipendenti di 30 minuti. Un resultToken del visualizzatore segue invece la durata della sessione del visualizzatore. Chiudere un risultato del visualizzatore non elimina una cache di download ancora valida, e il reset del widget del browser non estende nessuno dei due TTL.

Risoluzione dei problemi

Filigrana

Con ConverterPlugin registrato, la licenza dell'host è in uno dei tre stati:

Entrambi i percorsi di chiamata calcolano il flag dalla stessa regola: la facciata C# DocumentConverter lo deriva internamente dallo stato IsViewerLicensed e IsTemporary della licenza, e il gestore ?convert=run del widget esegue lo stesso controllo (IsViewerLicensed && !IsTrial && !IsTemporary) per compilare il campo watermarked restituito. Un'integrazione può essere costruita e testata end‑to‑end su una licenza di valutazione prima dell'acquisto — solo i byte di output cambiano.