Class Text

Текст

Элемент, представляющий область форматированного текста. Весь текст в Document содержится в элементах Text . Элемент Text может содержаться в Equation , Equation Function , List Item или Paragraph , но не может сам содержать какой-либо другой элемент. Дополнительную информацию о структуре документа см. в руководстве по расширению Google Docs .

// Gets the body contents of the active tab.
const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Use editAsText to obtain a single text element containing
// all the characters in the tab.
const text = body.editAsText();

// Insert text at the beginning of the tab.
text.insertText(0, 'Inserted text.\n');

// Insert text at the end of the tab.
text.appendText('\nAppended text.');

// Make the first half of the tab blue.
text.setForegroundColor(0, text.getText().length / 2, '#00FFFF');

Методы

Метод Тип возврата Краткое описание
append Text(text) Text Добавляет указанный текст в конец этой текстовой области.
copy() Text Возвращает отдельную глубокую копию текущего элемента.
delete Text(startOffset, endOffsetInclusive) Text Удаляет диапазон текста.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Text(searchPattern) Range Element Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
find Text(searchPattern, from) Range Element Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Attributes(offset) Object Извлекает атрибуты по указанному смещению символов.
get Background Color() String Получает настройку цвета фона.
get Background Color(offset) String Получает цвет фона по указанному смещению символов.
get Font Family() String Получает настройку семейства шрифтов.
get Font Family(offset) String Извлекает семейство шрифтов по указанному смещению символов.
get Font Size() Number Получает настройку размера шрифта.
get Font Size(offset) Number Получает размер шрифта по указанному смещению символов.
get Foreground Color() String Получает настройку цвета переднего плана.
get Foreground Color(offset) String Получает цвет переднего плана по указанному смещению символа.
get Link Url() String Получает URL-адрес ссылки.
get Link Url(offset) String Получает URL-адрес ссылки по указанному смещению символов.
get Next Sibling() Element Извлекает следующий родственный элемент элемента.
get Parent() Container Element Извлекает родительский элемент элемента.
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
get Text Alignment(offset) Text Alignment Получает выравнивание текста для одного символа.
get Text Attribute Indices() Integer[] Извлекает набор текстовых индексов, которые соответствуют началу отдельных запусков форматирования текста.
get Type() Element Type Получает Element Type элемента.
insert Text(offset, text) Text Вставляет указанный текст по заданному смещению символов.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
is Bold() Boolean Возвращает выделенный жирным шрифтом параметр.
is Bold(offset) Boolean Извлекает настройку полужирного шрифта по указанному смещению символов.
is Italic() Boolean Получает настройку курсива.
is Italic(offset) Boolean Извлекает настройку курсива по указанному смещению символов.
is Strikethrough() Boolean Получает настройку зачеркивания.
is Strikethrough(offset) Boolean Извлекает настройку зачеркивания по указанному смещению символов.
is Underline() Boolean Получает настройку подчеркивания.
is Underline(offset) Boolean Извлекает настройку подчеркивания по указанному смещению символов.
merge() Text Объединяет элемент с предыдущим одноуровневым элементом того же типа.
remove From Parent() Text Удаляет элемент из его родителя.
replace Text(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Attributes(startOffset, endOffsetInclusive, attributes) Text Применяет указанные атрибуты к заданному диапазону символов.
set Attributes(attributes) Text Устанавливает атрибуты элемента.
set Background Color(startOffset, endOffsetInclusive, color) Text Устанавливает цвет фона для указанного диапазона символов.
set Background Color(color) Text Устанавливает цвет фона.
set Bold(bold) Text Устанавливает жирный шрифт.
set Bold(startOffset, endOffsetInclusive, bold) Text Устанавливает настройку жирного шрифта для указанного диапазона символов.
set Font Family(startOffset, endOffsetInclusive, fontFamilyName) Text Устанавливает семейство шрифтов для указанного диапазона символов.
set Font Family(fontFamilyName) Text Устанавливает семейство шрифтов.
set Font Size(startOffset, endOffsetInclusive, size) Text Устанавливает размер шрифта для указанного диапазона символов.
set Font Size(size) Text Устанавливает размер шрифта.
set Foreground Color(startOffset, endOffsetInclusive, color) Text Устанавливает цвет переднего плана для указанного диапазона символов.
set Foreground Color(color) Text Устанавливает цвет переднего плана.
set Italic(italic) Text Устанавливает курсив.
set Italic(startOffset, endOffsetInclusive, italic) Text Устанавливает курсив для указанного диапазона символов.
set Link Url(startOffset, endOffsetInclusive, url) Text Устанавливает URL-адрес ссылки для указанного диапазона символов.
set Link Url(url) Text Устанавливает URL-адрес ссылки.
set Strikethrough(strikethrough) Text Устанавливает настройку зачеркивания.
set Strikethrough(startOffset, endOffsetInclusive, strikethrough) Text Устанавливает настройку зачеркивания для указанного диапазона символов.
set Text(text) Text Устанавливает текстовое содержимое.
set Text Alignment(startOffset, endOffsetInclusive, textAlignment) Text Устанавливает выравнивание текста для заданного диапазона символов.
set Text Alignment(textAlignment) Text Устанавливает выравнивание текста.
set Underline(underline) Text Устанавливает настройку подчеркивания.
set Underline(startOffset, endOffsetInclusive, underline) Text Устанавливает настройку подчеркивания для указанного диапазона символов.

Подробная документация

append Text(text)

Добавляет указанный текст в конец этой текстовой области.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Adds the text, 'Sample body text,' to the end of the tab body.
const text = body.editAsText().appendText('Sample body text');

Параметры

Имя Тип Описание
text String Текст для добавления.

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

copy()

Возвращает отдельную глубокую копию текущего элемента.

Любые дочерние элементы, присутствующие в элементе, также копируются. У нового элемента нет родителя.

Возвращаться

Text — Новая копия.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

delete Text(startOffset, endOffsetInclusive)

Удаляет диапазон текста.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Deletes the first 10 characters in the body.
const text = body.editAsText().deleteText(0, 9);

Параметры

Имя Тип Описание
start Offset Integer Смещение первого символа, который нужно удалить.
end Offset Inclusive Integer Смещение символа последнего удаляемого символа.

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

edit As Text()

Получает Text версию текущего элемента для редактирования.

Используйте edit As Text для управления содержимым элементов в виде форматированного текста. Режим edit As Text игнорирует нетекстовые элементы (такие как Inline Image и Horizontal Rule ).

Дочерние элементы, полностью содержащиеся в удаленном текстовом диапазоне, удаляются из элемента.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, 'An editAsText sample.');
body.insertHorizontalRule(0);
body.insertParagraph(0, 'An example.');

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Возвращаться

