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

แสดงเอกสารแรกของคุณในไม่กี่นาที

บทแนะนำนี้นำแอป ASP.NET Core จาก Program.cs ว่างเปล่าไปสู่เอกสารที่แสดงในเบราว์เซอร์: การลงทะเบียนเซิร์ฟเวอร์, แพ็คเกจ Viewer ครบชุด (แถบเครื่องมือ Viewer, การเมานท์ Viewer, และริบบิ้น Search/Annotation ทางเลือก), การอ้างอิงทรัพยากร, การเริ่มต้นไคลเอนต์, การเปิดเอกสาร, และการดำเนินการ.

แอปโฮสต์ต้องกำหนดเป้าหมายไปยัง runtime ที่รองรับ netstandard2.1 — .NET Core 3.0 หรือใหม่กว่า.

การตั้งค่าเซิร์ฟเวอร์

AddDoconut() ลงทะเบียนบริการ; UseDoconutResources() และ UseDoconut() เชื่อมต่อ middleware. การเรียกใช้ resources ต้องมาก่อน. UseDoconut() ตอบทุกคำขอที่ถึงมัน, ดังนั้นเมานท์มันบนสาขาแยกของมันด้วย app.Map. การเรียกใช้ session ก็จำเป็นเช่นกัน — ระบบความปลอดภัยเอกสารเริ่มต้นของ Doconut ตรวจสอบทุกคำขอหน้าเทียบกับสถานะ session ของ ASP.NET. สถานะ session ต้องการแคช: AddDistributedMemoryCache() ให้หนึ่งตัว. แอป MVC หรือ Razor Pages จะลงทะเบียนไว้แล้ว, แต่แอป minimal-API ไม่ได้, และหากไม่มีมัน แอปจะหยุดทำงานที่การเริ่มต้นด้วย Unable to resolve service for type 'IDistributedCache'. ได้ลงทะเบียน Doconut ไว้แล้วระหว่าง Installation? ข้ามไปยังส่วนต่อไป.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // สถานะเซสชันต้องการแคช (MVC/Razor Pages already add one)
builder.Services.AddSession(); // ความปลอดภัยของเอกสาร Doconut พึ่งพา ASP.NET session state

app.UseSession();          // เรียก UseSession() ก่อน UseDoconut()
app.UseDoconutResources(); // ต้องลงทะเบียนก่อน UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

การตั้งค่านี้รักษารูปแบบคำขอ DocImage.axd แบบดั้งเดิมและเมานท์ middleware ของเอกสารบนสาขาที่ตรงกัน. นี่คือการจัดเรียงที่ควรคัดลอกเมื่อคุณกำลังพัฒนาแอปพลิเคชัน .NET Standard ที่มีอยู่ต่อไป, เนื่องจากไคลเอนต์ยังคงเรียก URL เดียวกันเช่นเคย:

csharp
builder.Services.AddDoconut(options =>
{
    options.UnsafeMode      = false;   // เปิดใช้งานการตรวจสอบเซสชันของ Doconut ไว้
    options.ShowDoconutInfo = false;
});
builder.Services.AddDistributedMemoryCache(); // สถานะเซสชันต้องการแคช (MVC/Razor Pages already add one)
builder.Services.AddSession(options =>
{
    options.IdleTimeout        = TimeSpan.FromSeconds(3600);
    options.Cookie.HttpOnly    = true;
    options.Cookie.IsEssential = true;
});

// จำเป็นสำหรับการเข้ารหัสแบบหลายไบต์ในรูปแบบเอกสารบางประเภท.
Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);

app.UseStaticFiles();
app.UseRouting();
app.UseSession();
app.UseDoconutResources();   // BEFORE สาขาเอกสาร
app.MapWhen(
    context => context.Request.Path.Value?.EndsWith("DocImage.axd", StringComparison.OrdinalIgnoreCase) == true,
    branch => branch.UseDoconut());

UseDoconut() ไม่รับตัวเลือกใดในรุ่นนี้ — ทุกอย่างถูกย้ายไปที่ AddDoconut(). MiddlewarePath เป็นค่าการประสานงาน; มันไม่ได้แมปสาขา ASP.NET Core ด้วยตนเอง. กับสาขา DocImage.axd ด้านบน, ไคลเอนต์ใช้ BasePath: '/'; กับ app.Map("/doconut", ...) จากการตั้งค่าขั้นต่ำ, มันใช้ BasePath: 'doconut'. ResourcesPath ให้บริการบันเดิลที่ฝังอยู่ที่ /doconut-res, และเส้นทางทรัพยากรรูปภาพของวิดเจ็ตจึงเป็น ResPath: 'doconut-res/images'.

