Viewer
Ana belge görüntüleyici sınıfı
Viewer (namespace Doconut) belgeleri MVC denetleyicilerinden, Web Forms sayfalarından ve işleyicilerden açmak için genel giriş noktasını sağlar. DoconutHost.Initialize tarafından oluşturulan geçici bir hizmettir; kullandığınız yerde çözün:
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();new Viewer(), DoconutHost.Initialize çalıştıktan sonra da çalışır — aynı hizmetleri çözer — bu da klasik paketten taşınan kodun derlenmesini sağlar. Initialize'den önce, InvalidOperationException fırlatır.
Viewer hiçbir istek başına belge durumu tutmaz ve kasıtlı olarak uygulamaz IDisposable: belge oturumları ondan bağımsız olarak yaşar, bu yüzden bir Viewer'i yok etmek açık bir belgeyi asla kapatamaz (bkz. Görüntüleyicinin Nasıl Çalıştığı).
OpenDocumentAsync
Bir belge açar ve widget'ın sonraki tüm isteklerde kullandığı oturum belirtecini döndürür. UnsafeMode false olduğunda (varsayılan), belirteç geçerli isteğin ASP.NET oturumuna verilir — oturum durumu olan bir istekten çağırın (bkz. Oturumlar ve Güvenlik).
| Aşırı Yükleme | Ne zaman kullanılmalı |
|---|---|
Task<string> OpenDocumentAsync(string filePath, DocOptions? options = null, CancellationToken ct = default) | Diskten otomatik format algılama ve formatın varsayılan yapılandırmasıyla açma |
Task<string> OpenDocumentAsync(string filePath, BaseConfig? config, DocOptions? options = null, CancellationToken ct = default) | Format başına render seçeneklerine ihtiyacınız varsa (PdfConfig, WordConfig, …) |
Task<string> OpenDocumentAsync(Stream stream, FileInfo fileInfo, BaseConfig? config = null, DocOptions? options = null, CancellationToken ct = default) | Belge disk üzerinde bir dosya değildir (yükleme, veritabanı, blob). fileInfo doğru uzantıyı taşımalıdır — formatı seçer |
// Basit aç
string token = await viewer.OpenDocumentAsync(path);
// Biçim başına yapılandırma ve seçeneklerle
token = await viewer.OpenDocumentAsync(
path,
new PdfConfig { AllowSearch = true, AllowCopy = true },
new DocOptions { TimeOut = 30 });
// Bir yüklemeden (MVC'de HttpPostedFileBase; Web Forms'ta HttpPostedFile)
using (var ms = new MemoryStream())
{
await file.InputStream.CopyToAsync(ms);
ms.Position = 0;
token = await viewer.OpenDocumentAsync(ms, new FileInfo(Path.GetFileName(file.FileName)));
}Ele alınması gereken istisnalar:
LicenseException— bir lisans bulundu ancak reddedildi (mesaj nedeni taşır), ya da format lisansın vermediği bir eklenti yeteneğine ihtiyaç duyuyor.FormatNotSupportedException— hiçbir görüntüleyici dosyanın uzantısını işleyemez.InvalidDataException— içerik bozuk veya uzantısıyla eşleşmiyor.
OpenDocument (synchronous)
Web Forms kod-arkası ve asenkron sayfalar kullanmayan diğer kodlar için:
string OpenDocument(string filePath, BaseConfig? config = null, DocOptions? options = null)
string OpenDocument(Stream stream, string fileName, BaseConfig? config = null, DocOptions? options = null)
string OpenDocument(byte[] bytes, string fileName, BaseConfig? config = null, DocOptions? options = null)Her biri belirteci döndürür ve ayrıca viewer.Token içinde saklar. fileName doğru uzantıyı taşımalıdır. Bu sarmalayıcılar bir Web Forms sayfasından çağırmak için güvenlidir: açma yolu ASP.NET istek bağlamında asla devam etmez, bu yüzden beklemek deadlock oluşturamaz. Aynı durum her asenkron Doconut API'si için geçerli değildir — Converter Plugin sayfasının Web Forms bölümüne bakın.
CloseDocument
void CloseDocument(string token)Oturumu kaldırır (belge motorunu hemen serbest bırakır), geçerli isteğin ASP.NET oturumundan token'ın iznini kaldırır ve token'ı iptal eder. İsteğe bağlı — kayar süresiz (sliding expiration) aynı temizlik işlemini yapar — ancak büyük belgeler için önerilir.
Oturum Sorguları
| Üye | Döndürür |
|---|---|
int GetPageCount(string token) | Açık belgenin toplam sayfa sayısı |
(int Width, int Height) GetPageDimensions(string token, int page = 1) | %100 yakınlaştırmada varsayılan işlenmiş sayfa boyutu — kod içinde oluşturulan açıklamalar için koordinat alanı |
IReadOnlyList<string> GetWorksheetNames(string token) | Bir elektronik tablonun işlenmiş çalışma sayfaları, çalışma kitabı sırasına göre; diğer belgeler için boş |
Her biri token bilinmiyorsa veya süresi dolmuşsa InvalidOperationException (Document session not found. Please re-open document.) hatasını fırlatır ve boş token için ArgumentException hatasını fırlatır.
DocOptions
Açık belge başına, format bağımsız seçenekler (ad alanı Doconut):
| Tür | Özellik | Varsayılan | Açıklama |
|---|---|---|---|
string | Password | "" | Korunan belgeler için şifre (format yapılandırmasına otomatik olarak kopyalanır). |
string | Watermark | "" | İşlenmiş sayfalara çizilen özel filigran metni — aşağıya bakın. |
int | TimeOut | 60 | Oturum kayar süresizliği, dakika cinsinden. |
string | BrowserId | "" | Web çiftlikleri: imzalı bir biletin bağlandığı tarayıcı. Bunu DoconutFarmBinding.EnsureBrowserId ile ayarlayın (bkz. Oturumlar ve Güvenlik). |
string | UserId | "" | Web çiftlikleri: biletin bağlandığı oturum açmış kullanıcı, DoconutFarmBinding.ResolveUserId üzerinden. |
int | ImageResolution | 0 | Eski. Bunun yerine format yapılandırmasında ImageResolution ayarlayın. |
bool | IsSecured | true | Ayrılmış; uygulanmaz. Erişim kontrolü DoconutOptions.UnsafeMode. |
bool | IsWebFarm / string WebFarmPath | false / "" | Klasik paketten taşınan kod için tutulur. Onlar çiftlik modunu açmaz — AddDoconutDistributed açar. |
bool | EditMode | false | Ayrı dağıtılan editör için ayrılmış; false bırakın. |
Özel filigran
DocOptions.Watermark altı tilde‑ayırılmış alan alır. İsteğe bağlı bir ön ^ tüm köşe düzenini talep eder:
^Text~Color~FontSize~FontName~Opacity~Anglestring token = await viewer.OpenDocumentAsync(
path,
new PdfConfig(),
new DocOptions
{
Watermark = "^Confidential~Red~24~Verdana~80~-45",
TimeOut = 30
});| Alan | Örnek | Anlam |
|---|---|---|
Ön ^ | ^ | İsteğe bağlı tüm köşe düzeni. Olmazsa, normal yerleşim kullanılır. |
| Metin | Confidential | Her sayfada çizilen metin. Boş olmamalıdır. |
| Renk | Red | Adlandırılmış bir renk. |
| YazıBoyutu | 24 | Yazı boyutu; geçersiz sayısal giriş varsayılana geri döner. |
| YazıTipi | Verdana | Yazı tipi ailesi. Sunucuya kurulmuş olmalı — Windows Server, bir masaüstünden daha az yazı tipine sahiptir. |
| Saydamlık | 80 | 0 ile 255 arasında. Ayrıştırılabilmelidir. |
| Açı | -45 | Derece cinsinden dönüş; geçersiz sayısal giriş varsayılana geri döner. |
Ayrıştırıcı, isteğe bağlı ^ sonrasında tam olarak altı alan bekler. Geçersiz bir tanım, sessizce kaybolmak yerine görünür bir Invalid Watermark metni ile değiştirilir.
Lisans kararı
| Lisans durumu | Özel değer sağlandı | İşlenen sonuç |
|---|---|---|
| Geçerli ücretli görüntüleyici lisansı | Hayır | Temiz sayfa |
| Geçerli ücretli görüntüleyici lisansı | Evet | Özel filigran |
| Etkin Geçici/Demo lisansı | Hayır | Temiz sayfa |
| Etkin Geçici/Demo lisansı | Evet | Özel filigran |
| Eksik, reddedilmiş, süresi dolmuş, yanlış sürüm veya geçersiz alan adı lisansı | Her ikisi | Değerlendirme filigranı; özel değer onu değiştirmez |
Aynı karar, sunulan sayfalara ve açıklama dışa aktarmalarına da uygulanır. Özel filigran, lisanslı bir uygulamanın özelliğidir, değerlendirme filigranını değiştirmek için bir yol değildir.
Açıklamalar API
Sunucu tarafı açıklama yükleme ve dışa aktarma. Adım adım kılavuz Açıklamalar içinde bulunur.
| Üye | Amaç |
|---|---|
AnnotationManager GetAnnotationManager(string token) | Açık oturumun sayfa boyutlarına bağlı yönetici |
AnnotationManager GetAnnotationManager(string token, int pageWidth, int pageHeight) | Açık sayfa boyutlarıyla yönetici |
AnnotationManager GetAnnotationManager(int pageWidth, int pageHeight) | Oturumdan bağımsız yönetici |
void LoadAnnotationData(string token, AnnotationManager manager) | C#'ta oluşturulan açıklamaları oturuma yükle |
void LoadAnnotationData(string token, string annotationData) | AnnotationManager.GetAnnotationData() tarafından döndürülen kodlanmış zarfı yükle |
void LoadAnnotationXML(string token, XmlDocument annotationXml) | XML'den açıklamaları yükle |
XmlDocument GetAnnotationXML(string token) | Oturumun açıklamalarını XML olarak dışa aktar |
Task<byte[]> ExportAnnotationsToPdfAsync(string token, int zoom = 100, CancellationToken ct = default) | Açıklamaları gömülü PDF |
Task<int> ExportAnnotationsToPngAsync(string token, string directoryPath, int zoom = 100, CancellationToken ct = default) | Sayfa başına bir PNG, açıklamaları gömülü, directoryPath'a yazılır (eksikse oluşturulur); yazılan görüntü sayısını döndürür |
Task<byte[]> ExportAnnotationsToPngZipAsync(string token, int zoom = 100, CancellationToken ct = default) | Açıklamaları gömülü sayfa başı PNG'lerin ZIP'i |
DICOM meta verileri
Task<DicomMetadata?> GetDicomMetadataAsync(string token, CancellationToken ct = default)Bu paket üzerinde her zaman null döndürür ve widget'ın meta veri isteği 501 Not Implemented yanıtını verir: DICOM etiketlerini okuma .NET Framework'ta mevcut değildir. DICOM rendering — sayfalar, çerçeveler ve animasyon — çalışır. Bkz. DICOM Eklentisi.
Kaynak yardımcıları — ReferenceCss / ReferenceScripts
Kaynak modülünün DoconutOptions.ResourcesPath altında sunduğu kaynaklar için <link> ve <script> etiketlerini bağımlılık sırasına göre oluştur. Lisans kontrollü özelliklerin (Arama, Açıklama) dosyaları yalnızca lisans izin verdiğinde oluşturulur.
string ReferenceCss(CssConfig? config = null) // null → Bootstrap + görüntüleyici + arama + not
string ReferenceScripts(ScriptConfig? config = null)
bool IsSearchEnabled { get; } // lisans durumu, şerit başlatma kodunu korumak için
bool IsAnnotationEnabled { get; }CssConfig bayrakları: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (arama kontrollü), IncludeAnnotationCss (açıklama kontrollü).
ScriptConfig bayrakları: IncludeJQuery (tüm diğerleri tarafından gereklidir), IncludeBootstrap, IncludeViewerScripts (çekirdek görüntüleyici betikleri), IncludeSearchScripts ve IncludeSearchBar (arama kontrollü), IncludeAnnotationScripts ve IncludeAnnotationBar (açıklama kontrollü), EmitFeatureFlags (varsayılan true: ayrıca satır içi window.Doconut.features = { search, annotation, editor } betiği yazar; satır içi betiği engelleyen bir Content-Security-Policy altında false olarak ayarlayın).
Her ikisi de HTML döndürür: MVC 5'te @Html.Raw(...) ile (denetleyicide üretin — görünümlerde @inject yoktur) veya Web Forms'ta <%= %> ile yazın. Hızlı Başlangıç her ikisini gösterir.
RenderViewer
string RenderViewer(string elementId, string token, ViewerConfig? config = null)<script> bloğu döndürür; bu blok, id'si elementId olan öğede widget'ı başlatır ve belgeyi gösterir: docViewer({...}), ViewerConfig'den (varsayılan: BasePath: '/', ResPath: 'doconut-res/images') oluşturulur, ardından .View(token). Görüntüleyici betiklerinden sonra yazın. Oluşturulan betik, görüntüleyici nesnesine referans tutmaz, bu yüzden kendi araç çubuğuna sahip bir sayfa widget'ı elle başlatmalıdır. Bkz. ViewerConfig.
Web çiftliği
string? AccessToken, dağıtılmış mod aktif olduğunda ve en son açma işlemi tarafından verilen imzalı bileti tutar; UnsafeMode false olduğunda; tek bir sunucuda null olur. Bileti widget'a token ile gönderin: objViewer.View(token, accessToken).
Bu sayfa yardımcı oldu mu?