Text — текстовая версия текущего элемента.


find Text(searchPattern)

Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.

Некоторые функции регулярных выражений JavaScript, такие как группы захвата и модификаторы режима, поддерживаются не полностью.

Предоставленный шаблон регулярного выражения независимо сопоставляется с каждым текстовым блоком, содержащимся в текущем элементе.

Параметры

Имя Тип Описание
search Pattern String шаблон для поиска

Возвращаться

Range Element — результат поиска, указывающий позицию искомого текста, или значение NULL, если совпадений нет.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

find Text(searchPattern, from)

Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.

Некоторые функции регулярных выражений JavaScript, такие как группы захвата и модификаторы режима, поддерживаются не полностью.

Предоставленный шаблон регулярного выражения независимо сопоставляется с каждым текстовым блоком, содержащимся в текущем элементе.

Параметры

Имя Тип Описание
search Pattern String шаблон для поиска
from Range Element результат поиска для поиска

Возвращаться

Range Element — результат поиска, указывающий следующую позицию искомого текста или ноль, если совпадений нет.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Attributes()

Получает атрибуты элемента.

Результатом является объект, содержащий свойство для каждого допустимого атрибута элемента, где каждое имя свойства соответствует элементу в перечислении Document App.Attribute .

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Возвращаться

Object — Атрибуты элемента.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Attributes(offset)

Извлекает атрибуты по указанному смещению символов.

