検索

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

Search UI を有効化

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

Search と annotation は組み込みのライセンス機能であり、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">
    <!-- ビューアコントロール、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: '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>

コンポーネントは 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   // オプション: ユーザーが領域をドラッグしてテキストをコピーできるようにする
});

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 → テキストベースの PDF に変換され、検索可能
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

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

通常の検索動作

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

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

CanSearch() は、特定のスキャンド PDF にテキスト層がなく結果がゼロであっても、検索可能なビューアに対して true になることがあります。

ライセンスと UI の動作

アクティブな Temporary/Demo ライセンスは有効期間中 Search を付与します。ライセンスが無い、またはレガシー TRIAL ファイルは Search 機能を付与しません。Search が無い場合:

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

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

トラブルシューティング