Trình xem

Viewer (namespace Doconut) là điểm vào công cộng để mở tài liệu từ các trang Razor, bộ điều khiển MVC, thành phần Blazor, hoặc API tối thiểu. Nó được sealed, đăng ký như một dịch vụ transient bởi AddDoconut(), và được giải quyết qua tiêm vào constructor — không bao giờ tạo trực tiếp.

Viewer không giữ trạng thái per-request và cố ý không thực hiện IDisposable: các phiên tài liệu tồn tại độc lập trong bộ nhớ cache phiên, vì vậy việc giải phóng dịch vụ không bao giờ có thể hủy một tài liệu đang mở (xem Khái niệm Cốt lõi → Cách hoạt động của Viewer).

OpenDocumentAsync

Mở một tài liệu và trả về token phiên mà widget khách hàng sử dụng cho tất cả các yêu cầu tiếp theo.

// Mở đơn giản
string token = await viewer.OpenDocumentAsync(path);

// Với cấu hình và tùy chọn cho mỗi định dạng
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// Từ một lần tải lên
await using var ms = new MemoryStream();
await file.CopyToAsync(ms);
ms.Position = 0;
token = await viewer.OpenDocumentAsync(ms, new FileInfo(file.FileName));

Các ngoại lệ cần xử lý:

• LicenseException — một giấy phép được tìm thấy bị từ chối (tin nhắn chứa lý do từ chối), hoặc định dạng cần một khả năng plugin không còn được cấp. Hết hạn lịch mà không có tin nhắn từ chối sẽ chuyển sang render có watermark thay vì ném ngoại lệ.
• FormatNotSupportedException — Document format '<extension>' is not supported.
• InvalidDataException — nội dung tệp bị hỏng hoặc không khớp với phần mở rộng của nó.

CloseDocument

void CloseDocument(string token)

Xóa phiên khỏi bộ nhớ cache (giải phóng engine tài liệu ngay lập tức), xóa dấu bảo mật, và thu hồi quyền truy cập. Tùy chọn — thời gian hết hạn trượt thực hiện cùng một quá trình dọn dẹp — nhưng được khuyến nghị cho tài liệu lớn.

GetPageCount

int GetPageCount(string token)

Tổng số trang của phiên đang mở. Ném ngoại lệ nếu token không xác định hoặc đã hết hạn.

DocOptions

Các tùy chọn không phụ thuộc vào định dạng, áp dụng cho mỗi lần mở (namespace Doconut):

Lớp cũng cung cấp các thuộc tính chuyên biệt được cố ý nằm ngoài luồng xem đơn máy chủ bình thường:

Đánh dấu tùy chỉnh

DocOptions.Watermark sử dụng sáu trường ngăn cách bằng dấu ~. Một ^ tùy chọn ở đầu yêu cầu bố cục toàn góc:

^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
    });

Bộ phân tích cú pháp yêu cầu chính xác sáu trường sau ^ tùy chọn. Định nghĩa không hợp lệ sẽ được thay thế bằng giá trị dự phòng Invalid Watermark có thể nhìn thấy của SDK thay vì biến mất im lặng.

Quyết định giấy phép

Quyết định tương tự được áp dụng cho các hình ảnh trang được phục vụ và xuất chú thích. Đầu ra GIF hoạt hình được dán dấu từng khung. Do đó, đánh dấu tùy chỉnh là một tính năng ứng dụng có giấy phép, không phải cách để thay thế hoặc ẩn dấu nước đánh giá.

API Chú thích

Tải và xuất chú thích phía máy chủ. Hướng dẫn đầy đủ nằm trong Hướng dẫn → Chú thích; giao diện là:

siêu dữ liệu DICOM

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

Phương thức này tồn tại để đồng bộ API, nhưng trình xem DICOM .NET 6 không thể cung cấp các thẻ kỹ thuật. Nó trả về null cho các phiên DICOM và không DICOM; trên một phiên DICOM nó cũng ghi một cảnh báo một lần giải thích giới hạn nền tảng. Việc kết xuất trang, khung và hoạt hình vẫn được hỗ trợ.

Trợ giúp tài nguyên — ReferenceCss / ReferenceScripts

Phát ra các thẻ <link>/<script> cho các tài nguyên nhúng được phục vụ bởi UseDoconutResources(), theo đúng thứ tự phụ thuộc. Các gói cho các tính năng có giấy phép như tìm kiếm và chú thích chỉ được phát ra khi giấy phép cho phép, giữ giao diện người dùng phía khách nhất quán với hành vi của máy chủ.

string ReferenceCss(CssConfig? config = null)      // null → Bootstrap + trình xem + tìm kiếm + chú thích
string ReferenceScripts(ScriptConfig? config = null)

CssConfig flags: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (được kiểm soát bởi tìm kiếm), IncludeAnnotationCss (được kiểm soát bởi chú thích).

ScriptConfig flags: IncludeJQuery (được yêu cầu bởi tất cả các flag khác), IncludeBootstrap, IncludeViewerScripts (cốt lõi: docViewer.js + bộ chia + liên kết), IncludeSearchScripts và IncludeSearchBar (được kiểm soát bởi tìm kiếm), IncludeAnnotationScripts và IncludeAnnotationBar (được kiểm soát bởi chú thích).

@inject Doconut.Viewer Viewer

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

GetWorksheetNames

IReadOnlyList<string> GetWorksheetNames(string token)

Trả về tên các worksheet của một bảng tính đang mở, theo thứ tự workbook, hoặc một danh sách rỗng khi tài liệu mở không phải là bảng tính.

Được thêm trong 26.9.0.