Результатом является объект, содержащий свойство для каждого допустимого текстового атрибута, где каждое имя свойства соответствует элементу в перечислении Document App.Attribute .

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Declares style attributes.
const style = {};
style[DocumentApp.Attribute.BOLD] = true;
style[DocumentApp.Attribute.ITALIC] = true;
style[DocumentApp.Attribute.FONT_SIZE] = 29;

// Sets the style attributes to the tab's body.
const text = body.editAsText();
text.setAttributes(style);

// Gets the style attributes applied to the eleventh character in the
// body and logs them to the console.
const attributes = text.getAttributes(10);
console.log(attributes);

Параметры

Имя Тип Описание
offset Integer Смещение символов.

Возвращаться

Object — Атрибуты элемента.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Background Color()

Получает настройку цвета фона.

Возвращаться

String — цвет фона, отформатированный в нотации CSS (например, '#ffffff' ), или значение NULL, если элемент содержит несколько значений для этого атрибута.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Background Color(offset)

Получает цвет фона по указанному смещению символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the background color of the first 3 characters in the body.
const text = body.editAsText().setBackgroundColor(0, 2, '#FFC0CB');

// Gets the background color of the first character in the body.
const backgroundColor = text.getBackgroundColor(0);

// Logs the background color to the console.
console.log(backgroundColor);

Параметры

Имя Тип Описание
offset Integer Смещение символов.

Возвращаться

String — цвет фона, отформатированный в нотации CSS (например, '#ffffff' ).

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Font Family()

Получает настройку семейства шрифтов. Имя может быть любым шрифтом из меню «Шрифт» в Документах или Google Fonts с учетом регистра. Методы get Font Family() и set Font Family(fontFamilyName) теперь используют строковые имена для шрифтов вместо перечисления Font Family . Хотя это перечисление устарело, оно останется доступным для совместимости со старыми сценариями.

Возвращаться

String — семейство шрифтов или значение NULL, если элемент содержит несколько значений для этого атрибута.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Font Family(offset)

Извлекает семейство шрифтов по указанному смещению символов. Имя может быть любым шрифтом из меню «Шрифт» в Документах или Google Fonts с учетом регистра. Методы get Font Family() и set Font Family(fontFamilyName) теперь используют строковые имена для шрифтов вместо перечисления Font Family . Хотя это перечисление устарело, оно останется доступным для совместимости со старыми скриптами.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font of the first 16 characters to Impact.
const text = body.editAsText().setFontFamily(0, 15, 'Impact');

// Gets the font family of the 16th character in the tab body.
const fontFamily = text.getFontFamily(15);

// Logs the font family to the console.
console.log(fontFamily);

Параметры

Имя Тип Описание
offset Integer Смещение символов.

Возвращаться

String — Семейство шрифтов.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Font Size()

Получает настройку размера шрифта.

Возвращаться

Number — размер шрифта или значение NULL, если элемент содержит несколько значений для этого атрибута.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Font Size(offset)

Получает размер шрифта по указанному смещению символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font size of the first 13 characters to 15.
const text = body.editAsText().setFontSize(0, 12, 15);

// Gets the font size of the first character.
const fontSize = text.getFontSize(0);

// Logs the font size to the console.
console.log(fontSize);

Параметры

Имя Тип Описание
offset Integer Смещение символов.

Возвращаться

Number — Размер шрифта.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Foreground Color()

Получает настройку цвета переднего плана.

Возвращаться

String — цвет переднего плана, отформатированный в нотации CSS (например '#ffffff' ), или значение NULL, если элемент содержит несколько значений для этого атрибута.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Foreground Color(offset)

Получает цвет переднего плана по указанному смещению символа.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the foreground color of the first 3 characters in the tab body.
const text = body.editAsText().setForegroundColor(0, 2, '#0000FF');

// Gets the foreground color of the first character in the tab body.
const foregroundColor = text.getForegroundColor(0);

// Logs the foreground color to the console.
console.log(foregroundColor);

Параметры

Имя Тип Описание
offset Integer Смещение символов.

Возвращаться

String — цвет переднего плана, отформатированный в нотации CSS (например '#ffffff' ).

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Link Url()

