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 |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Attributes(offset) Object Извлекает атрибуты по указанному смещению символов.
get Background Color() String|null Получает настройки цвета фона.
get Background Color(offset) String|null Получает цвет фона с указанным смещением символа.
get Font Family() String|null Получает настройки семейства шрифтов.
get Font Family(offset) String|null Получает название семейства шрифтов по указанному смещению символа.
get Font Size() Number|null Получает настройку размера шрифта.
get Font Size(offset) Number|null Извлекает размер шрифта с указанным смещением символа.
get Foreground Color() String|null Получает настройки цвета переднего плана.
get Foreground Color(offset) String|null Получает цвет переднего плана с указанным смещением символа.
get Link Url() String|null Получает URL-адрес ссылки.
get Link Url(offset) String|null Получает URL-адрес ссылки по указанному смещению символов.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Text Alignment(offset) Text Alignment |null Выводит выравнивание текста для отдельного символа.
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|null Извлекает выделенный жирным шрифтом параметр.
is Bold(offset) Boolean|null Извлекает значение жирного шрифта по указанному смещению символа.
is Italic() Boolean|null Извлекает настройки курсива.
is Italic(offset) Boolean|null Извлекает настройку курсива по указанному смещению символа.
is Strikethrough() Boolean|null Извлекает параметр зачеркивания.
is Strikethrough(offset) Boolean|null Извлекает параметр зачеркивания по указанному смещению символа.
is Underline() Boolean|null Извлекает настройку подчеркивания.
is Underline(offset) Boolean|null Извлекает параметр подчеркивания по указанному смещению символа.
merge() Text |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove From Parent() Text |null Удаляет элемент из родительского элемента.
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 — результат поиска, указывающий позицию искомого текста, или 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 |null — результат поиска, указывающий следующую позицию искомого текста, или null, если совпадений нет.

Авторизация

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

  • 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|null — цвет фона, отформатированный в 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|null — Цвет фона, заданный в формате CSS (например '#ffffff' ).

Авторизация

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

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

get Font Family()

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

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

String|null — название семейства шрифтов, или 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|null — Семейство шрифтов.

Авторизация

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

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

get Font Size()

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

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

Number|null — размер шрифта, или 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|null — Размер шрифта.

Авторизация

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

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

get Foreground Color()

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

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

String|null — цвет переднего плана, отформатированный в 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|null — Цвет переднего плана, отформатированный в соответствии с CSS-нотацией (например '#ffffff' ).

Авторизация

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

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

get Link Url()

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

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

String|null — 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|null — URL ссылки.

Авторизация

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

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

get Next Sibling()

Получает следующий соседний элемент.

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

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

Element |null — Следующий соседний элемент.

Авторизация

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

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

get Parent()

Получает родительский элемент элемента.

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

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

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

Авторизация

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

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

get Previous Sibling()

Получает предыдущий соседний элемент.

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

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

Element |null — Предыдущий соседний элемент.

Авторизация

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

  • 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 — тип выравнивания текста, или 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 — Тип выравнивания текста или 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 — указывает, выделен ли текст жирным шрифтом, или 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|null — Выбор жирного шрифта.

Авторизация

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

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

is Italic()

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

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

Boolean|null — указывает, является ли текст курсивом, или 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|null — Курсивное написание.

Авторизация

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

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

is Strikethrough()

Извлекает параметр зачеркивания.

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

Boolean|null — указывает, является ли текст зачеркнутым, или 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|null — Параметр "Зачеркивание".

Авторизация

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

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

is Underline()

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

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

Boolean|null — указывает, подчеркнут ли текст, или 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|null — Параметр подчеркивания.

Авторизация

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

  • 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 |null — Объединенный элемент.

Авторизация

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

  • 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 |null — Удалённый элемент.

Авторизация

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

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

replace Text(searchPattern, replacement)

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

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

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

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

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)

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

Указанный параметр 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)

Задает атрибуты элемента.

Указанный параметр 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)

Задает семейство шрифтов. Название может быть любым шрифтом из меню «Шрифты» в Docs или 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