Переглядач

Viewer (простір імен Doconut) є публічною точкою входу для відкриття документів з Razor‑сторінок, MVC‑контролерів, Blazor‑компонентів або мінімальних API. Він sealed, зареєстрований як transient сервіс за допомогою AddDoconut(), і отримується через ін’єкцію конструктора — ніколи не створюйте його безпосередньо.

Viewer не зберігає стану на запит і навмисно не реалізує IDisposable: сеанси документів живуть незалежно в кеші сеансів, тому знищення сервісу не може закрити відкритий документ (див. Основні концепції → Як працює переглядач).

OpenDocumentAsync

Відкриває документ і повертає токен сеансу, який клієнтський віджет використовує для всіх подальших запитів.

// Simple open
string token = await viewer.OpenDocumentAsync(path);

// With per-format config and options
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// From an upload
await using var ms = new MemoryStream();
await file.CopyToAsync(ms);
ms.Position = 0;
token = await viewer.OpenDocumentAsync(ms, new FileInfo(file.FileName));

Виключення, які потрібно обробляти:

• LicenseException — знайдена ліцензія відхилена (повідомлення містить причину відхилення) або формат потребує плагін‑можливості, яка більше не надається. Закінчення терміну дії календаря без повідомлення про відхилення призводить до рендерингу з водяним знаком замість викидання виключення.
• FormatNotSupportedException — Document format '<extension>' is not supported.
• InvalidDataException — вміст файлу пошкоджений або не відповідає його розширенню.

CloseDocument

void CloseDocument(string token)

Видаляє сеанс з кешу (негайно знищуючи движок документа), видаляє маркер безпеки та відкликає наданий доступ. Необов’язково — скользяче закінчення терміну дії виконує те ж очищення — але рекомендовано для великих документів.

GetPageCount

int GetPageCount(string token)

Загальна кількість сторінок відкритого сеансу. Викидає виключення, якщо токен невідомий або прострочений.

DocOptions

Параметри, незалежні від формату, для кожного відкриття (простір імен Doconut):

Клас також надає спеціалізовані властивості, які навмисно виходять за межі звичайного однохостового процесу перегляду:

Користувацький водяний знак

DocOptions.Watermark використовує шість полів, розділених тильдами. Необов’язковий початковий ^ запитує розташування по всім кутам:

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

Парсер очікує точно шість полів після необов’язкового ^. Неправильне визначення замінюється видимим запасним варіантом SDK Invalid Watermark замість того, щоб безшумно зникнути.

Рішення щодо ліцензії

Те саме рішення застосовується до зображень сторінок та експорту анотацій. Анімований GIF виводиться з водяним знаком кадр за кадром. Користувацький водяний знак є функцією, що вимагає ліцензії, а не способом замінити або придушити водяний знак оцінки.

API анотацій

Завантаження та експорт анотацій на боці сервера. Повний посібник знаходиться у Посібниках → Анотації; інтерфейс виглядає так:

Метадані DICOM

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

Метод присутній для узгодженості API, проте DICOM‑переглядач .NET 6 не може надати технічні теги. Він повертає null для DICOM та не‑DICOM сеансів; у DICOM‑сеансі також виводиться одноразове попередження про обмеження платформи. Рендеринг сторінок, кадрів та анімації залишається підтримуваним.

Допоміжні ресурси — ReferenceCss / ReferenceScripts

Генерує теги <link>/<script> для вбудованих ресурсів, що надаються UseDoconutResources(), у правильному порядку залежностей. Пакети для функцій, що залежать від ліцензії, таких як пошук та анотації, генеруються лише коли ліцензія їх дозволяє, забезпечуючи узгодженість UI клієнта з поведінкою сервера.

string ReferenceCss(CssConfig? config = null)      // null → Bootstrap + viewer + search + annotation
string ReferenceScripts(ScriptConfig? config = null)

Прапорці CssConfig: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (залежить від пошуку), IncludeAnnotationCss (залежить від анотації).

Прапорці ScriptConfig: IncludeJQuery (вимагається усіма іншими), IncludeBootstrap, IncludeViewerScripts (ядро: docViewer.js + splitter + links), IncludeSearchScripts та IncludeSearchBar (залежить від пошуку), IncludeAnnotationScripts та IncludeAnnotationBar (залежить від анотації).

@inject Doconut.Viewer Viewer

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