Получает URL-адрес ссылки.

Возвращаться

String — URL-адрес ссылки или значение NULL, если элемент содержит несколько значений для этого атрибута.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Link Url(offset)

Получает URL-адрес ссылки по указанному смещению символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Applies a link to the first 10 characters in the body.
const text = body.editAsText().setLinkUrl(0, 9, 'https://www.example.com/');

// Gets the URL of the link from the first character.
const link = text.getLinkUrl(0);

// Logs the link URL to the console.
console.log(link);

Параметры

Имя Тип Описание
offset Integer Смещение символов.

Возвращаться

String — URL-адрес ссылки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Next Sibling()

Извлекает следующий родственный элемент элемента.

Следующий брат имеет того же родителя и следует за текущим элементом.

Возвращаться

Element — следующий родственный элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Parent()

Извлекает родительский элемент элемента.

Родительский элемент содержит текущий элемент.

Возвращаться

Container Element — родительский элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Previous Sibling()

Извлекает предыдущий родственный элемент элемента.

Предыдущий одноуровневый элемент имеет того же родителя и предшествует текущему элементу.

Возвращаться

Element — предыдущий родственный элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Text()

Извлекает содержимое элемента в виде текстовой строки.

Возвращаться

String — содержимое элемента в виде текстовой строки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Text Alignment()

Получает выравнивание текста. Доступными типами выравнивания являются Document App.TextAlignment.NORMAL , Document App.TextAlignment.SUBSCRIPT и Document App.TextAlignment.SUPERSCRIPT .

Возвращаться

Text Alignment — тип выравнивания текста или null , если текст содержит несколько типов выравнивания текста или если выравнивание текста никогда не устанавливалось.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Text Alignment(offset)

Получает выравнивание текста для одного символа. Доступными типами выравнивания являются Document App.TextAlignment.NORMAL , Document App.TextAlignment.SUBSCRIPT и Document App.TextAlignment.SUPERSCRIPT .

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the text alignment of the tab's body to NORMAL.
const text =
    body.editAsText().setTextAlignment(DocumentApp.TextAlignment.NORMAL);

// Gets the text alignment of the ninth character.
const alignment = text.getTextAlignment(8);

// Logs the text alignment to the console.
console.log(alignment.toString());

Параметры

Имя Тип Описание
offset Integer Смещение персонажа.

Возвращаться

Text Alignment — тип выравнивания текста или null , если выравнивание текста никогда не задавалось.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Text Attribute Indices()

Извлекает набор текстовых индексов, которые соответствуют началу отдельных запусков форматирования текста.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the text indices at which text formatting changes.
const indices = body.editAsText().getTextAttributeIndices();

// Logs the indices to the console.
console.log(indices.toString());

Возвращаться

Integer[] — Набор текстовых индексов, при которых изменяется форматирование текста.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Type()

Получает Element Type элемента.

Используйте get Type() чтобы определить точный тип данного элемента.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Возвращаться

Element Type — Тип элемента.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insert Text(offset, text)

Вставляет указанный текст по заданному смещению символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Inserts the text, 'Sample inserted text', at the start of the body content.
const text = body.editAsText().insertText(0, 'Sample inserted text');

Параметры

Имя Тип Описание
offset Integer Смещение символа, по которому вставляется текст.
text String Текст для вставки.

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

is At Document End()

Определяет, находится ли элемент в конце Document .

Возвращаться

Boolean — находится ли элемент в конце вкладки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

is Bold()

Возвращает выделенный жирным шрифтом параметр.

Возвращаться

Boolean — выделен ли текст полужирным шрифтом или имеет значение null, если элемент содержит несколько значений для этого атрибута.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

is Bold(offset)

Извлекает настройку полужирного шрифта по указанному смещению символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Bolds the first 4 characters in the tab body.
const text = body.editAsText().setBold(0, 3, true);

// Gets whether or not the text is bold.
const bold = text.editAsText().isBold(0);

// Logs the text's bold setting to the console
console.log(bold);

Параметры

Имя Тип Описание
offset Integer Смещение символов.

Возвращаться

Boolean — жирный шрифт.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

