Panduan Cepat
Render dokumen pertama Anda di MVC 5 atau Web Forms
Panduan ini mengambil aplikasi ASP.NET pada .NET Framework 4.7.2 dari paket yang terpasang ke dokumen yang dirender di peramban: Global.asax, sebuah endpoint terbuka, aset penampil, widget, dan token yang menghubungkan semuanya. Ini mengasumsikan pendaftaran Web.config dari Instalasi sudah ada — tanpa handler DocImage.axd dan modul sumber daya, tidak ada yang di bawah ini dapat menjangkau server.
Susun Doconut di Global.asax
Sebuah Application_Start lengkap untuk aplikasi MVC 5:
// Global.asax.cs - susun sekali per proses pekerja, lepaskan saat dimatikan.
protected void Application_Start()
{
Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
Doconut.DoconutHost.Initialize(options =>
{
options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
options.UnsafeMode = false; // halaman hanya dilayani ke sesi yang membuka dokumen
});
// hanya MVC: jaga dua endpoint Doconut tetap di luar routing.
RouteTable.Routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
RouteTable.Routes.IgnoreRoute("doconut-res/{*pathInfo}");
}
protected void Application_End()
{
Doconut.DoconutHost.Shutdown();
}Encoding.RegisterProvidermembuat halaman kode warisan yang digunakan oleh beberapa format dokumen tersedia bagi proses. Panggil sekali, sebelum dokumen pertama dibuka.UnsafeMode = falseadalah nilai default, dituliskan agar tidak ada yang mengubahnya secara tidak sengaja:DocImage.axdmenyajikan halaman hanya kepada sesi ASP.NET yang membuka dokumen.- Dua panggilan
IgnoreRoutemenjaga routing MVC jauh dariDocImage.axddan/doconut-res/*, yang dilayani oleh handler dan modul. Aplikasi Web Forms tidak memiliki rute MVC dan tidak memerlukan baris tersebut. DoconutHost.Shutdownmenghentikan pekerjaan latar belakang Doconut dan melepaskan layanannya ketika pool aplikasi di-recycle. Aman dipanggil bahkan jikaInitializetidak pernah dijalankan.
Buka dokumen
Membuka dokumen mengembalikan token yang tidak dapat dilihat. Widget mengirim token tersebut dengan setiap permintaan halaman.
Di MVC 5, aksi controller menyelesaikan layanan Viewer dari DoconutHost.Services — MVC 5 tidak memiliki injeksi konstruktor untuknya:
// POST /Document/Open
[HttpPost]
public async Task<ActionResult> Open()
{
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
// Token tidak dapat dibaca - serahkan ke penampil, jangan pernah mencatat atau menyimpannya.
string token = await viewer.OpenDocumentAsync(Server.MapPath("~/files/Sample.pdf"));
return Json(new { token });
}Dokumen harus dibuka di dalam permintaan yang memiliki status sesi, karena pembukaannya yang memberikan sesi ASP.NET saat ini akses ke halamannya. Controller MVC dan halaman Web Forms memiliki status sesi secara default. IHttpHandler khusus tidak memilikinya, kecuali ia mengimplementasikan System.Web.SessionState.IRequiresSessionState. Buka dokumen dari handler tanpa itu, dan penampil akan menampilkan "Anda Tidak Diizinkan Melihat Halaman Ini." pada setiap halaman.
Di Web Forms, halaman itu sendiri dapat membuka dokumen di code-behind-nya. OpenDocument adalah bentuk sinkron dari OpenDocumentAsync, ditujukan untuk code-behind yang tidak menggunakan halaman asinkron:
// Default.aspx.cs
protected string Token;
protected void Page_Load(object sender, EventArgs e)
{
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
Token = viewer.OpenDocument(Server.MapPath("~/files/Sample.pdf"));
}Perlakukan token seperti kredensial bearer: jangan pernah mencatatnya atau menyimpannya; berikan hanya kepada widget. Token akan berhenti berfungsi ketika sesi dokumen kedaluwarsa — buka kembali dokumen untuk mendapatkan token baru.
Referensi aset penampil
Viewer.ReferenceCss dan Viewer.ReferenceScripts menghasilkan tag <link> dan <script> untuk aset yang disematkan, dalam urutan ketergantungan, mengarah ke /doconut-res/. Widget ini adalah plugin jQuery, jadi jQuery datang pertama.
MVC 5. Tampilan tidak memiliki @inject, jadi hasilkan tag di kontroler dan teruskan mereka pada ViewBag:
public ActionResult Index()
{
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
ViewBag.ViewerCss = viewer.ReferenceCss(new CssConfig
{
IncludeBootstrapCss = true,
IncludeViewerCss = true
});
ViewBag.ViewerScripts = viewer.ReferenceScripts(new ScriptConfig
{
IncludeJQuery = true,
IncludeBootstrap = true,
IncludeViewerScripts = true
});
return View();
}@Html.Raw(ViewBag.ViewerCss)
...
@Html.Raw(ViewBag.ViewerScripts)Pertahankan pekerjaan itu di kontroler. MVC 5 mengompilasi tampilan saat pertama kali disajikan, dan tanpa paket kompiler tambahan kompiler itu hanya memahami C# 5 — tidak ada ?., tidak ada $"...", tidak ada nameof. Sebuah tampilan yang menggunakan mereka dikompilasi bersih di Visual Studio, lalu mengembalikan 500 kosong di peramban.
Web Forms. Paparkan string yang sama dari kode-behind dan tulis mereka dengan <%= %>:
<head>
<%= ViewerCss %>
</head>
<body>
...
<%= ViewerScripts %>
</body>IncludeViewerCss dan IncludeViewerScripts adalah inti wajib. Untuk menambahkan pita Pencarian dan Anotasi, juga atur IncludeSearchCss, IncludeAnnotationCss, IncludeSearchScripts, IncludeSearchBar, IncludeAnnotationScripts, dan IncludeAnnotationBar. Kedua metode mengabaikan file pita ketika lisensi tidak memberikan kemampuan itu; penampil itu sendiri tetap mulai.
Tambahkan penampil ke halaman
Permukaan rendering adalah dua div yang bersarang:
<div id="divDocViewer">
<div id="div_ctlDoc"></div>
</div>Berikan div luar tinggi yang sebenarnya — penampil mengisi kontainernya dan mengukurnya saat mulai. Penampil tidak menggambar toolbar‑nya sendiri: GotoPage, Next, Zoom, FitType dan sisanya adalah metode yang halaman Anda hubungkan ke tombolnya sendiri, ditempatkan di samping penampil:
<nav id="toolbar" aria-label="Document viewer controls">
<button type="button" onclick="objViewer.GotoPage(1)">First</button>
<button type="button" onclick="objViewer.Next(false)">Previous</button>
<button type="button" onclick="objViewer.Next(true)">Next</button>
<button type="button" onclick="objViewer.Zoom(false)">Zoom out</button>
<button type="button" onclick="objViewer.Zoom(true)">Zoom in</button>
<button type="button" onclick="objViewer.FitType('width')">Fit width</button>
</nav>Inisialisasi penampil dan tampilkan dokumen
Setelah skrip penampil, buat widget, lalu berikan token kepadanya:
var objViewer = $('#div_ctlDoc').docViewer({
showThumbs: true,
autoLoad: false,
pageZoom: 100,
FitType: 'width',
BasePath: '/', // '/' berarti DocImage.axd di root situs
ResPath: 'doconut-res/images', // tidak ada '/' di depan
onViewerReady: function () {
// halaman terlihat; sembunyikan indikator pemuatan di sini
},
onError: function (message) {
console.error('Doconut viewer error:', message);
}
});
fetch('/Document/Open', { method: 'POST' })
.then(function (resp) { return resp.json(); })
.then(function (data) { objViewer.View(data.token); });Di Web Forms, di mana halaman membuka dokumen itu sendiri, tiga baris terakhir menjadi objViewer.View('<%= Token %>');.
Empat detail di sini gagal tanpa pesan kesalahan:
BasePath: '/'mengarah keDocImage.axddi akar situs. Untuk aplikasi dalam direktori virtual, gunakan namanya tanpa garis miring ('myapp'meminta/myapp/DocImage.axd). Garis miring di depan ('/myapp') menghasilkan//myapp/DocImage.axd, yang dibaca peramban sebagai permintaan ke host lain.ResPath: 'doconut-res/images'— ikon berada satu folder di bawah akar sumber daya. Dengan'doconut-res', setiap ikon mengembalikan 404: tidak ada glyph toolbar dan tidak ada spinner pemuatan, sementara dokumen itu sendiri masih ditampilkan. Garis miring di depan memutusnya dengan cara yang sama sepertiBasePath.- Callback adalah opsi.
onViewerReady,onErrordan sisanya masuk ke objek yang diteruskan kedocViewer(...). Fungsi global yang dinamai sesuai penampil, sepertictlDoc_ViewerReady, tidak pernah dipanggil. - Pertahankan penampil, lalu panggil
Viewsecara terpisah.docViewer(...)mengembalikan objek denganZoom,Next, danFitType;View(...)mengembalikan sesuatu yang lain.var objViewer = $('#div_ctlDoc').docViewer({...}).View(token)menampilkan dokumen, lalu gagal denganobjViewer.Zoom is not a functionpada klik toolbar pertama.
Nama opsi mencampur camelCase (showThumbs, autoLoad, pageZoom) dan PascalCase (FitType, BasePath, ResPath). Opsi yang salah eja diabaikan, dan widget menggunakan nilai defaultnya.
Alternatif satu baris
Untuk halaman yang hanya perlu menampilkan dokumen, tanpa bilah alat milik Anda, Viewer.RenderViewer menulis seluruh skrip inisialisasi — docViewer(...) dengan BasePath: '/' dan ResPath: 'doconut-res/images', kemudian .View(token). Skrip ini hanya ada dalam paket ini:
// Default.aspx.cs
protected string ViewerInit;
protected void Page_Load(object sender, EventArgs e)
{
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
string token = viewer.OpenDocument(Server.MapPath("~/files/Sample.pdf"));
ViewerInit = viewer.RenderViewer("div_ctlDoc", token);
}<div id="div_ctlDoc" style="height: 100vh"></div>
<%= ViewerScripts %>
<%= ViewerInit %>Berikan ViewerConfig sebagai argumen ketiga untuk mengubah zoom, penyesuaian, atau panel thumbnail. Karena skrip yang dihasilkan tidak menyimpan referensi ke penampil, gunakan inisialisasi yang ditulis tangan di atas ketika halaman Anda memerlukan bilah alat sendiri.
Tutup dokumen
Panggil objViewer.Close(true) ketika pengguna meninggalkan penampil atau membuka pengganti: itu membersihkan widget dan mengirim permintaan tutup ke DocImage.axd. objViewer.Close() tanpa argumen hanya membersihkan widget. Di server, viewer.CloseDocument(token) menghapus sesi dokumen sekaligus, melepaskan sumber daya rendernya, dan mencabut akses sesi ke halaman-halamannya. Kedaluwarsa bergulir pada akhirnya melakukan hal yang sama, tetapi menutup dokumen besar secara eksplisit membebaskan memori lebih cepat.
Jalankan
Letakkan PDF di ~/files/Sample.pdf, jalankan situs di IIS Express (F5 di Visual Studio), dan buka halaman yang menampung widget. Halaman pertama dirender, dengan thumbnail di sebelah kiri. Jika tidak, lihat Pemecahan Masalah.
Apa yang Anda dapatkan tanpa lisensi
Kehilangan lisensi tidak menyebabkan error. Penampil merender secara normal, tetapi setiap halaman menampilkan watermark evaluasi. Lihat Pengaturan Lisensi untuk mengetahui di mana Doconut mencari lisensi Anda.
Apakah halaman ini membantu?