ビューア

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

Viewer (namespace Doconut) は、MVC コントローラ、Web Forms ページ、ハンドラからドキュメントを開くための公開エントリーポイントです。DoconutHost.Initialize によって構成された一時的なサービスです。使用する場所で解決してください:

csharp
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();

new Viewer() は DoconutHost.Initialize が実行された後でも機能します — 同じサービスを解決します — これにより、従来のパッケージから移行したコードがコンパイルできます。Initialize の前では、InvalidOperationException がスローされます。

Viewer はリクエストごとのドキュメント状態を保持せず、意図的に IDisposable を実装しないです:ドキュメントセッションはそれとは独立して存在するため、Viewer を破棄しても開いているドキュメントを閉じることはできません(How the Viewer Works を参照)。

OpenDocumentAsync

ドキュメントを開き、ウィジェットが以降のすべてのリクエストで使用するセッショントークンを返します。UnsafeMode が false(既定)の場合、トークンは現在のリクエストの ASP.NET セッションに付与されます — セッションステートが有効なリクエストから呼び出してください(Sessions & Security を参照)。

オーバーロード使用シーン
Task<string> OpenDocumentAsync(string filePath, DocOptions? options = null, CancellationToken ct = default)ディスクから自動フォーマット検出とフォーマットの既定設定で開く
Task<string> OpenDocumentAsync(string filePath, BaseConfig? config, DocOptions? options = null, CancellationToken ct = default)フォーマットごとのレンダリングオプション(PdfConfig、WordConfig、…)が必要
Task<string> OpenDocumentAsync(Stream stream, FileInfo fileInfo, BaseConfig? config = null, DocOptions? options = null, CancellationToken ct = default)ドキュメントがディスク上のファイルでない場合(アップロード、データベース、BLOB)。fileInfo は正しい拡張子を持つ必要があり、フォーマットを選択します
csharp
// シンプルに開く
string token = await viewer.OpenDocumentAsync(path);

// フォーマットごとの設定とオプション付き
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// アップロードから (HttpPostedFileBase in MVC; HttpPostedFile in Web Forms)
using (var ms = new MemoryStream())
{
    await file.InputStream.CopyToAsync(ms);
    ms.Position = 0;
    token = await viewer.OpenDocumentAsync(ms, new FileInfo(Path.GetFileName(file.FileName)));
}

対処すべき例外:

  • LicenseException — ライセンスは検出されたものの拒否された(メッセージに理由が含まれる)か、フォーマットがライセンスが許可しないプラグイン機能を必要とする場合。
  • FormatNotSupportedException — ファイルの拡張子を処理できるビューアが存在しない。
  • InvalidDataException — コンテンツが破損しているか、拡張子と一致しない。

OpenDocument (synchronous)

非同期ページを使用しない Web Forms のコードビハインドやその他のコード向け:

text
string OpenDocument(string filePath, BaseConfig? config = null, DocOptions? options = null)
string OpenDocument(Stream stream, string fileName, BaseConfig? config = null, DocOptions? options = null)
string OpenDocument(byte[] bytes, string fileName, BaseConfig? config = null, DocOptions? options = null)

各メソッドはトークンを返すと同時に viewer.Token にも保存します。fileName は正しい拡張子を持つ必要があります。これらのラッパーは Web Forms ページから安全に呼び出せます:オープンパスは ASP.NET リクエストコンテキスト上で再開されないため、待機してもデッドロックしません。すべての非同期 Doconut API が同様に当てはまらない — 詳細は Converter Plugin の Web Forms セクションをご覧ください。

CloseDocument

text
void CloseDocument(string token)

セッションを削除し(ドキュメントエンジンを即座に解放し)、現在のリクエストの ASP.NET セッションからトークンの付与を削除し、トークンを無効化します。オプションとして、スライディング有効期限は同じクリーンアップを実行しますが、大きなドキュメントの場合は推奨されます。

セッションクエリ

メンバー戻り値
int GetPageCount(string token)開いているドキュメントの総ページ数
(int Width, int Height) GetPageDimensions(string token, int page = 1)100% ズーム時のデフォルトレンダリングページサイズ — コード内で構築された注釈用の座標空間
IReadOnlyList<string> GetWorksheetNames(string token)スプレッドシートのレンダリングされたワークシート(ブック順)。他のドキュメントでは空です

トークンが不明または期限切れの場合は InvalidOperationException(Document session not found. Please re-open document.)がスローされ、空のトークンの場合は ArgumentException がスローされます。

DocOptions

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

