Переглядач

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

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

OpenDocumentAsync

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

// Просте відкриття
string token = await viewer.OpenDocumentAsync(path);

// З конфігурацією та параметрами для кожного формату
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// З завантаження
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 анотацій

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

Метадані DICOM

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

Повертає метадані тегів DICOM для сесій, відкритих через плагін DICOM; null для недICOM‑документів.

Помічники ресурсів — ReferenceCss / ReferenceScripts

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

string ReferenceCss(CssConfig? config = null)      // null → Bootstrap + переглядач + пошук + анотація
string ReferenceScripts(ScriptConfig? config = null)

CssConfig прапорці: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (search-gated), IncludeAnnotationCss (annotation-gated).

ScriptConfig прапорці: IncludeJQuery (required by all others), IncludeBootstrap, IncludeViewerScripts (core: docViewer.js + splitter + links), IncludeSearchScripts and IncludeSearchBar (search-gated), IncludeAnnotationScripts and 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)

Повертає назви листів відкритої електронної таблиці у порядку книги, або порожній список, якщо відкритий документ не є електронною таблицею.

Додано у 26.9.0.