Ricerca
Ricerca di testo nativa nella composizione del Viewer
Il Doconut Viewer fornisce la Ricerca normale utilizzando il testo estratto dal visualizzatore di formato o un reindirizzamento PDF basato su testo. Richiede la capacità di licenza Search.
Abilita l'interfaccia di ricerca
La Ricerca è un modulo del Viewer, non una barra degli strumenti autonoma. La pagina completa deve includere le risorse del Viewer, la barra degli strumenti del Viewer, il montaggio del Viewer e objViewer inizializzato; il Ribbon di Ricerca viene quindi montato e collegato alla stessa istanza.
Ricerca e annotazione sono funzionalità con licenza integrate, non pacchetti AddPlugin<T>(). Richiedi le risorse di ricerca dall'Viewer iniettato; i loro tag vengono emessi solo quando la licenza concede la Ricerca.
@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
IncludeViewerCss = true,
IncludeSearchCss = true
}))
@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
IncludeJQuery = true,
IncludeViewerScripts = true,
IncludeSearchScripts = true,
IncludeSearchBar = true
}))Il ribbon incorporato chiama gli stessi metodi JavaScript disponibili per un'interfaccia personalizzata.
Mantieni la composizione completa del Viewer visibile nel markup, inizializza prima docViewer, quindi collega il Ribbon con licenza:
<nav id="toolbar" aria-label="Document viewer controls">
<!-- Controlli del visualizzatore, incluso il pulsante che apre la ricerca -->
</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>Il if lato server è importante: senza la capacità di Ricerca, ReferenceScripts omette lo script del Ribbon, quindi una chiamata non protetta a doconutSearchBar(...) genererebbe un'eccezione e fermerebbe l'avvio della pagina del viewer.
Il componente inietta i gruppi Trova, Opzioni e Risultati e gestisce la ricerca, la cancellazione, il conteggio delle corrispondenze e la navigazione tra le corrispondenze precedenti/successive. Una barra degli strumenti del Viewer di proprietà dell'host deve solo attivarla/disattivarla:
searchBar.isOpen() ? searchBar.close() : searchBar.open();La sua API pubblica è intenzionalmente piccola:
| Metodo | Scopo |
|---|---|
attach(objViewer) | Collega il Ribbon al viewer inizializzato; richiesto una sola volta |
open() / close() | Mostra o nascondi il Ribbon; la chiusura cancella anche gli evidenziamenti |
reset() | Cancella il termine corrente, il conteggio dei risultati e gli evidenziamenti |
isOpen() | Restituisce se il Ribbon è visibile |
setStatus(message) | Inoltra un messaggio di stato tramite il callback configurato |
Il callback opzionale onToggle(isOpen) consente all'host di sincronizzare il suo pulsante di Ricerca, e onLayout gli permette di ridimensionare/adattare il viewer quando l'altezza del Ribbon cambia. Per la sequenza di avvio combinata di Viewer, Ricerca e Annotazione, vedi Avvio rapido.
Ricerca da JavaScript
objViewer.Search(keyword, false, function (resultCount) {
console.log('Matches:', resultCount);
});Il secondo argomento è il match parola intera/esatto. Il conteggio delle corrispondenze arriva nel callback: Search stesso va al server e non restituisce nulla di utile, quindi var n = objViewer.Search(keyword, false) legge sempre undefined — e una pagina costruita in questo modo segnala “nessun risultato” mentre il viewer evidenzia le corrispondenze. Dopo il callback:
| Metodo | Risultato |
|---|---|
SearchMatchCount() | Totale delle corrispondenze individuali nel documento. |
SearchSummary(false) | [pageNumber, matchCount] voci senza ridisegnare. |
SearchSummary(true) | Stesso riepilogo e dipinge gli evidenziamenti della pagina/miniatura. |
GotoSearchMatch(index) | Naviga a un indice di corrispondenza basato su zero. |
Il percorso middleware utilizza search=<term> e exact=true|false e restituisce XML. Usa l'API del widget invece di analizzare manualmente quella risposta interna.
Verifica capacità di ricerca
La risposta di inizializzazione segnala:
X-Doconut-Can-Search: 1Dopo l'inizializzazione, objViewer.CanSearch() espone lo stesso verdetto di formato/sessione. Restituisce false quando il server invia 0; prima della risposta, o con un server più vecchio che omette l'intestazione, predefinisce true.
Tre porte indipendenti non devono essere confuse:
| Porta | Domanda |
|---|---|
CanSearch() / response header | Il visualizzatore risolto ha un percorso nativo di indice/ricerca? |
AllowSearch | Questa configurazione di formato ha richiesto l'estrazione del testo dove è presente l'interruttore? |
LicenseCapability.Search | L'applicazione è autorizzata a eseguire la ricerca e a ricevere i bundle UI? |
Un formato può essere tecnicamente ricercabile mentre la licenza corrente nega l'operazione.
Abilita estrazione per formato
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
AllowSearch = true,
AllowCopy = true // opzionale: consente all'utente di trascinare una regione e copiare il suo testo
});AllowSearch e AllowCopy esistono su PdfConfig, WordConfig, ExcelConfig e PptConfig. Le proprietà di Office delegano ai loro PdfConfig nidificati. Entrambi predefiniti a false.
Gli adattatori di ricerca nativa normali esistono per PDF, Word, Excel, PowerPoint, TXT, Visio, email, EPUB e MHT. XPS utilizza il suo percorso PDF per impostazione predefinita. HTML e Microsoft Project beneficiano di un reindirizzamento PDF basato su testo:
// DefaultRender = false → convertito in un PDF basato su testo → ricercabile
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });Per i renderer nativi, CanSearch() descrive la capacità del visualizzatore; non garantisce che un documento specifico contenga testo utilizzabile. Un PDF le cui pagine sono solo immagini scansionate può comunque produrre zero risultati nativi.
Comportamento di ricerca normale
Il server prova le fonti di ricerca in questo ordine:
- Risultati dal visualizzatore nativo del formato.
- Un indice di ricerca predefinito
.srh. - Un risultato di errore/vuoto quando non esiste alcuna fonte di ricerca.
L'indice .srh è l'artefatto di ricerca pubblicato insieme alle immagini delle pagine quando i documenti sono serviti da storage condiviso, così un nodo che non ha mai aperto il documento può comunque rispondere alle ricerche — vedi Distribuzioni distribuite.
CanSearch() può essere vero per un visualizzatore ricercabile anche quando un documento specifico non ha uno strato di testo e quindi non restituisce corrispondenze.
Licenze e comportamento UI
Una licenza Temporanea/Demo attiva concede la Ricerca durante il suo periodo attivo. Una licenza mancante e un file legacy TRIAL non concedono alcuna capacità di Ricerca. Senza Ricerca:
ReferenceCsseReferenceScriptsomettono i bundle di ricerca.- Il middleware nega la ricerca invece di restituire risultati con licenza.
Gestisci la visibilità dell'UI personalizzata da IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) e usa CanSearch() per il verdetto separato di formato/sessione.
Risoluzione dei problemi
| Sintomo | Verifica |
|---|---|
| Barra di ricerca mancante | Capacità di ricerca e IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar |
CanSearch() è false | Visualizzatore di formato, percorso DefaultRender selezionato e intestazione della risposta di inizializzazione |
| La ricerca restituisce zero per un PDF scansionato | Il documento non ha uno strato di testo; usa una fonte con testo o una proiezione PDF che preservi il testo |
| La ricerca funziona ma gli evidenziamenti sono spostati | Percorso di rendering, risoluzione, trasformazioni del documento e riquadri delle parole estratte |
Questa pagina è stata utile?