型プロパティデフォルト説明
stringPassword""保護されたドキュメントのパスワード(自動的にフォーマット設定にコピーされます)。
stringWatermark""レンダリングされたページに描画されるカスタム透かしテキスト — 下記参照。
intTimeOut60セッションのスライディング有効期限(分単位)。
stringBrowserId""Web ファーム:署名済みチケットがバインドされるブラウザー。DoconutFarmBinding.EnsureBrowserId で設定します(セッションとセキュリティ を参照)。
stringUserId""Web ファーム:チケットがバインドされるサインインユーザー、DoconutFarmBinding.ResolveUserId から取得。
intImageResolution0廃止予定。 代わりにフォーマット設定で ImageResolution を設定してください。
boolIsSecuredtrue予約済み;強制されません。アクセス制御は DoconutOptions.UnsafeMode です。
boolIsWebFarm / string WebFarmPathfalse / ""クラシックパッケージから移行されたコード用に保持されています。これらはファームモードをオンにしません — AddDoconutDistributed がオンにします。
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
    });
フィールド例意味
Leading ^^オプションの全コーナーレイアウト。これがない場合は通常の配置が使用されます。
テキストConfidential各ページに描画されるテキスト。空であってはなりません。
カラーRed名前付きカラー。
フォントサイズ24フォントサイズ。無効な数値入力はデフォルトにフォールバックします。
フォント名Verdanaフォントファミリー。サーバーにインストールされている必要があります — Windows Server はデスクトップよりフォントが少ないです。
不透明度800 から 255。解析できる必要があります。
角度-45度単位の回転。無効な数値入力はデフォルトにフォールバックします。

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

ライセンス判定

ライセンス状態カスタム値が提供されたかレンダリング結果
有効な有料ビューアライセンスいいえクリーンページ
有効な有料ビューアライセンスはいカスタム透かし
有効な一時/デモライセンスいいえクリーンページ
有効な一時/デモライセンスはいカスタム透かし
欠如、拒否、期限切れ、バージョン不一致、または無効ドメインのライセンスいずれか評価用透かし;カスタム値は置き換えられません

同じ判定は配信ページおよび注釈エクスポートにも適用されます。カスタム透かしはライセンスされたアプリケーションの機能であり、評価用透かしを置き換える手段ではありません。

アノテーション API

サーバー側でのアノテーションの読み込みとエクスポートです。ウォークスルーはアノテーションにあります。

メンバー目的
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() が返すエンコードされたエンベロープをロードする
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(string token, string directoryPath, int zoom = 100, CancellationToken ct = default)ページごとに1つのPNG、アノテーションが埋め込まれ、directoryPath に書き込む(存在しない場合は作成);書き込まれた画像数を返す
Task<byte[]> ExportAnnotationsToPngZipAsync(string token, int zoom = 100, CancellationToken ct = default)ページごとのPNGにアノテーションが埋め込まれたZIP

DICOM メタデータ

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

このパッケージでは常にnullを返し、ウィジェットのメタデータ要求は501 Not Implementedで応答します:.NET FrameworkではDICOMタグの読み取りは利用できません。DICOM レンダリング — ページ、フレーム、アニメーション — は機能します。DICOM プラグインをご覧ください。

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

リソースモジュールがDoconutOptions.ResourcesPath以下で提供するリソースのために、<link> と <script> タグを依存順に出力します。ライセンスで制御される機能(Search、Annotation)のファイルは、ライセンスが許可した場合にのみ出力されます。

text
string ReferenceCss(CssConfig? config = null)       // null → Bootstrap + viewer + search + annotation
string ReferenceScripts(ScriptConfig? config = null)
bool IsSearchEnabled { get; }                       // ライセンス状態、リボン init コードを保護するため
bool IsAnnotationEnabled { get; }

CssConfig フラグ: IncludeBootstrapCss、IncludeViewerCss、IncludeSearchCss(検索制御)、IncludeAnnotationCss(注釈制御)。

ScriptConfig フラグ: IncludeJQuery(すべての他に必要)、IncludeBootstrap、IncludeViewerScripts(コアビューアスクリプト)、IncludeSearchScripts と IncludeSearchBar(検索制御)、IncludeAnnotationScripts と IncludeAnnotationBar(注釈制御)、EmitFeatureFlags(デフォルト true:インライン window.Doconut.features = { search, annotation, editor } スクリプトも書き込む;インラインスクリプトをブロックするContent‑Security‑Policy下ではfalseに設定)。

どちらもHTMLを返します:MVC 5では@Html.Raw(...)で記述します(コントローラで生成し、ビューには@injectがありません)またはWeb Formsでは<%= %>で記述します。クイックスタートは両方を示しています。

RenderViewer

text
string RenderViewer(string elementId, string token, ViewerConfig? config = null)

<script> ブロックを返し、id elementId の要素上でウィジェットを初期化し、ドキュメントを表示します:docViewer({...}) はViewerConfig から構築されます(デフォルト:BasePath: '/'、ResPath: 'doconut-res/images')、その後.View(token)。ビューアスクリプトの後に記述してください。生成されたスクリプトはビューアオブジェクトへの参照を保持しないため、独自のツールバーを持つページではウィジェットを手動で初期化すべきです。ビューア設定をご覧ください。

Web ファーム

string? AccessToken は、分散モードが有効なときに最新のオープンで発行された署名済みチケットを保持し、UnsafeMode が false の場合です;単一サーバーではnullです。トークンと共にウィジェットへ送ります:objViewer.View(token, accessToken).

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