เพิ่ม Viewer ลงในหน้า

Viewer เป็นแกนหลักที่จำเป็นของหน้า. พื้นผิวการเรนเดอร์ของมันใช้ div สองชั้นซ้อนกัน:

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

พิจารณาแถบเครื่องมือ, การเมานท์โมดูล, และพื้นผิว Viewer เป็นการประกอบหน้าเดียว. Search และ Annotation ฝังริบบิ้นที่ฝังอยู่ของพวกเขาเข้าสู่การเมานท์ทางเลือก, แต่โมดูลเหล่านั้นไม่มีอยู่แยกเดี่ยว: พวกมันจะผูกติดกับ Viewer บนหน้าเดียวกันเสมอ.

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- ปุ่มการนำทาง, การซูม, การค้นหา, และการทำหมายเหตุของ Viewer -->
</nav>

<div id="searchBarMount"></div>
<div id="annBarMount"></div>

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

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

ใน Razor view, บริการ Viewer ที่ฉีดเข้ามาจะสร้างแท็ก <link> และ <script> ของตัวดูตามลำดับการพึ่งพา — วิดเจ็ตเป็นปลั๊กอิน jQuery ดังนั้น jQuery ต้องถูกโหลดก่อนสคริปต์ของตัวดู:

html
@inject Doconut.Viewer Viewer

@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
    IncludeBootstrapCss = true,
    IncludeViewerCss    = true
}))

@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
    IncludeJQuery        = true,
    IncludeBootstrap     = true,
    IncludeViewerScripts = true
}))

สำหรับแพ็กเกจ Viewer ครบชุด, ให้ร้องขอทรัพยากร Viewer และโมดูลพร้อมกัน:

html
@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
    IncludeBootstrapCss  = true,
    IncludeViewerCss     = true,
    IncludeSearchCss     = true,
    IncludeAnnotationCss = true
}))

@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
    IncludeJQuery            = true,
    IncludeBootstrap         = true,
    IncludeViewerScripts     = true,
    IncludeSearchScripts     = true,
    IncludeSearchBar         = true,
    IncludeAnnotationScripts = true,
    IncludeAnnotationBar     = true
}))

IncludeViewerCss และ IncludeViewerScripts เป็นแฟล็กหลักที่จำเป็น. อย่าเผยแพร่
ตัวอย่าง Search หรือ Annotation Ribbon โดยไม่มีพวกมัน, การ mount ของ Viewer, และอินสแตนซ์ docViewer
อินสแตนซ์. ReferenceCss และ ReferenceScripts จะละเว้นทรัพยากรของโมดูลเสริมเมื่อ
ใบอนุญาตปัจจุบันไม่ได้ให้ความสามารถนั้น; Viewer หลักยังคงเริ่มทำงาน.

การเรียกเหล่านี้แทนที่ไฟล์สคริปต์ที่คัดลอกด้วยมือ. หากแอปพลิเคชันยังโหลด
docViewer.js, documentLinks.js, หรือ docViewer.UI.js, ให้ลบแท็กเหล่านั้นเมื่อหน้า
ทำงานจากทรัพยากรที่ถูกสร้าง — ดู คู่มือการย้ายข้อมูล.

เริ่มต้นตัวดู

วิดเจ็ตฝั่งไคลเอนต์เป็นปลั๊กอิน jQuery. นี่คือชุดตัวเลือกการเริ่มต้นที่แท้จริงแบบขั้นต่ำ (ไม่ใช่โค้ดจำลอง):

javascript
let searchBar = null;
let annBar = null;

const objViewer = $('#div_ctlDoc').docViewer({
    showThumbs: true,
    autoLoad:   false,
    pageZoom:   100,
    FitType:    'width',
    BasePath:   '/',                   // สาขา DocImage.axd; 'doconut' กับ app.Map("/doconut", ...)
    ResPath:    'doconut-res/images',
    onViewerReady: function () {
        // หน้าแสดงผลแล้ว; ปลอดภัยที่จะซ่อนสปินเนอร์การโหลดที่นี่
    },
    // ส่งต่อเหตุการณ์วงจรชีวิตของการอธิบายไปยังริบบิ้นที่ฝังอยู่เมื่อมีอยู่
    onAnnLoaded:    () => annBar?.handleAnnLoaded(),
    onAnnSaved:     () => annBar?.handleAnnSaved(),
    onAnnSaveError: () => annBar?.handleAnnSaveError(),
    onAnnClosed:    () => annBar?.handleAnnClosed(),
    onError: function (message) {
        console.error('Doconut viewer error:', message);
    }
});

