ビューア

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

Viewer はリクエストごとの状態を保持せず、意図的に IDisposable を実装 しません。ドキュメントセッションはセッションキャッシュ内で独立して存在するため、サービスを破棄しても開いているドキュメントが削除されることはありません（Core Concepts → How the Viewer Works を参照）。

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

サーバー側のアノテーションのロードとエクスポートです。完全な手順は ガイド → アノテーション にあります；概要は次のとおりです:

DICOM メタデータ

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

このメソッドは API の整合性のために存在しますが、.NET 6 DICOM ビューアは技術タグを提供できません。DICOM および非 DICOM セッションでは null を返します；DICOM セッションではプラットフォームの制限を説明する一度だけの警告も出力します。ページ、フレーム、アニメーションのレンダリングは引き続きサポートされています。

リソースヘルパー — 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 (search-gated), IncludeAnnotationCss (annotation-gated).

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で追加。