เริ่มต้นอย่างรวดเร็ว

แสดงเอกสารแรกของคุณใน MVC 5 หรือ Web Forms

บทแนะนำนี้นำแอปพลิเคชัน ASP.NET บน .NET Framework 4.7.2 จากแพ็กเกจที่ติดตั้งไปสู่เอกสารที่แสดงในเบราว์เซอร์: Global.asax, จุดเปิด, สินทรัพย์ของตัวดู, วิดเจ็ต, และโทเคนที่เชื่อมต่อพวกมันเข้าด้วยกัน. มันสมมติว่าการลงทะเบียน Web.config จาก การติดตั้ง อยู่ในที่ที่ถูกต้อง — หากไม่มีตัวจัดการ DocImage.axd และโมดูลทรัพยากร, สิ่งต่อไปนี้จะไม่สามารถเข้าถึงเซิร์ฟเวอร์ได้.

สร้าง Doconut ใน Global.asax

Application_Start ที่สมบูรณ์สำหรับแอปพลิเคชัน MVC 5:

csharp
// Global.asax.cs - สร้างครั้งเดียวต่อกระบวนการทำงาน, ปล่อยเมื่อปิดระบบ.
protected void Application_Start()
{
    Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);

    Doconut.DoconutHost.Initialize(options =>
    {
        options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
        options.UnsafeMode  = false; // หน้าเพจจะให้บริการเฉพาะกับเซสชันที่เปิดเอกสาร
    });

    // MVC only: เก็บ endpoints สองตัวของ Doconut ไอยู่นอกการกำหนดเส้นทาง.
    RouteTable.Routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
    RouteTable.Routes.IgnoreRoute("doconut-res/{*pathInfo}");
}