สี่รายละเอียดกำหนดว่าหน้านี้จะทำงานหรือไม่:

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

ทั้งหมดนี้ล้มเหลวโดยไม่มีการแจ้ง — ดู การแก้ไขปัญหา และ
คู่มือการย้ายข้อมูล.

การใช้ตัวพิมพ์ใหญ่/เล็กของตัวเลือกผสมกันจริง ๆ — showThumbs, autoLoad, และ pageZoom เป็น camelCase, แต่ FitType, BasePath, และ ResPath เป็น PascalCase. ไม่มีกฎที่สม่ำเสมอ; หากใส่ตัวพิมพ์ผิด ตัวเลือกจะถูกละเว้นโดยไม่มีการแจ้ง (วิดเจ็ตจะกลับไปใช้ค่าเริ่มต้นแทนการโยนข้อผิดพลาด).

ประกอบแพ็กเกจ Viewer ที่สมบูรณ์

หน้าผู้ชมที่สมบูรณ์จะติดตั้งส่วนต่าง ๆ ต่อไปนี้พร้อมกัน:

ส่วนของแพ็กเกจความต้องการวิธีการเชื่อมต่อ
ทรัพยากร Viewer, mount, และ objViewerจำเป็นตัวเรนเดอร์เอกสารหลัก
แถบเครื่องมือ Viewerจำเป็นสำหรับหน้าที่สมบูรณ์Markup ของโฮสต์; ปุ่มเรียกใช้ objViewer เดียวกัน
ริบบอนค้นหาตัวเลือก, โมดูลที่มีลิขสิทธิ์doconutSearchBar(...).attach(objViewer)
ริบบอนคำอธิบายตัวเลือก, โมดูลที่มีลิขสิทธิ์doconutAnnotationBar(...).attach(objViewer)

แม้ว่าแถบเครื่องมือ Viewer หลักจะเป็น markup ของโฮสต์ แต่จะถูกติดตั้งควบคู่กับ Viewer และไม่ควรบันทึกเป็นคอนโทรลแยกต่างหาก สิ่งนี้ทำให้การจัดวาง, ป้ายกำกับ, ไอคอน, และกฎการอนุญาตอยู่ภายใต้การควบคุมของแอปพลิเคชันของคุณในขณะที่ทุกปุ่มขับเคลื่อนอินสแตนซ์ Viewer เดียวกัน:

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.GotoPage(objViewer.TotalPages())">Last</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>
    <button type="button" onclick="objViewer.FitType('height')">Fit height</button>
    <button type="button" id="openSearch">Search</button>
    <button type="button" id="openAnnotations">Annotations</button>
</nav>

รักษาลำดับการเริ่มต้นนี้:

  1. สร้าง CSS สำหรับ Viewer และโมดูลที่มีลิขสิทธิ์.
  2. เรนเดอร์แถบเครื่องมือ Viewer, การเมานท์ Search/Annotation, และการเมานท์ Viewer พร้อมกัน.
  3. สร้างสคริปต์สำหรับ Viewer และโมดูลที่มีลิขสิทธิ์.
  4. โหลดสคริปต์ช่วยเหลือแถบเครื่องมือของแอปพลิเคชันโฮสต์เอง.
  5. เริ่มต้น docViewer และเก็บ objViewer ที่ได้.
  6. เริ่มต้นริบบอน Search หรือ Annotation แต่ละตัวที่มีลิขสิทธิ์.
  7. เรียก attach(objViewer) บนทุกริบบอน.
  8. เปิดเอกสารและเก็บโทเคนของมันสำหรับการร้องขอของ Viewer และโมดูล.

การป้องกันด้านเซิร์ฟเวอร์เป็นสิ่งสำคัญ: เมื่อความสามารถตัวเลือกไม่พร้อมใช้งาน สคริปต์ของมันจะไม่ถูกสร้าง ดังนั้นฟังก์ชันปลั๊กอิน jQuery ของมันจะไม่มีอยู่.

