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 thông 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 nào và cố ý không triển khai 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 Trình xem).

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 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 lỗi.
• 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 lỗi 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 này cũng cung cấp các thuộc tính chuyên biệt được cố ý nằm ngoài luồng xem bình thường trên một máy chủ duy nhất:

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

DocOptions.Watermark sử dụng sáu trường được ngăn cách bằng dấu ~. Một ^ đầu tùy chọn yêu cầu bố cục tất cả các 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
    });

Trình 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 Invalid Watermark dự phòng có thể nhìn thấy của SDK thay vì biến mất một cách 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 động được dán dấu khung từng khung. Do đó, đánh dấu tùy chỉnh là tính năng ứng dụng có giấy phép, không phải cách để thay thế hoặc ẩn đánh dấu đá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)

Trả về siêu dữ liệu thẻ DICOM cho các phiên được mở qua plugin DICOM; null cho tài liệu không phải DICOM.

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 khách hàng nhất quán với hành vi 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 cờ: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (search-gated), IncludeAnnotationCss (annotation-gated).

ScriptConfig cờ: IncludeJQuery (required by all others), IncludeBootstrap, IncludeViewerScripts (core: docViewer.js + splitter + links), IncludeSearchScripts và IncludeSearchBar (search-gated), IncludeAnnotationScripts và IncludeAnnotationBar (annotation-gated).

@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.