Search and Replace Text within WebViewer, DOCX Editor, and Spreadsheet Editor

Info: Search and replace for PDF documents in the WebViewer requires the Content Edit add-on.

All three document viewers include built-in UIs for search and replace in their respective file types.

WebViewer Search and Replace UI

Search and replace can also be handled uniformly across all three viewers using 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.
    await documentViewer.replace(searchResults, 'replace_term'); // Replace results using string.
  });
});

Related links

• DocumentViewer.search
• DocumentViewer.replace

DOCX Editor search and replace behavior

Version 12.2.0 improves search and replace performance in the DOCX Editor. Performance can still vary, and text in headers and footers returns a single search result. For details, see the DOCX Editor search and replace FAQ.

Here is another sample that replaces all of the search results found only on page one:

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.
    const firstPageResults = searchResults.filter(result => result.pageNum === 1); // Search results can be filtered or reordered but not modified. 
    await documentViewer.replace(firstPageResults, 'replace_term'); // Replace results using string.
  });
}); 

Related links

• DocumentViewer.search
• DocumentViewer.replace