html
<script>
    let token = '';

    const refitViewer = () =>
        requestAnimationFrame(() => objViewer.Refit());

    @if (Viewer.IsSearchEnabled)
    {
        <text>
    searchBar = $('#searchBarMount').doconutSearchBar({
        docId: 'ctlDoc',
        getRequestParams: () => ({ token }),
        onLayout: refitViewer
    });
    searchBar.attach(objViewer);
        </text>
    }

    @if (Viewer.IsAnnotationEnabled)
    {
        <text>
    annBar = $('#annBarMount').doconutAnnotationBar({
        docId: 'ctlDoc',
        getRequestParams: () => ({ token }),
        onLayout: refitViewer
    });
    annBar.attach(objViewer);
        </text>
    }

    document.getElementById('openSearch').addEventListener('click', () => {
        if (!searchBar) return;
        searchBar.isOpen() ? searchBar.close() : searchBar.open();
    });

    document.getElementById('openAnnotations').addEventListener('click', () => {
        if (!annBar) return;
        annBar.isOpen() ? annBar.close() : annBar.open();
    });
</script>

ทั้งสองคอมโพเนนต์ที่ฝังอยู่สร้าง DOM ของริบบอนของตนเอง Search มีกลุ่ม Find, Options, และ Results. Annotation มีเครื่องมือการเขียน, ควบคุมสไตล์, การบันทึก, และการกระทำการส่งออก/รูปภาพแบบตัวเลือก. แถบเหล่านี้เปิดเผย open(), close(), reset(), และ isOpen(); เรียก attach(objViewer) หนึ่งครั้งหลังจากสร้างเสร็จ.

ตัวอย่างข้างต้นละเว้นการเรียกกลับของโฮสต์แบบตัวเลือกและจุดสิ้นสุดการส่งออก/รูปภาพของ Annotation เพื่อให้การเริ่มต้นเป็นขั้นต่ำ ดูที่ การค้นหา และ คำอธิบาย สำหรับการตั้งค่าที่เจาะจงคุณลักษณะทั้งหมด, หรือ ธีมที่กำหนดเอง เพื่อจัดรูปแบบหรือแทนที่แถบเครื่องมือ Viewer ที่เป็นของโฮสต์.

เปิดเอกสาร

ฝั่งเซิร์ฟเวอร์มีจุดเชื่อมต่อเดียว: บริการ Viewer ที่ฉีดเข้ามาเปิดเอกสารและส่งคืนโทเค็นเซสชัน การเปิดทำงานแบบอะซิงโครนัสในรุ่นนี้

csharp
app.MapPost("/api/open", async (Viewer viewer) =>
{
    // โทเคนเป็นแบบไม่เปิดเผย — ส่งให้วิดเจ็ต, อย่า log หรือ persist มัน.
    string token = await viewer.OpenDocumentAsync("wwwroot/files/Sample.pdf");
    return Results.Ok(new { token });
});

ไคลเอนต์ดึงโทเค็นนั้นและส่งให้วิดเจ็ตด้วย objViewer.View(token):

javascript
fetch('/api/open', { method: 'POST' })
    .then(resp => resp.json())
    .then(data => {
        token = data.token;
        objViewer.View(token);
    });

ไม่มีสิ่งใดต้องเตรียมก่อนการเปิดครั้งแรก หากคุณกำลังพัฒนาแอปพลิเคชันต่อไป ให้ลบการเรียก InitCache() ใด ๆ และแฟล็กที่ป้องกันมันออก — วิธีการนี้ไม่มีอยู่แล้ว

ปิดเอกสาร

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

ขั้นตอนการร้องขอที่สมบูรณ์คือ:

text
AddDoconut + middleware
    -> render CSS/scripts and mount div
    -> initialize docViewer
    -> OpenDocumentAsync
    -> return opaque token
    -> objViewer.View(token)
    -> page/search/annotation requests
    -> Close / CloseDocument

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

รันมัน

วางไฟล์ PDF ที่ wwwroot/files/Sample.pdf, รัน dotnet run, แล้วเปิดหน้าที่โฮสต์วิดเจ็ต หน้าแรกจะเรนเดอร์ในตัวดูพร้อมแผงรูปย่อทางซ้าย หากไม่แสดง, ดูที่ Troubleshooting.

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

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

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