Penampil

Viewer (namespace Doconut) adalah titik masuk publik untuk membuka dokumen dari kontroler MVC, halaman Web Forms, dan handler. Ini adalah layanan transient yang disusun oleh DoconutHost.Initialize; selesaikan di tempat Anda menggunakannya:

var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();

new Viewer() juga berfungsi setelah DoconutHost.Initialize dijalankan — ia menyelesaikan layanan yang sama — yang menjaga kode yang dipindahkan dari paket klasik tetap dapat dikompilasi. Sebelum Initialize, ia melempar InvalidOperationException.

Viewer tidak menyimpan status dokumen per‑permintaan dan secara sengaja tidak mengimplementasikan IDisposable: sesi dokumen hidup secara independen darinya, sehingga membuang (disposing) sebuah Viewer tidak akan pernah menutup dokumen yang terbuka (lihat Cara Kerja Penampil).

OpenDocumentAsync

Membuka sebuah dokumen dan mengembalikan token sesi yang digunakan widget untuk setiap permintaan selanjutnya. Ketika UnsafeMode adalah false (bawaan), token diberikan ke sesi ASP.NET dari permintaan saat ini — panggil dari permintaan yang memiliki status sesi (lihat Sesi & Keamanan).

// Buka sederhana
string token = await viewer.OpenDocumentAsync(path);

// Dengan konfigurasi dan opsi per-format
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// Dari unggahan (HttpPostedFileBase di MVC; HttpPostedFile di Web Forms)
using (var ms = new MemoryStream())
{
    await file.InputStream.CopyToAsync(ms);
    ms.Position = 0;
    token = await viewer.OpenDocumentAsync(ms, new FileInfo(Path.GetFileName(file.FileName)));
}

Pengecualian yang harus ditangani:

• LicenseException — sebuah lisensi ditemukan tetapi ditolak (pesan membawa alasannya), atau format membutuhkan kemampuan plugin yang tidak diberikan oleh lisensi.
• FormatNotSupportedException — tidak ada penampil yang menangani ekstensi file.
• InvalidDataException — konten rusak atau tidak cocok dengan ekstensinya.

OpenDocument (sinkron)

Untuk kode‑behind Web Forms dan kode lain yang tidak menggunakan halaman asinkron:

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)

Setiapnya mengembalikan token dan juga menyimpannya di viewer.Token. fileName harus membawa ekstensi yang tepat. Pembungkus ini aman dipanggil dari halaman Web Forms: jalur buka tidak pernah melanjutkan pada konteks permintaan ASP.NET, sehingga menunggu tidak dapat menyebabkan deadlock. Hal yang sama tidak berlaku untuk setiap API Doconut asinkron — lihat bagian Web Forms dari Plugin Konverter.

TutupDokumen

void CloseDocument(string token)

Menghapus sesi (melepaskan mesin dokumen secara langsung), menghapus hak token dari sesi ASP.NET permintaan saat ini, dan mencabut token. Opsional — kedaluwarsa bergulir melakukan pembersihan yang sama — tetapi disarankan untuk dokumen besar.

Kueri Sesi

Masing‑masing melempar pengecualian jika token tidak dikenal atau kedaluwarsa.

Opsi Dokumen

Opsi per‑buka, independen format (namespace Doconut):

Watermark Kustom

DocOptions.Watermark menerima enam bidang yang dipisahkan tilde. ^ opsional di awal meminta tata letak semua sudut:

^Text~Color~FontSize~FontName~Opacity~Angle

string token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig(),
    new DocOptions
    {
        Watermark = "^Confidential~Red~24~Verdana~80~-45",
        TimeOut = 30
    });

Parser mengharapkan tepat enam bidang setelah ^ opsional. Definisi yang tidak valid digantikan dengan teks Invalid Watermark yang terlihat alih‑alih menghilang secara diam‑diam.

Keputusan Lisensi

Keputusan yang sama berlaku untuk halaman yang disajikan dan untuk ekspor anotasi. Watermark khusus adalah fitur aplikasi berlisensi, bukan cara menggantikan watermark evaluasi.

API Anotasi

Pemuat anotasi sisi server dan ekspor. Panduan lengkap ada di Anotasi.

Metadata DICOM

Task<DicomMetadata?> GetDicomMetadataAsync(string token, CancellationToken ct = default)

Pada paket ini selalu mengembalikan null, dan permintaan metadata widget menjawab 501 Not Implemented: membaca tag DICOM tidak tersedia pada .NET Framework. rendering DICOM — halaman, bingkai, dan animasi — berfungsi. Lihat Plugin DICOM.

Pembantu Sumber Daya — ReferenceCss / ReferenceScripts

Emit <link> dan <script> tag untuk sumber daya yang dilayani modul sumber daya di bawah DoconutOptions.ResourcesPath, dalam urutan ketergantungan. Berkas untuk fitur yang dibatasi lisensi (Search, Annotation) dikeluarkan hanya ketika lisensi memberikannya.

string ReferenceCss(CssConfig? config = null)       // null → Bootstrap + viewer + search + annotation
string ReferenceScripts(ScriptConfig? config = null)
bool IsSearchEnabled { get; }                       // status lisensi, untuk melindungi kode init ribbon
bool IsAnnotationEnabled { get; }

CssConfig bendera: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (search-gated), IncludeAnnotationCss (annotation-gated).

ScriptConfig bendera: IncludeJQuery (dibutuhkan oleh semua yang lain), IncludeBootstrap, IncludeViewerScripts (skrip penampil inti), IncludeSearchScripts dan IncludeSearchBar (search-gated), IncludeAnnotationScripts dan IncludeAnnotationBar (annotation-gated).

Keduanya mengembalikan HTML: tulis mereka dengan @Html.Raw(...) di MVC 5 (hasilkan di controller — tampilan tidak memiliki @inject) atau <%= %> di Web Forms. Panduan Cepat menunjukkan keduanya.

RenderViewer

string RenderViewer(string elementId, string token, ViewerConfig? config = null)

Mengembalikan blok <script> yang menginisialisasi widget pada elemen dengan id elementId dan menampilkan dokumen: docViewer({...}) dibangun dari ViewerConfig (default: BasePath: '/', ResPath: 'doconut-res/images'), kemudian .View(token). Tulis setelah skrip penampil. Skrip yang dihasilkan tidak menyimpan referensi ke objek penampil, sehingga halaman dengan toolbar sendiri harus menginisialisasi widget secara manual. Lihat KonfigurasiPenampil.

Farm Web

string? AccessToken menyimpan tiket yang ditandatangani yang dikeluarkan oleh pembukaan terbaru ketika mode terdistribusi aktif dan UnsafeMode adalah false; ia adalah null pada satu server. Kirimkan ke widget dengan token: objViewer.View(token, access).