ビューア

メインのドキュメントビューアクラス

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

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

OpenDocumentAsync (ドキュメントを開く)

ドキュメントを開き、クライアントウィジェットが以降のすべてのリクエストで使用するセッショントークンを返します。

オーバーロード使用シーン
Task<string> OpenDocumentAsync(string filePath, DocOptions? options = null, CancellationToken ct = default)ディスクから開く(自動フォーマット検出とフォーマットのデフォルト設定を使用)
Task<string> OpenDocumentAsync(string filePath, BaseConfig? config, DocOptions? options = null, CancellationToken ct = default)フォーマットごとのレンダリングオプション(PdfConfigWordConfig など)が必要な場合
Task<string> OpenDocumentAsync(Stream stream, FileInfo fileInfo, BaseConfig? config = null, DocOptions? options = null, CancellationToken ct = default)ドキュメントがディスク上のファイルでない場合(アップロード、データベース、BLOB)。fileInfo は正しい拡張子を持つ必要があり、フォーマット検出に使用されます
csharp
// 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 — 見つかったライセンスが拒否された場合(メッセージに拒否理由が含まれる)、またはフォーマットがもはや許可されていないプラグイン機能を必要とする場合。拒否メッセージなしの期限切れカレンダーは、例外をスローせずに透かし付きレンダリングに降格します。
  • FormatNotSupportedExceptionDocument format '<extension>' is not supported.
  • InvalidDataException — ファイル内容が破損しているか、拡張子と一致しません。

CloseDocument (ドキュメントを閉じる)

text
void CloseDocument(string token)

キャッシュからセッションを削除し(ドキュメントエンジンを即座に破棄)、セキュリティマーカーを削除し、アクセス権を取り消します。オプションで、スライディング有効期限が同様のクリーンアップを行いますが、大きなドキュメントの場合は推奨されます。

GetPageCount (ページ数取得)

text
int GetPageCount(string token)

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

DocOptions (ドキュメントオプション)

オープンごとの、フォーマットに依存しないオプション(名前空間 Doconut):

プロパティデフォルト説明
stringPassword""保護されたドキュメントのパスワード(自動的にフォーマット設定にコピーされます)。
intImageResolution0廃止予定。 互換性のためだけに残されています — 代わりにフォーマット設定で ImageResolution を設定してください。
stringWatermark""レンダリングされたページに描画されるカスタム透かしテキスト。フォーマット文字列: "^Text~Color~FontSize~FontName~Opacity~Angle"、例: "^Sample Copy~Red~24~Verdana~80~-45"
intTimeOut60セッションのスライディング有効期限(分)。
boolIsSecuredtrue現在は強制されていません — 予約項目。トークンバインディングは DoconutOptions.UnsafeMode によってグローバルに制御されます(Core Concepts → Sessions & Security を参照)。

クラスは、通常のシングルホストビューイングフローの外に意図的に配置された特殊プロパティも公開しています:

プロパティデフォルト説明
boolIsWebFarmfalseオープン操作をウェブファームシナリオとしてマークします。対応する共有ストレージ/セッションアーキテクチャと併用してください。
stringWebFarmPath""専門的なウェブファームワークフローで使用される共有パス。通常のシングルホストビューアでは空です。
boolEditModefalse別途配布されるエディターワークフロー用に予約されています。標準ビューアでは false のままにしてください。

カスタム透かし

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

text
^Text~Color~FontSize~FontName~Opacity~Angle
csharp
string token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig(),
    new DocOptions
    {
        Watermark = "^Confidential~Red~24~Verdana~80~-45",
        TimeOut = 30
    });
フィールド意味
先頭 ^^オプションの全コーナーレイアウト。これがない場合は通常の透かし配置が使用されます。
TextConfidential各ページに描画されるテキスト。空であってはなりません。
ColorRed描画レイヤーが理解できる名前付きカラー。
FontSize24フォントサイズ。無効な数値入力はレンダラのデフォルトにフォールバックします。
FontNameVerdana要求されたフォントファミリ。デプロイ環境にインストールされていることを確認してください。
Opacity800 から 255 のバイト値。正しく解析できる必要があります。
Angle-45度単位の回転角度。無効な数値入力はデフォルトにフォールバックします。

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

ライセンス判定

ライセンス状態カスタム値の提供描画結果
有効な有料ビューアライセンスなしクリーンページ
有効な有料ビューアライセンスありカスタム透かし
有効な一時/デモベースビューアなしクリーンベースビューアページ
有効な一時/デモベースビューアありクリーンベースビューアパスが適用される場合のカスタム透かし
欠如、拒否、期限切れ、バージョン不一致、または無効ドメインのライセンスいずれか強制/評価透かし;カスタム値は上書きできません
評価ルール下のプラグインレンダリングいずれか評価透かし

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

アノテーション API

サーバー側のアノテーションのロードとエクスポート。完全な手順は Guides → Annotations にあります;インターフェースは次のとおりです:

メンバー目的
AnnotationManager GetAnnotationManager(string token)オープンセッションのページ寸法にバインドされたマネージャー
AnnotationManager GetAnnotationManager(string token, int pageWidth, int pageHeight)明示的なページ寸法を持つマネージャー
AnnotationManager GetAnnotationManager(int pageWidth, int pageHeight)セッションに依存しないマネージャー
void LoadAnnotationData(string token, AnnotationManager manager)C# で構築されたアノテーションをセッションにロード
void LoadAnnotationData(string token, string annotationData)AnnotationManager.GetAnnotationData() が返すエンコードされたページ/Base64 エンベロープからアノテーションをロード
void LoadAnnotationXML(string token, XmlDocument annotationXml)XML からアノテーションをロード
XmlDocument GetAnnotationXML(string token)セッションのアノテーションを XML としてエクスポート
Task<byte[]> ExportAnnotationsToPdfAsync(string token, int zoom = 100, CancellationToken ct = default)アノテーションが埋め込まれた PDF
Task<int> ExportAnnotationsToPngAsync(…)アノテーションが埋め込まれた PNG ファイル
Task<byte[]> ExportAnnotationsToPngZipAsync(string token, int zoom = 100, CancellationToken ct = default)ページごとの PNG にアノテーションが埋め込まれた ZIP

DICOM メタデータ

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

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

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

UseDoconutResources() が提供する埋め込みリソース用の <link>/<script> タグを正しい依存順序で出力します。検索やアノテーションなどライセンス制御機能のバンドルは、ライセンスが有効な場合にのみ出力され、クライアント UI とサーバー動作の整合性を保ちます。

text
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 + スプリッタ + リンク), IncludeSearchScriptsIncludeSearchBar(検索制御), IncludeAnnotationScriptsIncludeAnnotationBar(アノテーション制御)。

html
@inject Doconut.Viewer Viewer

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

このページは役に立ちましたか?