is Italic()

Получает настройку курсива.

Возвращаться

Boolean — выделен ли текст курсивом или имеет значение null, если элемент содержит несколько значений для этого атрибута.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

is Italic(offset)

Извлекает настройку курсива по указанному смещению символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 13 characters of the tab body to italic.
const text = body.editAsText().setItalic(0, 12, true);

// Gets whether the fifth character in the tab body is set to
// italic and logs it to the console.
const italic = text.isItalic(4);
console.log(italic);

Параметры

Имя Тип Описание
offset Integer Смещение символов.

Возвращаться

Boolean — курсив.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

is Strikethrough()

Получает настройку зачеркивания.

Возвращаться

Boolean — зачеркнут ли текст или имеет значение null, если элемент содержит несколько значений для этого атрибута.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

is Strikethrough(offset)

Извлекает настройку зачеркивания по указанному смещению символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 17 characters of the tab body to strikethrough.
const text = body.editAsText().setStrikethrough(0, 16, true);

// Gets whether the first character in the tab body is set to
// strikethrough and logs it to the console.
const strikethrough = text.isStrikethrough(0);
console.log(strikethrough);

Параметры

Имя Тип Описание
offset Integer Смещение символов.

Возвращаться

Boolean — настройка зачеркивания.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

is Underline()

Получает настройку подчеркивания.

Возвращаться

Boolean — подчеркнут ли текст или имеет значение null, если элемент содержит несколько значений для этого атрибута.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

is Underline(offset)

Извлекает настройку подчеркивания по указанному смещению символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 13 characters of the tab body to underline.
const text = body.editAsText().setUnderline(0, 12, false);

// Gets whether the first character in the tab body is set to
// underline and logs it to the console
const underline = text.editAsText().isUnderline(0);
console.log(underline);

Параметры

Имя Тип Описание
offset Integer Смещение символов.

Возвращаться

Boolean — настройка подчеркивания.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

merge()

Объединяет элемент с предыдущим одноуровневым элементом того же типа.

Объединять можно только элементы одного и того же Element Type . Любые дочерние элементы, содержащиеся в текущем элементе, перемещаются в предыдущий родственный элемент.

Текущий элемент удаляется из документа.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Возвращаться

Text — объединенный элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

remove From Parent()

Удаляет элемент из его родителя.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Возвращаться

Text — удаленный элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

replace Text(searchPattern, replacement)

Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.

Шаблон поиска передается как строка, а не как объект регулярного выражения JavaScript. По этой причине вам необходимо избегать любых обратных косых черт в шаблоне.

В этом методе используется библиотека регулярных выражений Google RE2 , что ограничивает поддерживаемый синтаксис .

Предоставленный шаблон регулярного выражения независимо сопоставляется с каждым текстовым блоком, содержащимся в текущем элементе.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText('^.*Apps ?Script.*$', 'Apps Script');

Параметры

Имя Тип Описание
search Pattern String шаблон регулярного выражения для поиска
replacement String текст, который будет использоваться в качестве замены

Возвращаться

Element — текущий элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Attributes(startOffset, endOffsetInclusive, attributes)

Применяет указанные атрибуты к заданному диапазону символов.

Указанный параметр атрибутов должен быть объектом, в котором каждое имя свойства является элементом перечисления Document App.Attribute , а каждое значение свойства — новым применяемым значением.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Declares style attributes for font size and font family.
const style = {};
style[DocumentApp.Attribute.FONT_SIZE] = 20;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Impact';

// Sets the style attributes to the first 9 characters in the tab's body.
const text = body.setAttributes(0, 8, style);

Параметры

Имя Тип Описание
start Offset Integer Смещение начала текстового диапазона.
end Offset Inclusive Integer Смещение конца текстового диапазона.
attributes Object Атрибуты элемента.

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Attributes(attributes)

Устанавливает атрибуты элемента.

Указанный параметр атрибутов должен быть объектом, в котором каждое имя свойства является элементом перечисления Document App.Attribute , а каждое значение свойства — новым применяемым значением.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Параметры