protected void Application_End()
{
    Doconut.DoconutHost.Shutdown();
}
  • Encoding.RegisterProvider ทำให้หน้าโค้ดแบบเก่าที่บางรูปแบบเอกสารใช้สามารถเข้าถึงได้สำหรับกระบวนการ. เรียกใช้ครั้งเดียว, ก่อนที่เอกสารแรกจะเปิด.
  • UnsafeMode = false เป็นค่าเริ่มต้น, เขียนออกมาเพื่อให้ไม่มีใครสลับโดยบังเอิญ: DocImage.axd ให้บริการหน้าเฉพาะกับเซสชัน ASP.NET ที่เปิดเอกสาร.
  • การเรียก IgnoreRoute สองครั้ง ทำให้การกำหนดเส้นทาง MVC ห่างจาก DocImage.axd และ /doconut-res/*, ซึ่งตัวจัดการและโมดูลให้บริการ. แอปพลิเคชัน Web Forms ไม่มีเส้นทาง MVC และไม่ต้องการบรรทัดนี้.
  • DoconutHost.Shutdown หยุดการทำงานเบื้องหลังของ Doconut และปล่อยบริการของมันเมื่อพูลแอปพลิเคชันรีไซเคิล. สามารถเรียกใช้ได้อย่างปลอดภัยแม้ว่า Initialize จะไม่เคยทำงาน.

เปิดเอกสาร

การเปิดเอกสารจะคืนค่าโทเคนที่ไม่เปิดเผย. วิดเจ็ตส่งโทเคนนั้นพร้อมกับทุกคำขอหน้า.

ใน MVC 5, การกระทำของคอนโทรลเลอร์จะดึงบริการ Viewer จาก DoconutHost.Services — MVC 5 ไม่มีการฉีดคอนสตรัคเตอร์สำหรับมัน:

csharp
// POST /Document/Open
[HttpPost]
public async Task<ActionResult> Open()
{
    var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();

    // โทเคนเป็นแบบไม่เปิดเผย - ส่งต่อให้ viewer, อย่า log หรือ persist มัน.
    string token = await viewer.OpenDocumentAsync(Server.MapPath("~/files/Sample.pdf"));
    return Json(new { token });
}

เอกสารต้องถูกเปิด ภายในคำขอที่มีสถานะเซสชัน, เนื่องจากการเปิดเป็นสิ่งที่ให้เซสชัน ASP.NET ปัจจุบันเข้าถึงหน้าของมัน. คอนโทรลเลอร์ MVC และหน้า Web Forms มีสถานะเซสชันโดยค่าเริ่มต้น. IHttpHandler ที่กำหนดเองไม่มี, เว้นแต่จะทำการ implement System.Web.SessionState.IRequiresSessionState. เปิดเอกสารจากตัวจัดการโดยไม่มีมัน, ตัวดูจะแสดงข้อความ "คุณไม่ได้รับอนุญาตให้ดูหน้านี้." ในทุกหน้า.

ใน Web Forms, หน้าเองสามารถเปิดเอกสารใน code-behind ของมัน. OpenDocument เป็นรูปแบบ synchronous ของ OpenDocumentAsync, มีจุดประสงค์สำหรับ code-behind ที่ไม่ใช้หน้าแบบ asynchronous:

csharp
// 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"));
}

ปฏิบัติโทเคนเหมือนข้อมูลรับรองแบบ bearer: อย่าบันทึกหรือเก็บรักษามัน; ส่งให้กับวิดเจ็ตเท่านั้น. มันจะหยุดทำงานเมื่อเซสชันเอกสารหมดอายุ — เปิดเอกสารอีกครั้งเพื่อรับโทเคนใหม่.

อ้างอิงทรัพยากรของตัวดู

Viewer.ReferenceCss และ Viewer.ReferenceScripts ส่งออกแท็ก <link> และ <script> สำหรับทรัพยากรที่ฝังอยู่, ตามลำดับการพึ่งพา, ชี้ไปที่ /doconut-res/. วิดเจ็ตเป็นปลั๊กอิน jQuery, ดังนั้น jQuery จะมาก่อน.

MVC 5. วิวไม่มี @inject, ดังนั้นให้สร้างแท็กในคอนโทรลเลอร์และส่งต่อไปยัง ViewBag:

csharp
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
@Html.Raw(ViewBag.ViewerCss)
...
@Html.Raw(ViewBag.ViewerScripts)

เก็บการทำงานนั้นไว้ในคอนโทรลเลอร์. MVC 5 คอมไพล์วิวเมื่อมันถูกให้บริการครั้งแรก, และหากไม่มีแพ็กเกจคอมไพเลอร์เพิ่มเติม คอมไพเลอร์นั้นจะเข้าใจเฉพาะ C# 5 — ไม่มี ?., ไม่มี $"...", ไม่มี nameof. วิวที่ใช้พวกมันจะคอมไพล์อย่างสะอาดใน Visual Studio, จากนั้นตอบกลับด้วย 500 ว่างเปล่าในเบราว์เซอร์.

Web Forms. เปิดเผยสตริงเดียวกันจาก code-behind และเขียนด้วย <%= %>:

html
<head>
    <%= ViewerCss %>
</head>
<body>
    ...
    <%= ViewerScripts %>
</body>

IncludeViewerCss และ IncludeViewerScripts เป็นแกนหลักที่จำเป็น. เพื่อเพิ่มริบบิ้นการค้นหาและการอธิบาย, ยังต้องตั้งค่า IncludeSearchCss, IncludeAnnotationCss, IncludeSearchScripts, IncludeSearchBar, IncludeAnnotationScripts และ IncludeAnnotationBar. ทั้งสองวิธีจะละไฟล์ของริบบิ้นเมื่อใบอนุญาตไม่ให้ความสามารถนั้น; ตัวดูเองยังคงเริ่มทำงาน.

เพิ่มตัวดูลงในหน้า

พื้นผิวการเรนเดอร์คือ div สองชั้นซ้อนกัน:

html
<div id="divDocViewer">
    <div id="div_ctlDoc"></div>
</div>

กำหนดความสูงจริงให้กับ div ด้านนอก — ตัวดูจะเติมเต็มคอนเทนเนอร์และวัดขนาดเมื่อเริ่มทำงาน. ตัวดูไม่ได้วาดแถบเครื่องมือของตัวเอง: GotoPage, Next, Zoom, FitType และส่วนที่เหลือเป็นเมธอดที่หน้าของคุณเชื่อมต่อกับปุ่มของคุณเอง, วางข้างตัวดู:

html
<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>

เริ่มต้นตัวดูและแสดงเอกสาร

หลังจากสคริปต์ของตัวดู, สร้างวิดเจ็ต, แล้วส่งโทเค็นให้มัน:

javascript
var objViewer = $('#div_ctlDoc').docViewer({
    showThumbs: true,
    autoLoad:   false,
    pageZoom:   100,
    FitType:    'width',
    BasePath:   '/',                   // '/' หมายถึง DocImage.axd ที่รากของไซต์
    ResPath:    'doconut-res/images',  // ไม่มี '/' นำหน้า
    onViewerReady: function () {
        // หน้าแสดงผลแล้ว; ซ่อนตัวบ่งชี้การโหลดที่นี่
    },
    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); });

ใน Web Forms, ที่หน้ามีการเปิดเอกสารเอง, บรรทัดสุดท้ายสามบรรทัดจะกลายเป็น objViewer.View('<%= Token %>');.

สี่รายละเอียดต่อไปนี้ล้มเหลวโดยไม่มีข้อความแสดงข้อผิดพลาด:

  • BasePath: '/' ระบุ DocImage.axd ที่รากของไซต์. สำหรับแอปพลิเคชันในไดเรกทอรีเสมือน, ใช้ชื่อของมันโดยไม่มีสแลช ('myapp' ขอ /myapp/DocImage.axd). สแลชนำหน้า ('/myapp') ทำให้เกิด //myapp/DocImage.axd, ซึ่งเบราว์เซอร์อ่านเป็นการร้องขอไปยังโฮสต์อื่น.
  • ResPath: 'doconut-res/images' — ไอคอนอยู่หนึ่งโฟลเดอร์ใต้รากของทรัพยากร. ด้วย 'doconut-res', ไอคอนทุกตัวจะคืนค่า 404: ไม่มีไอคอนแถบเครื่องมือและไม่มีสปินเนอร์การโหลด, ในขณะที่เอกสารเองยังแสดงผล. สแลชนำหน้าจะทำให้มันพังเช่นเดียวกับ BasePath.
  • Callbacks เป็นตัวเลือก. onViewerReady, onError และส่วนที่เหลืออยู่ในอ็อบเจ็กต์ที่ส่งให้กับ docViewer(...). ฟังก์ชันระดับโลกที่ตั้งชื่อตามตัวดู, เช่น ctlDoc_ViewerReady, จะไม่ถูกเรียกใช้.
  • Keep the viewer, then call View separately. docViewer(...) คืนค่าอ็อบเจ็กต์ที่มี Zoom, Next และ FitType; View(...) คืนค่าอย่างอื่น. var objViewer = $('#div_ctlDoc').docViewer({...}).View(token) เรนเดอร์เอกสาร, แล้วล้มเหลวด้วย objViewer.Zoom is not a function เมื่อคลิกแถบเครื่องมือครั้งแรก.

ชื่ออ็อปชันผสม camelCase (showThumbs, autoLoad, pageZoom) และ PascalCase (FitType, BasePath, ResPath). อ็อปชันที่สะกดผิดจะถูกละเลย, และวิดเจ็ตจะใช้ค่าเริ่มต้นของมัน.

ทางเลือกแบบบรรทัดเดียว

สำหรับหน้าที่ต้องการแสดงเอกสารเท่านั้น โดยไม่มีแถบเครื่องมือของคุณเอง, Viewer.RenderViewer จะเขียนสคริปต์การเริ่มต้นทั้งหมด — docViewer(...) พร้อมกับ BasePath: '/' และ ResPath: 'doconut-res/images', แล้วตามด้วย .View(token). มันมีอยู่เฉพาะในแพ็กเกจนี้:

csharp
// 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);
}
html
<div id="div_ctlDoc" style="height: 100vh"></div>
<%= ViewerScripts %>
<%= ViewerInit %>

ส่งค่า ViewerConfig เป็นอาร์กิวเมนต์ที่สามเพื่อเปลี่ยนการซูม, การปรับให้พอดี, หรือแผงรูปย่อ. เนื่องจากสคริปต์ที่สร้างขึ้นไม่มีการอ้างอิงถึงตัวดู, ให้ใช้การเริ่มต้นที่เขียนด้วยมือข้างต้นเมื่อหน้าของคุณต้องการแถบเครื่องมือของตนเอง.

ปิดเอกสาร

เรียก objViewer.Close(true) เมื่อผู้ใช้ออกจากตัวดูหรือเปิดเอกสารแทน: มันจะล้างวิดเจ็ตและส่งคำขอปิดไปยัง DocImage.axd. objViewer.Close() โดยไม่มีอาร์กิวเมนต์จะล้างเฉพาะวิดเจ็ต. บนเซิร์ฟเวอร์, viewer.CloseDocument(token) จะลบเซสชันเอกสารทันที, ปล่อยทรัพยากรการเรนเดอร์, และถอนการเข้าถึงหน้าของเซสชัน. การหมดอายุแบบเลื่อนจะทำเช่นเดียวกันในที่สุด, แต่การปิดเอกสารขนาดใหญ่โดยเจตนาจะปลดปล่อยหน่วยความจำเร็วขึ้น.

เรียกใช้

วางไฟล์ PDF ที่ ~/files/Sample.pdf, เริ่มเว็บไซต์ใน IIS Express (F5 ใน Visual Studio), และเปิดหน้าที่โฮสต์วิดเจ็ต. หน้าแรกจะเรนเดอร์พร้อมรูปย่อทางด้านซ้าย. หากไม่เป็นเช่นนั้น, ดูที่ การแก้ไขปัญหา.

สิ่งที่คุณได้รับโดยไม่มีใบอนุญาต

การไม่มีใบอนุญาตจะไม่ทำให้เกิดข้อผิดพลาด. ตัวดูจะเรนเดอร์ตามปกติ, แต่ทุกหน้าจะมีลายน้ำการประเมิน. ดูที่ การตั้งค่าใบอนุญาต เพื่อดูว่าที่ไหน Doconut มองหาใบอนุญาตของคุณ.

หน้านี้เป็นประโยชน์หรือไม่?