DoconutOptions
Konfigurieren Sie die Doconut-Dienste
DoconutOptions (namespace Doconut) ist das einzige Konfigurationsobjekt für das gesamte SDK. Sie konfigurieren es einmal, im Callback, den Sie an DoconutHost.Initialize in Application_Start übergeben.
Doconut.DoconutHost.Initialize(options =>
{
options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
options.UnsafeMode = false;
options.ShowDoconutInfo = false;
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});Eigenschaften
| Typ | Eigenschaft | Standard | Beschreibung |
|---|---|---|---|
bool | UnsafeMode | false | Wenn false, liefert DocImage.axd eine Seite nur an die ASP.NET‑Sitzung, die das Dokument geöffnet hat (oder in einem Farm‑Szenario an den Browser mit einem signierten Ticket). Wenn true, wird jede Anfrage, die das Token trägt, bedient. Lassen Sie es false – siehe Sitzungen & Sicherheit. |
bool | ShowDoconutInfo | false | Wenn true, beantwortet eine DocImage.axd‑Anfrage ohne Token Doconut <version> is running on <host> anstelle von 404. Nützlich als Schnelltest; lassen Sie false in der Produktion. |
string | ResourcesPath | "/doconut-res" | URL-Präfix, unter dem das Ressourcenmodul die eingebetteten Skripte, Styles und Bilder bereitstellt. |
string | LicensePath | "" | Vollständiger Pfad zur Lizenzdatei. Leer → die nächste Lizenzquelle, dann automatische Erkennung; nichts gefunden → wasserzeichenbasierte Evaluation ohne Funktionen. |
string | LicenseContent | "" | Roh‑Lizenzinhalt (Datenbank, Umgebungsvariable, Geheimspeicher). Hat Vorrang vor LicensePath. |
Stream? | LicenseStream | null | Lizenz als Stream, einmal beim Start gelesen. Hat Vorrang vor beiden anderen Quellen. |
string | MiddlewarePath | "/doconut" | Wird von System.Web nicht verwendet. Der Seiten‑Endpunkt ist immer der DocImage.axd‑Handler, der in Web.config deklariert ist. Der Wert wird weiterhin beim Start validiert (siehe unten). |
bool | ResetLicense | false | Wird nicht verwendet. Die Lizenz wird einmal gelesen, in DoconutHost.Initialize; den Anwendungspool nach dem Ersetzen einer Lizenz neu starten. |
DoconutPluginRegistry | PluginRegistry | — | Schreibgeschütztes Register von Plugin‑Beiträgen, gefüllt von AddPlugin<T>(). |
Lizenzpriorität: LicenseStream → LicenseContent → LicensePath → automatische Erkennung (siehe Lizenz‑Einrichtung).
Methoden
AddPlugin<TPlugin>()
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()Registriert ein Plugin (Converter, DICOM, Signer). Fluent — gibt die Options‑Instanz zurück. Annotation und Search sind integrierte lizenzierte Funktionen und nutzen es nicht.
Wenn keine aktive Lizenz die Fähigkeit des Plugins gewährt, wirft DoconutHost.Initialize InvalidOperationException aus Application_Start, und die Seite beantwortet jede Anfrage mit einem leeren 500, bis das behoben ist; die Meldung befindet sich im Windows‑Ereignisprotokoll (siehe Plugin‑System).
Add…Widget()
DoconutOptions AddConverterWidget(Action<ConverterWidgetOptions>? configure = null)
DoconutOptions AddSignerWidget(Action<SignerWidgetOptions>? configure = null)Die Drop‑In‑Widgets sind standardmäßig deaktiviert. Jeder Add…Widget()‑Aufruf schaltet die Endpunkte dieses Widgets auf DocImage.axd ein und erfordert, dass das passende Plugin registriert ist. Das Ressourcenmodul liefert das Widget‑Skript, egal ob Sie es aktiviert haben, sodass ein Widget, das lädt und zeichnet, aber bei seiner ersten Aktion 404 beantwortet, diesen Aufruf fehlt. Das Converter‑Widget ist im Converter‑Plugin dokumentiert; das Signer‑Widget, AddSignerWidget(), im Signer‑Plugin.
RegisterViewer(extension, factory, defaultConfig?)
DoconutOptions RegisterViewer(
string extension, // ".myext" — führender Punkt optional
Func<IFormatViewer> factory,
Func<BaseConfig>? defaultConfig = null)Registriert einen benutzerdefinierten Viewer für eine Dateierweiterung. Benutzerdefinierte Viewer haben Vorrang vor integrierten und Plugin‑Viewern und sind nicht lizenzgebunden. Wenn defaultConfig weggelassen wird und ein Dokument ohne explizite Konfiguration geöffnet wird, wird ein ImageConfig verwendet.
Wirft ArgumentException (Extension must be a non-empty file extension.) bei einer leeren Erweiterung und ArgumentNullException bei einer null‑Factory.
Startvalidierung
DoconutHost.Initialize validiert die Optionen, bevor irgendetwas gebaut wird:
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 wird geprüft, obwohl System.Web es nie verwendet, lassen Sie es also auf dem Standardwert. Wie jede Ausnahme, die von Application_Start geworfen wird, erscheint ein Validierungsfehler als leeres 500 bei jeder Anfrage, wobei die Meldung im Windows‑Ereignisprotokoll steht.
Häufige Konfigurationen
// Production: explizite Lizenz, alles andere mit seiner sicheren Standardeinstellung.
public static void ProductionLicense() =>
Doconut.DoconutHost.Initialize(options =>
{
options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});
// Benutzerdefinierter Ressourcenpfad (z. B. um einen Routen-Konflikt zu vermeiden). Behalte den ResPath des Viewers und jedes MVC
// IgnoreRoute im Einklang damit: "/docs-assets" bedeutet ResPath: 'docs-assets/images'.
public static void CustomResourcePath() =>
Doconut.DoconutHost.Initialize(options =>
{
options.ResourcesPath = "/docs-assets";
});Wenn Sie ResourcesPath ändern, ändern Sie drei Dinge gleichzeitig: die Option, das Widget‑ResPath ('docs-assets/images' für "/docs-assets") und, in MVC, das IgnoreRoute für den Ressourcen‑Pfad (routes.IgnoreRoute("docs-assets/{*pathInfo}")). Der DocImage.axd‑Endpunkt verschiebt sich nicht: Sein Pfad wird durch das path‑Attribut des Handlers in Web.config festgelegt.
War diese Seite hilfreich?