DoconutOptions
Doconut hizmetlerini yapılandırın
DoconutOptions (namespace Doconut) bütün SDK için tek yapılandırma nesnesidir. Bunu bir kez, Application_Start içinde DoconutHost.Initialize'a verdiğiniz geri çağırmada yapılandırırsınız.
Doconut.DoconutHost.Initialize(options =>
{
options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
options.UnsafeMode = false;
options.ShowDoconutInfo = false;
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});Özellikler
| Tür | Özellik | Varsayılan | Açıklama |
|---|---|---|---|
bool | UnsafeMode | false | false olduğunda, DocImage.axd yalnızca belgeyi açan ASP.NET oturumuna (veya bir çiftlikte, imzalı bir bilet adı olan tarayıcıya) bir sayfa sunar. true olduğunda, token taşıyan herhangi bir istek sunulur. false bırakın — bkz. Oturumlar ve Güvenlik. |
bool | ShowDoconutInfo | false | true olduğunda, token olmadan bir DocImage.axd isteği Doconut <version> is running on <host> yerine 404 yanıt verir. Duman kontrolü olarak faydalıdır; üretimde false bırakın. |
string | ResourcesPath | "/doconut-res" | Kaynak modülünün gömülü betikleri, stilleri ve görüntüleri sunduğu URL ön eki. |
string | LicensePath | "" | Lisans dosyasının tam yolu. Boş → bir sonraki lisans kaynağı, ardından otomatik keşif; hiçbir şey bulunamazsa → yetenekleri olmayan su işareti ekli değerlendirme. |
string | LicenseContent | "" | Ham lisans içeriği (veritabanı, ortam değişkeni, gizli depo). LicensePath'a göre önceliklidir. |
Stream? | LicenseStream | null | Lisans bir akış olarak, başlangıçta bir kez okunur. Diğer iki kaynağa göre önceliklidir. |
string | MiddlewarePath | "/doconut" | System.Web tarafından kullanılmaz. Sayfa uç noktası her zaman Web.config içinde bildirilen DocImage.axd işleyicisidir. Değer yine de başlangıçta doğrulanır (aşağıya bakın). |
bool | ResetLicense | false | Kullanılmaz. Lisans bir kez, DoconutHost.Initialize içinde okunur; bir lisans değiştirildikten sonra uygulama havuzunu yeniden başlatın. |
DoconutPluginRegistry | PluginRegistry | — | Eklenti katkılarının yalnızca okunabilir kaydı, AddPlugin<T>() tarafından doldurulur. |
Lisans önceliği: LicenseStream → LicenseContent → LicensePath → otomatik keşif (bkz. Lisans Kurulumu).
Yöntemler
AddPlugin<TPlugin>()
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()Bir eklenti (Converter, DICOM, Signer) kaydeder. Akıcı — seçenek örneğini döndürür. Annotation ve Search yerleşik lisanslı özelliklerdir ve onu kullanmaz.
Aktif bir lisans eklentinin yeteneğini vermiyorsa, DoconutHost.Initialize, Application_Start'den InvalidOperationException fırlatır ve site, bu düzeltilene kadar her isteğe boş bir 500 yanıt verir; mesaj Windows olay günlüğündedir (bkz. Eklenti Sistemi).
Add…Widget()
DoconutOptions AddConverterWidget(Action<ConverterWidgetOptions>? configure = null)
DoconutOptions AddSignerWidget(Action<SignerWidgetOptions>? configure = null)Yerleştirilebilir widget'lar varsayılan olarak kapalıdır. Her Add…Widget() çağrısı, o widget'ın uç noktalarını DocImage.axd üzerinde açar ve eşleşen eklentinin kayıtlı olmasını gerektirir. Kaynak modülü, widget'ı etkinleştirip etkinleştirmediğinize bakmaksızın script'i sunar, bu yüzden ilk eyleminde 404 yanıt veren ancak yüklenen ve çizilen bir widget bu çağrıdan eksiktir. Converter widget'ı Converter Eklentisi içinde belgelenmiştir; Signer widget'ı, AddSignerWidget(), Signer Eklentisi içinde.
RegisterViewer(extension, factory, defaultConfig?)
DoconutOptions RegisterViewer(
string extension, // ".myext" — baştaki nokta isteğe bağlı
Func<IFormatViewer> factory,
Func<BaseConfig>? defaultConfig = null)Bir dosya uzantısı için özel görüntüleyici kaydeder. Özel görüntüleyiciler yerleşik ve eklenti görüntüleyicilere göre önceliklidir ve lisans kısıtlamasına tabi değildir. defaultConfig atlandığında ve bir belge açık bir yapılandırma olmadan açıldığında, bir ImageConfig kullanılır.
Boş bir uzantı için ArgumentException (Extension must be a non-empty file extension.) ve null bir fabrika için ArgumentNullException fırlatır.
Başlangıç doğrulaması
DoconutHost.Initialize, herhangi bir şey inşa etmeden önce seçenekleri doğrular:
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 hiç kullanmasa da kontrol edilir, bu yüzden varsayılanında bırakın. Application_Start'den fırlatılan her istisna gibi, bir doğrulama hatası her istekte boş bir 500 olarak görünür, mesaj Windows olay günlüğündedir.
Yaygın yapılandırmalar
// Production: açık lisans, diğer her şey güvenli varsayılanında.
public static void ProductionLicense() =>
Doconut.DoconutHost.Initialize(options =>
{
options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});
// Özel kaynak yolu (ör. bir rota çakışmasını önlemek için). viewer'ın ResPath'ini ve herhangi bir MVC'yi tutun.
// IgnoreRoute ile uyumlu: "/docs-assets" ResPath: 'docs-assets/images' anlamına gelir.
public static void CustomResourcePath() =>
Doconut.DoconutHost.Initialize(options =>
{
options.ResourcesPath = "/docs-assets";
});ResourcesPath'ı değiştirdiğinizde, üç şeyi birlikte değiştirin: seçenek, widget'ın ResPath'ı ('docs-assets/images' için "/docs-assets"), ve MVC'de kaynak yolunun IgnoreRoute'ı (routes.IgnoreRoute("docs-assets/{*pathInfo}")). DocImage.axd uç noktası hareket etmez: yolu, Web.config içinde işleyicinin path özniteliği tarafından ayarlanır.
Bu sayfa yardımcı oldu mu?