DoconutOptions

Configura i servizi Doconut

DoconutOptions (namespace Doconut) è l'oggetto di configurazione unico per l'intero SDK. Lo configuri una volta, nel callback che passi a DoconutHost.Initialize in Application_Start.

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.LicensePath     = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    options.UnsafeMode      = false;
    options.ShowDoconutInfo = false;
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

Proprietà

TipoProprietàPredefinitoDescrizione
boolUnsafeModefalseQuando false, DocImage.axd serve una pagina solo alla sessione ASP.NET che ha aperto il documento (o, in un farm, al browser con un ticket firmato). Quando true, qualsiasi richiesta che trasporta il token viene servita. Lasciare false — vedi Sessioni e Sicurezza.
boolShowDoconutInfofalseQuando true, una richiesta DocImage.axd senza token risponde Doconut <version> is running on <host> invece di 404. Utile come controllo di base; lascia false in produzione.
stringResourcesPath"/doconut-res"Prefisso URL sotto il quale il modulo risorse serve gli script, gli stili e le immagini incorporati.
stringLicensePath""Percorso completo al file di licenza. Vuoto → la prossima fonte di licenza, poi scoperta automatica; se non trovato → valutazione con filigrana senza funzionalità.
stringLicenseContent""Contenuto grezzo della licenza (database, variabile d'ambiente, archivio segreto). Ha precedenza su LicensePath.
Stream?LicenseStreamnullLicenza come stream, letta una volta all'avvio. Ha precedenza su entrambe le altre fonti.
stringMiddlewarePath"/doconut"Non utilizzato da System.Web. L'endpoint della pagina è sempre il gestore DocImage.axd dichiarato in Web.config. Il valore è comunque validato all'avvio (vedi sotto).
boolResetLicensefalseNon utilizzato. La licenza viene letta una volta, in DoconutHost.Initialize; ricicla il pool dell'applicazione dopo aver sostituito una licenza.
DoconutPluginRegistryPluginRegistry—Registro in sola lettura dei contributi dei plugin, compilato da AddPlugin<T>().

Priorità della licenza: LicenseStream → LicenseContent → LicensePath → scoperta automatica (vedi Configurazione Licenza).

Metodi

AddPlugin<TPlugin>()

text
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()

Registra un plugin (Converter, DICOM, Signer). Fluent — restituisce l'istanza delle opzioni. Annotation e Search sono funzionalità con licenza integrate e non lo utilizzano.

Se nessuna licenza attiva concede la capacità del plugin, DoconutHost.Initialize genera InvalidOperationException da Application_Start, e il sito risponde a ogni richiesta con un 500 vuoto finché non viene risolto; il messaggio è nel registro eventi di Windows (vedi Sistema Plugin).

Add…Widget()

text
DoconutOptions AddConverterWidget(Action<ConverterWidgetOptions>? configure = null)
DoconutOptions AddSignerWidget(Action<SignerWidgetOptions>? configure = null)

I widget plug‑in sono disattivati per impostazione predefinita. Ogni chiamata Add…Widget() attiva gli endpoint di quel widget su DocImage.axd, e richiede che il plugin corrispondente sia registrato. Il modulo risorse serve lo script del widget sia che lo abbia abilitato o meno, quindi un widget che si carica e dipinge ma risponde 404 alla sua prima azione manca di questa chiamata. Il widget Converter è documentato in Plugin Converter; il widget Signer, AddSignerWidget(), in Plugin Signer.

RegisterViewer(extension, factory, defaultConfig?)

text
DoconutOptions RegisterViewer(
    string extension,                    // \".myext\" — punto iniziale opzionale
    Func<IFormatViewer> factory,
    Func<BaseConfig>? defaultConfig = null)

Registra un visualizzatore personalizzato per un'estensione di file. I visualizzatori personalizzati hanno precedenza sui visualizzatori integrati e dei plugin e non sono vincolati da licenza. Quando defaultConfig è omesso e un documento si apre senza una configurazione esplicita, viene usato un ImageConfig.

Genera ArgumentException (Extension must be a non-empty file extension.) per un'estensione vuota e ArgumentNullException per una factory nulla.

Convalida all'avvio

DoconutHost.Initialize convalida le opzioni prima di costruire qualsiasi cosa:

text
DoconutOptions.MiddlewarePath must be a non-empty path starting with '/'.
DoconutOptions.ResourcesPath must be a non-empty path starting with '/'.
DoconutOptions.MiddlewarePath and ResourcesPath must be different paths.

MiddlewarePath è controllato anche se System.Web non lo utilizza mai, quindi lasciarlo al valore predefinito. Come ogni eccezione generata da Application_Start, un fallimento di convalida appare come un 500 vuoto in ogni richiesta, con il messaggio nel registro eventi di Windows.

Configurazioni comuni

csharp
// Produzione: licenza esplicita, tutto il resto al suo valore predefinito sicuro.
public static void ProductionLicense() =>
    Doconut.DoconutHost.Initialize(options =>
    {
        options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
    });

// Percorso risorsa personalizzato (ad es. per evitare un conflitto di route). Mantieni il ResPath del visualizzatore e qualsiasi MVC
// IgnoreRoute in step with it: \"/docs-assets\" significa ResPath: 'docs-assets/images'.
public static void CustomResourcePath() =>
    Doconut.DoconutHost.Initialize(options =>
    {
        options.ResourcesPath = "/docs-assets";
    });

Quando cambi ResourcesPath, cambia tre cose insieme: l'opzione, il ResPath del widget ('docs-assets/images' per "/docs-assets"), e, in MVC, il IgnoreRoute per il percorso della risorsa (routes.IgnoreRoute("docs-assets/{*pathInfo}")). L'endpoint DocImage.axd non si sposta: il suo percorso è impostato dall'attributo path del gestore in Web.config.

Questa pagina è stata utile?