Имя Тип Описание
attributes Object Атрибуты элемента.

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Background Color(startOffset, endOffsetInclusive, color)

Устанавливает цвет фона для указанного диапазона символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the background color of the first 3 characters in the
// tab body to hex color #0000FF.
const text = body.editAsText().setBackgroundColor(0, 2, '#0000FF');

Параметры

Имя Тип Описание
start Offset Integer Смещение начала текстового диапазона.
end Offset Inclusive Integer Смещение конца текстового диапазона.
color String Цвет фона, отформатированный в нотации CSS (например, '#ffffff' ).

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Background Color(color)

Устанавливает цвет фона.

Параметры

Имя Тип Описание
color String цвет фона, отформатированный в нотации CSS (например '#ffffff' )

Возвращаться

Text — текущий элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Bold(bold)

Устанавливает жирный шрифт.

Параметры

Имя Тип Описание
bold Boolean смелая настройка

Возвращаться

Text — текущий элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Bold(startOffset, endOffsetInclusive, bold)

Устанавливает настройку жирного шрифта для указанного диапазона символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to bold.
const text = body.editAsText().setBold(0, 10, true);

Параметры

Имя Тип Описание
start Offset Integer Смещение начала текстового диапазона.
end Offset Inclusive Integer Смещение конца текстового диапазона.
bold Boolean Смелая постановка.

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Font Family(startOffset, endOffsetInclusive, fontFamilyName)

Устанавливает семейство шрифтов для указанного диапазона символов. Имя может быть любым шрифтом из меню «Шрифт» в Документах или Google Fonts с учетом регистра. Нераспознанные имена шрифтов будут отображаться как Arial. Методы get Font Family(offset) и set Font Family(fontFamilyName) теперь используют строковые имена для шрифтов вместо перечисления Font Family . Хотя это перечисление устарело, оно останется доступным для совместимости со старыми сценариями.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font of the first 4 characters in the tab's body to Roboto.
const text = body.editAsText().setFontFamily(0, 3, 'Roboto');

Параметры

Имя Тип Описание
start Offset Integer Смещение начала текстового диапазона.
end Offset Inclusive Integer Смещение конца текстового диапазона.
font Family Name String Название семейства шрифтов из меню «Шрифт» в Документах или Google Fonts.

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Font Family(fontFamilyName)

Устанавливает семейство шрифтов. Имя может быть любым шрифтом из меню «Шрифт» в Документах или Google Fonts с учетом регистра. Нераспознанные имена шрифтов будут отображаться как Arial. Методы get Font Family() и set Font Family(fontFamilyName) теперь используют строковые имена для шрифтов вместо перечисления Font Family . Хотя это перечисление устарело, оно останется доступным для совместимости со старыми скриптами.

Параметры

Имя Тип Описание
font Family Name String название семейства шрифтов из меню «Шрифт» в Документах или Google Fonts.

Возвращаться

Text — текущий элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Font Size(startOffset, endOffsetInclusive, size)

Устанавливает размер шрифта для указанного диапазона символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the size of the first 11 characters in the tab's body to 12.
const text = body.editAsText().setFontSize(0, 10, 12);

Параметры

Имя Тип Описание
start Offset Integer Смещение начала текстового диапазона.
end Offset Inclusive Integer Смещение конца текстового диапазона.
size Number Размер шрифта.

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Font Size(size)

Устанавливает размер шрифта.

Параметры

Имя Тип Описание
size Number размер шрифта

Возвращаться

Text — текущий элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Foreground Color(startOffset, endOffsetInclusive, color)

Устанавливает цвет переднего плана для указанного диапазона символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the foreground color of the first 2 characters in the
// tab's body to hex color #FF0000.
const text = body.editAsText().setForegroundColor(0, 1, '#FF0000');

// Gets the foreground color for the second character in the tab's body.
const foregroundColor = text.getForegroundColor(1);

//  Logs the foreground color to the console.
console.log(foregroundColor);

Параметры

Имя Тип Описание
start Offset Integer Смещение начала текстового диапазона.
end Offset Inclusive Integer Смещение конца текстового диапазона.
color String Цвет переднего плана, отформатированный в нотации CSS (например, '#ffffff' ).

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Foreground Color(color)

