検索

Viewer 構成内のネイティブテキスト検索

Doconut Viewer は、フォーマットビューアによって抽出されたテキストまたはテキストベースの PDF リダイレクトを使用した通常の検索を提供します。Search ライセンス機能が必要です。

検索 UI を有効にする

検索は Viewer モジュールであり、スタンドアロンのツールバーではありません。完全なページには Viewer リソース、Viewer ツールバー、Viewer マウント、および初期化された objViewer が含まれている必要があります。Search リボンはその後、同じインスタンスにマウントされて添付されます。

検索と注釈は組み込みのライセンス機能であり、AddPlugin<T>() パッケージではありません。注入された Viewer から検索リソースをリクエストします。これらのタグは、ライセンスが検索を許可した場合にのみ出力されます。

html
@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
    IncludeViewerCss = true,
    IncludeSearchCss = true
}))

@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
    IncludeJQuery = true,
    IncludeViewerScripts = true,
    IncludeSearchScripts = true,
    IncludeSearchBar = true
}))

埋め込みリボンは、カスタム UI で利用可能な同じ JavaScript メソッドを呼び出します。

マークアップ内で完全な Viewer 構成を可視化したまま、まず docViewer を初期化し、次にライセンスされたリボンを添付します:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- ビューアのコントロール、検索を開くボタンを含む -->
</nav>
<div id="searchBarMount"></div>
<div id="divDocViewer"><div id="div_ctlDoc"></div></div>

<script>
    let searchBar = null;
    let currentToken = '';

    const objViewer = $('#div_ctlDoc').docViewer({
        BasePath: 'doconut',
        ResPath: 'doconut-res/images'
    });

    @if (Viewer.IsSearchEnabled)
    {
        <text>
    searchBar = $('#searchBarMount').doconutSearchBar({
        docId: 'ctlDoc',
        getRequestParams: () => ({ token: currentToken }),
        onStatus: (message) => console.log(message),
        onToast: (message, type) => console.log(type, message),
        onLayout: () => requestAnimationFrame(() => objViewer.Refit())
    });
    searchBar.attach(objViewer);
        </text>
    }
</script>

サーバー側の if が重要です。検索機能がない場合、ReferenceScripts はリボンのスクリプトを除外するため、保護されていない doconutSearchBar(...) 呼び出しは例外を投げ、Viewer ページの起動を停止します。

コンポーネントは Find、Options、Results グループを注入し、検索、クリア、マッチ数、前後のマッチナビゲーションを処理します。ホスト所有の Viewer ツールバーはそれを切り替えるだけで構いません:

javascript
searchBar.isOpen() ? searchBar.close() : searchBar.open();

その公開 API は意図的に小さく設計されています:

メソッド用途
attach(objViewer)初期化されたビューアにリボンを接続します。1 回だけ必要です
open() / close()リボンを表示または非表示にします。閉じるとハイライトもクリアされます
reset()現在の検索語、結果数、ハイライトをクリアします
isOpen()リボンが表示されているかどうかを報告します
setStatus(message)設定されたコールバックを通じてステータスメッセージを転送します

オプションの onToggle(isOpen) コールバックにより、ホストは検索ボタンを同期でき、onLayout によりリボンの高さが変わったときにビューアをリサイズ/再フィットできます。Viewer、Search、Annotation の組み合わせ起動シーケンスについては、クイックスタート を参照してください。

JavaScript から検索

javascript
objViewer.Search(keyword, false, function (resultCount) {
    console.log('Matches:', resultCount);
});

第2引数は単語全体/完全一致です。マッチ数はコールバックで取得されます:Search はサーバーに送信され有用なものは返さないため、var n = objViewer.Search(keyword, false) は常に undefined を読み取ります — そのように構築されたページは「何も見つかりません」と報告し、Viewer はマッチをハイライトします。コールバックの後:

