How to Replace Text and Hyperlinks in Google Documents with Apps Script

How to Replace Text and Hyperlinks in Google Documents with Apps Script

by

Hey, friends today I will teach you How to Replace Text and Hyperlinks in Google Documents with Apps Script. Google Docs is used to create the company’s handbook. The document is several pages long, and the writer has been asked to create links so that every mention of the company name in the document links to the company’s official website. so let get started with today Code snippets. Getting different problems is altogether gives a very different experience. today the Code snippets I am going to share with you is How to Replace Text and Hyperlinks in Google Documents with Apps Script.

How to Replace Text and Hyperlinks in Google Documents with Apps Script

It can be a time-consuming task, but with Google Apps Script, you can hyperlink specific words in a document in bulk with a single click.

This example demonstrates how to search for and replace all occurrences of a text phrase, in this case the company name, and add links to a specific website.

const addLinks = () => {
  const searchPhrase = "Digital Inspiration";
  const hyperlink = "https://digitalinspiration.com/";

  const document = DocumentApp.getActiveDocument();
  const body = document.getBody();
  let search = null;

  while ((search = body.findText(searchPhrase, search))) {
    const searchElement = search.getElement();
    const startIndex = search.getStartOffset();
    const endIndex = search.getEndOffsetInclusive();
    searchElement.asText().setLinkUrl(startIndex, endIndex, hyperlink);
  }

  document.saveAndClose();
};

Change Text of Hyperlinks in Google Docs

The company name has changed for the next iteration of the handbook, but the website domain remains the same. The writer must change every instance of the company’s name in the document, but the underlying hyperlink must remain unchanged.

const changeText = () => {
  const searchText = "Blue Widgets Inc.";
  const replaceText = "Orange Inc.";

  const document = DocumentApp.getActiveDocument();
  const body = document.getBody();
  let search = null;

  while ((search = body.findText(searchText, search))) {
    const searchElement = search.getElement();
    const startIndex = search.getStartOffset();
    const endIndex = search.getEndOffsetInclusive();

    const textElement = searchElement.asText();
    const existingLink = textElement.getLinkUrl(startIndex);
    textElement.deleteText(startIndex, endIndex);
    textElement.insertText(startIndex, replaceText);
    textElement.setLinkUrl(
      startIndex,
      startIndex + replaceText.length - 1,
      existingLink
    );
  }

  document.saveAndClose();
};

Change Text and Hyperlinks in Google Docs

The following Apps Script snippets demonstrate how to change all instances of the company name as well as replace the site URL with a different domain name.

const changeTextWithUrl = () => {
  const searchText = "Blue Widgets Inc.";
  const replaceText = "Orange Inc.";
  const replaceUrl = "https://digitalinspiration.com/";

  const document = DocumentApp.getActiveDocument();
  const body = document.getBody();
  let search = null;

  while ((search = body.findText(searchText, search))) {
    const searchElement = search.getElement();
    const startIndex = search.getStartOffset();
    const endIndex = search.getEndOffsetInclusive();

    const textElement = searchElement.asText();
    textElement.deleteText(startIndex, endIndex);
    textElement.insertText(startIndex, replaceText);
    textElement.setLinkUrl(
      startIndex,
      startIndex + replaceText.length - 1,
      replaceUrl
    );
  }

  document.saveAndClose();
};

You might also like our trending code snippets

Leave a Comment