Устанавливает цвет переднего плана.

Параметры

Имя Тип Описание
color String цвет переднего плана, отформатированный в нотации CSS (например, '#ffffff' )

Возвращаться

Text — текущий элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Italic(italic)

Устанавливает курсив.

Параметры

Имя Тип Описание
italic Boolean курсив

Возвращаться

Text — текущий элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Italic(startOffset, endOffsetInclusive, italic)

Устанавливает курсив для указанного диапазона символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to italic.
const text = body.editAsText().setItalic(0, 10, true);

Параметры

Имя Тип Описание
start Offset Integer Смещение начала текстового диапазона.
end Offset Inclusive Integer Смещение конца текстового диапазона.
italic Boolean Курсив.

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Link Url(startOffset, endOffsetInclusive, url)

Устанавливает URL-адрес ссылки для указанного диапазона символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Applies a link to the first 11 characters in the body.
const text = body.editAsText().setLinkUrl(0, 10, 'https://example.com');

Параметры

Имя Тип Описание
start Offset Integer Смещение начала текстового диапазона.
end Offset Inclusive Integer Смещение конца текстового диапазона.
url String URL-адрес ссылки.

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Link Url(url)

Устанавливает URL-адрес ссылки.

Параметры

Имя Тип Описание
url String URL-адрес ссылки

Возвращаться

Text — текущий элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Strikethrough(strikethrough)

Устанавливает настройку зачеркивания.

Параметры

Имя Тип Описание
strikethrough Boolean настройка зачеркивания

Возвращаться

Text — текущий элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Strikethrough(startOffset, endOffsetInclusive, strikethrough)

Устанавливает настройку зачеркивания для указанного диапазона символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to strikethrough.
const text = body.editAsText().setStrikethrough(0, 10, true);

Параметры

Имя Тип Описание
start Offset Integer Смещение начала текстового диапазона.
end Offset Inclusive Integer Смещение конца текстового диапазона.
strikethrough Boolean Настройка зачеркивания.

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Text(text)

Устанавливает текстовое содержимое.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Replaces the contents of the body with the text, 'New body text.'
const text = body.editAsText().setText('New body text.');

Параметры

Имя Тип Описание
text String Новое текстовое содержание.

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Text Alignment(startOffset, endOffsetInclusive, textAlignment)

Устанавливает выравнивание текста для заданного диапазона символов. Доступными типами выравнивания являются Document App.TextAlignment.NORMAL , Document App.TextAlignment.SUBSCRIPT и Document App.TextAlignment.SUPERSCRIPT .

// Make the first character in the first paragraph of the active tab be
// superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(0, 0, DocumentApp.TextAlignment.SUPERSCRIPT);

Параметры

Имя Тип Описание
start Offset Integer Начальное смещение диапазона символов.
end Offset Inclusive Integer Конечное смещение диапазона символов (включительно).
text Alignment Text Alignment Тип выравнивания текста, который необходимо применить.

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Text Alignment(textAlignment)

Устанавливает выравнивание текста. Доступными типами выравнивания являются Document App.TextAlignment.NORMAL , Document App.TextAlignment.SUBSCRIPT и Document App.TextAlignment.SUPERSCRIPT .

// Make the entire first paragraph in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Параметры

Имя Тип Описание
text Alignment Text Alignment тип выравнивания текста, который нужно применить

Возвращаться

Text — текущий элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Underline(underline)

Устанавливает настройку подчеркивания.

Параметры

Имя Тип Описание
underline Boolean настройка подчеркивания

Возвращаться

Text — текущий элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Underline(startOffset, endOffsetInclusive, underline)

Устанавливает настройку подчеркивания для указанного диапазона символов.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to underline.
const text = body.editAsText().setUnderline(0, 10, true);

Параметры

Имя Тип Описание
start Offset Integer Смещение начала текстового диапазона.
end Offset Inclusive Integer Смещение конца текстового диапазона.
underline Boolean Настройка подчеркивания.

Возвращаться

Text — текущий элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents