گزینه‌های Doconut

DoconutOptions (namespace Doconut) یک شیء پیکربندی تک برای کل SDK است. شما آن را یک‌بار در کال‌بکی که به DoconutHost.Initialize در Application_Start می‌گذارید، تنظیم می‌کنید.

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

ویژگی‌ها

اولویت لایسنس: LicenseStream → LicenseContent → LicensePath → کشف خودکار (به License Setup مراجعه کنید).

متدها

AddPlugin<TPlugin>()

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

یک افزونه (مبدل، DICOM) را ثبت می‌کند. به‌صورت fluent — نمونهٔ گزینه‌ها را برمی‌گرداند. Annotation و Search ویژگی‌های لایسنس‌دار داخلی هستند و از این متد استفاده نمی‌کنند.

اگر لایسنس فعال قابلیت افزونه را ندهد، DoconutHost.Initialize یک InvalidOperationException از Application_Start پرتاب می‌کند و سایت هر درخواست را با یک 500 خالی پاسخ می‌دهد تا مشکل رفع شود؛ پیام در لاگ رویداد ویندوز ثبت می‌شود (به Plugin System نگاه کنید).

Add…Widget()

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

ویجت‌های آماده به‌صورت پیش‌فرض غیرفعال هستند. هر فراخوانی Add…Widget() انتهای مربوط به آن ویجت را در DocImage.axd فعال می‌کند و نیاز به ثبت افزونهٔ متناظر دارد. ماژول منابع اسکریپت ویجت را صرف‌نظر از فعال بودن سرو می‌کند، بنابراین ویجتی که بارگذاری و رسم می‌شود اما در اولین عملش 404 می‌دهد، این فراخوانی را از دست داده است. ویجت مبدل در Converter Plugin مستند شده است.

RegisterViewer(extension, factory, defaultConfig?)

DoconutOptions RegisterViewer(
    string extension,                    // ".myext" — نقطهٔ پیشوند اختیاری
    Func<IFormatViewer> factory,
    Func<BaseConfig>? defaultConfig = null)

یک نمایشگر سفارشی برای پسوند فایل ثبت می‌کند. نمایشگرهای سفارشی بر نمایشگرهای داخلی و افزونه‌ها اولویت دارند و تحت لایسنس نیستند. وقتی defaultConfig حذف شود و سندی بدون پیکربندی صریح باز شود، یک ImageConfig استفاده می‌شود.

برای پسوند خالی ArgumentException (Extension must be a non-empty file extension.) و برای کارخانهٔ null ArgumentNullException پرتاب می‌شود.

اعتبارسنجی هنگام راه‌اندازی

DoconutHost.Initialize قبل از ساختن هر چیزی گزینه‌ها را اعتبارسنجی می‌کند:

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 حتی اگر System.Web از آن استفاده نکند، بررسی می‌شود، پس آن را به مقدار پیش‌فرض بگذارید. همانند هر استثنای پرتاب‌شده از Application_Start، یک شکست اعتبارسنجی به‌صورت 500 خالی در هر درخواست ظاهر می‌شود و پیام در لاگ رویداد ویندوز ثبت می‌شود.

پیکربندی‌های رایج

// Production: explicit license, everything else at its secure default.
public static void ProductionLicense() =>
    Doconut.DoconutHost.Initialize(options =>
    {
        options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
    });

// Custom resource path (e.g. to avoid a route conflict). Keep the viewer's ResPath and any MVC
// IgnoreRoute in step with it: "/docs-assets" means ResPath: 'docs-assets/images'.
public static void CustomResourcePath() =>
    Doconut.DoconutHost.Initialize(options =>
    {
        options.ResourcesPath = "/docs-assets";
    });

وقتی ResourcesPath را تغییر می‌دهید، سه مورد را همزمان به‌روز کنید: گزینه، ResPath ویجت ('docs-assets/images' برای "/docs-assets")، و در MVC، IgnoreRoute برای مسیر منبع (routes.IgnoreRoute("docs-assets/{*pathInfo}")). نقطهٔ انتهایی DocImage.axd جابه‌جا نمی‌شود: مسیر آن توسط ویژگی path هندلر در Web.config تعیین می‌شود.