メソッド結果
SearchMatchCount()ドキュメント内の個別マッチの総数。
SearchSummary(false)[pageNumber, matchCount] エントリを再描画せずに取得。
SearchSummary(true)同じ要約でページ/サムネイルのハイライトを描画します。
GotoSearchMatch(index)0 ベースのマッチインデックスへ移動します。

ミドルウェアルートは search=<term> と exact=true|false を使用し、XML を返します。内部レスポンスを自分で解析するのではなく、ウィジェット API を使用してください。

検索機能の確認

初期化レスポンスは次のように報告します:

text
X-Doconut-Can-Search: 1

初期化後、objViewer.CanSearch() は同じ形式/セッションの判定を公開します。サーバーが 0 を送信した場合は false を返します;レスポンスが無い場合、またはヘッダーを省略する古いサーバーの場合は、デフォルトで true になります。

混同してはならない3つの独立したゲートがあります:

ゲート質問
CanSearch() / response header解決されたビューアはネイティブのインデックス/検索パスを持っていますか?
AllowSearchこの形式設定は、スイッチが存在する場所でテキスト抽出を要求しましたか?
LicenseCapability.Searchアプリケーションは検索を実行し、UIバンドルを受け取る権限がありますか?

形式は技術的に検索可能であっても、現在のライセンスがその操作を許可しない場合があります。

形式ごとの抽出の有効化

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // optional: ユーザーが領域をドラッグしてテキストをコピーできるようにする
});

AllowSearch と AllowCopy は PdfConfig、WordConfig、ExcelConfig、および PptConfig に存在します。Office のプロパティはそれらのネストされた PdfConfig に委譲します。両方ともデフォルトで false です。

PDF、Word、Excel、PowerPoint、TXT、Visio、メール、EPUB、MHT 用の標準的なネイティブ検索アダプタが存在します。XPS はデフォルトで PDF パスを使用します。HTML と Microsoft Project はテキストベースの PDF リダイレクトの恩恵を受けます:

csharp
// DefaultRender = false → テキストベースの PDF に変換 → 検索可能
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

ネイティブレンダラの場合、CanSearch() はビューアの機能を記述しますが、特定のドキュメントに利用可能なテキストが含まれていることを保証するものではありません。ページがスキャン画像のみの PDF でも、ネイティブ結果がゼロになることがあります。

標準検索の動作

サーバーは検索ソースを以下の順序で試みます:

  1. 形式のネイティブビューアからの結果。
  2. 事前構築された .srh 検索インデックス。
  3. 検索ソースが存在しない場合のエラー/空結果。

.srh インデックスは、ドキュメントが共有ストレージから提供される際にページ画像と共に公開される検索アーティファクトです。そのため、ドキュメントを一度も開いていないノードでも検索に応答できます — 詳細は 分散デプロイメント を参照してください。

CanSearch() は、特定のドキュメントにテキスト層がなく、結果が一致しない場合でも、検索可能なビューアに対して true になることがあります。

ライセンスと UI の挙動

アクティブな Temporary/Demo ライセンスは、その有効期間中に検索機能を付与します。ライセンスが欠如している場合やレガシーな TRIAL ファイルは検索機能を付与しません。検索がない場合:

  • ReferenceCss と ReferenceScripts は検索バンドルを省略します。
  • ミドルウェアはライセンスされた結果を返す代わりに検索を拒否します。

IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) からカスタム UI の可視性を制御し、別個の形式/セッション判定には CanSearch() を使用します。

トラブルシューティング

症状確認項目
検索バーが欠如している検索機能と IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() が false です形式ビューア、選択された DefaultRender パス、そして初期化レスポンスヘッダー
スキャンされた PDF の検索結果がゼロになるドキュメントにテキスト層がありません;テキストを含むソースまたはテキストを保持する PDF 投影を使用してください
検索は機能するがハイライトがずれるレンダリングパス、解像度、ドキュメント変換、抽出された単語ボックス

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