検索

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

検索 UI を有効にする

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

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

@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 を初期化し、次にライセンスされたリボンを添付します：

<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Viewer controls, including the button that opens Search -->
</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: '/',
        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>

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

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

公開 API は意図的にシンプルです：

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

JavaScript から検索

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

第2引数は単語全体/完全一致を指定します。コールバック後は：

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

検索機能の確認

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

X-Doconut-Can-Search: 1

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

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

フォーマットが技術的に検索可能でも、現在のライセンスがその操作を許可しない場合があります。

フォーマットごとの抽出を有効にする

var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // optional: lets the user drag a region and copy its text
});

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

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

// DefaultRender = false → converted to a text-based PDF → searchable
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

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

通常の検索動作

サーバーは次の順序で検索ソースを試みます：

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

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

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

ライセンスと UI の挙動

アクティブな Temporary/Demo ライセンスは有効期間中に Search を許可します。ライセンスが無い場合やレガシーな TRIAL ファイルは Search 機能を提供しません。Search が無い場合は：

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

IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) でカスタム UI の表示を制御し、CanSearch() を使用してフォーマット/セッションごとの判定を取得してください。

トラブルシューティング