ビューア

Viewer (namespace Doconut) は、Razor ページ、MVC コントローラー、Blazor コンポーネント、または最小限の API からドキュメントを開くための公開エントリーポイントです。これは sealed で、AddDoconut() によって transient サービスとして登録され、コンストラクタインジェクションで解決されます — 直接インスタンス化しないでください。

Viewer はリクエストごとの状態を保持せず、意図的に IDisposable を実装しません：ドキュメントセッションはセッションキャッシュ内で独立して存在するため、サービスを破棄しても開かれたドキュメントを解放することはできません（Core Concepts → ビューアの仕組み を参照）。

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

オープンごとに適用される、フォーマットに依存しないオプション（namespace Doconut）:

このクラスは、通常の単一ホスト閲覧フローの外に意図的に配置された、特化したプロパティも公開しています：

カスタム透かし

DocOptions.Watermark はチルダ6つで区切られたフィールドを使用します。オプションの先頭 ^ は全コーナーレイアウトを要求します:

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

パーサはオプションの ^ の後に正確に6つのフィールドがあることを期待します。無効な定義は、黙って消えるのではなく SDK の可視 Invalid Watermark フォールバックに置き換えられます。

ライセンス判定

同じ判定が配信されたページ画像とアノテーションエクスポートにも適用されます。アニメーション GIF 出力はフレームごとにスタンプが付けられます。したがってカスタム透かしは評価透かしを置き換えたり抑制したりする手段ではなく、ライセンスされたアプリケーション機能です。

アノテーション API

サーバー側のアノテーションの読み込みとエクスポート。完全な手順は Guides → Annotations にあります。概要は次のとおりです:

DICOM メタデータ

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

DICOM プラグインを通じて開かれたセッションの DICOM タグメタデータを返します。非 DICOM 文書の場合は null を使用します。

リソースヘルパー — ReferenceCss / ReferenceScripts

UseDoconutResources() が提供する埋め込みリソース用に <link>/<script> タグを正しい依存順序で出力します。検索やアノテーションなど、ライセンスで制御される機能のバンドルは ライセンスが有効な場合にのみ 出力され、クライアント 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 + スプリッタ + リンク）、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 }))

ワークシート名の取得

IReadOnlyList<string> GetWorksheetNames(string token)

開いているスプレッドシートのワークシート名をブック順に返し、開いているドキュメントがスプレッドシートでない場合は空のリストを返します。

26.9.0 に追加されました。