検索

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

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

検索 UI を有効にする

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

検索とアノテーションは組み込みのライセンス機能であり、AddPlugin<T>() パッケージではありません。Viewer から検索リソースを要求してください。これらのタグはライセンスが検索機能を許可した場合にのみ出力されます。MVC 5 のビューには @inject がないため、コントローラーでタグを作成し、ViewBag を介してページが必要とするライセンスフラグと共に渡します。

csharp
public class ViewerController : Controller
{
    public ActionResult Index()
    {
        var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
        ViewBag.ViewerCss = viewer.ReferenceCss(new CssConfig
        {
            IncludeViewerCss = true,
            IncludeSearchCss = true
        });
        ViewBag.ViewerScripts = viewer.ReferenceScripts(new ScriptConfig
        {
            IncludeJQuery        = true,
            IncludeViewerScripts = true,
            IncludeSearchScripts = true,
            IncludeSearchBar     = true
        });
        ViewBag.IsSearchEnabled = viewer.IsSearchEnabled;
        return View();
    }
}

@Html.Raw(ViewBag.ViewerCss) と @Html.Raw(ViewBag.ViewerScripts) を使用してビューに書き込みます。Web Forms では、コードビハインドから同じ値を公開し、<%= %> を使用して書き込みます。

埋め込みリボンは、カスタム 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: '/',
        ResPath: 'doconut-res/images'
    });

    @if ((bool)ViewBag.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 ページの起動を停止します。Web Forms では、同じガードを <% if (IsSearchEnabled) { %> … <% } %> として記述します。

コンポーネントは 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 を読み取ります — そしてそのように構築されたページは「何も見つかりません」と報告し、ビューアは一致箇所をハイライトします。コールバックの後:

方法結果
SearchMatchCount()文書内の個別の一致数の合計。
SearchSummary(false)[pageNumber, matchCount] エントリ(再描画なし)。
SearchSummary(true)同じ要約でページ/サムネイルのハイライトを描画します。
GotoSearchMatch(index)0ベースの一致インデックスへ移動します。

DocImage.axd は XML で search=<term> と exact=true|false に応答します。内部レスポンスを自分で解析するのではなく、ウィジェット 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   // オプション: ユーザーが領域をドラッグしてテキストをコピーできるようにします
});

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. 検索ソースが存在しない場合のエラー/空結果。

CanSearch() は、特定の文書にテキスト層がなく一致が返されない場合でも、検索可能なビューアでは true になることがあります。

ライセンスと UI の動作

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

  • ReferenceCss と ReferenceScripts は検索バンドルを省略します。
  • DocImage.axd は結果を返す代わりに検索リクエストを拒否します。

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

トラブルシューティング

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

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