Search Text in PDF and Office Documents using JavaScript

Search through the UI

WebViewer, DOCX Editor, and Spreadsheet Editor each have a text search panel built into the UI to handle searching in their respective file types.

WebViewer Search UI

Search programmatically

Searching for text can be performed using programmatic APIs:

JavaScript

WebViewer(...)
.then(instance => {
  const documentViewer = instance.Core.documentViewer;
  
  documentViewer.addEventListener('documentLoaded', async () => {
    const searchStream = documentViewer.search('search_term'); // Setting up stream using your string to search.
    const searchResults = await searchStream.getAll(); // Wait for all results.
    console.log('search results:', searchResults);
  });
});

DocumentViewer.search

For more precise results, you can add Search.Mode options to better refine the results:

JavaScript

WebViewer(...)
.then(instance => {
  const { documentViewer, Search } = instance.Core;
  
  documentViewer.addEventListener('documentLoaded', async () => {
    const searchMode = [Search.Mode['WHOLE_WORD'], Search.Mode['CASE_SENSITIVE']];
    const searchStream = documentViewer.search('search_term', searchMode); // Setting up stream using your string to search with whole word and case sensitivity.
    const searchResults = await searchStream.getAll(); // Wait for all results.
    console.log('search results:', searchResults);
  });
});

DocumentViewer.search

You can also progressively search for text if you don’t want to wait for the entire list of search items to be retrieved:

JavaScript

WebViewer(...)
.then(instance => {
  const documentViewer = instance.Core.documentViewer;
  
  documentViewer.addEventListener('documentLoaded', async () => {
    const searchStream = documentViewer.search('search_term'); // Setting up stream using your string to search.
    const searchResults= [];
  
    for await (const result of searchStream) {
      searchResults.push (result); // Progressively adding results to an array.
      console.log('search result found:', result);
    }
  });
});

DocumentViewer.search