ビューア

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

以前の .NET Standard ライブラリは、メモリキャッシュ、HTTP コンテキストアクセッサ、そして 1 つ以上のライセンスパスを受け取る公開コンストラクタを提供していました。そのコンストラクタは削除され、サービスグラフがこれらの依存関係を供給します。

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

OpenDocumentAsync

ドキュメントを開き、クライアントウィジェットが以降のすべてのリクエストで使用するセッショントークンを返します。すべてのオープンは非同期で行われ、同期的な OpenDocument は存在しません。

// シンプルなオープン
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)

開かれたセッションの総ページ数です。トークンが不明または期限切れの場合は例外をスローします。

GetWorksheetNames

IReadOnlyList<string> GetWorksheetNames(string token)

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

レンダリングされたワークシートのみが一覧に含まれます。非表示および空のワークシートは除外され、ExcelConfig.SheetNames がレンダリングを制限している場合は、そのワークシートだけが表示されます。ワークシートは必ずしも 1 ページとは限らず、非常に大きい場合は複数ページにまたがってレンダリングされます。トークンが不明または期限切れの場合は例外をスローします。

26.9.0 で追加。

機能フラグ

これらを Razor ビューで使用して、サーバーが実際に提供する場合にのみライセンス付きリボンをレンダリングします — クイックスタート を参照してください。

DocOptions（ドキュメントオプション）

開くごとに適用される、フォーマットに依存しないオプション (名前空間 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 にあります；インターフェースは次のとおりです：

これらはすべてセッショントークンを受け取ります。以前のライブラリのセッションフリーな GetAnnotationManager(pageWidth, pageHeight) 形状は、セッション外でアノテーションを構築するために残っていますが、ロードするには依然としてトークンが必要です。

DICOM メタデータ

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

このメソッドは API の整合性のために用意されていますが、このパッケージは技術的な DICOM タグを提供できません：メタデータリーダーは .NET 8 ビルドのみが同梱されています。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 (required by all others), IncludeBootstrap, IncludeViewerScripts (core: docViewer.js + splitter + links), IncludeSearchScripts と IncludeSearchBar (search-gated), IncludeAnnotationScripts と 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 }))

これらのヘルパーはブラウザリソースを配信するサポートされた方法です。docViewer.js、documentLinks.js、docViewer.UI.js を wwwroot にコピーしたアプリケーションは、ページが出力されたタグからレンダリングされるようになったら、それらのコピーを削除すべきです。