Document Service

Документ

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

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID');

// Create and open a document.
doc = DocumentApp.create('Document Name');

Классы

Имя Краткое описание
Attribute Перечисление атрибутов элемента.
Body Содержимое вкладки в документе Google Docs.
Bookmark Объект, представляющий закладку.
ContainerElement Общий элемент, который может содержать другие элементы.
Date Элемент, представляющий форматированную дату
Document Документ, содержащий один или несколько объектов Tab , каждый из которых содержит форматированный текст и такие элементы, как таблицы и списки.
DocumentApp Служба документов создает и открывает Documents , которые можно редактировать.
DocumentTab Вкладка документа, содержащая форматированный текст и такие элементы, как таблицы и списки.
Element Общий элемент.
ElementType Перечисление всех типов элементов.
Equation Элемент, представляющий математическое выражение.
EquationFunction Элемент, представляющий функцию в математическом Equation .
EquationFunctionArgumentSeparator Элемент, представляющий разделитель функций в математическом Equation .
EquationSymbol Элемент, представляющий символ в математическом Equation .
FontFamily Перечень поддерживаемых шрифтов.
FooterSection Элемент, представляющий раздел нижнего колонтитула.
Footnote Элемент, представляющий сноску.
FootnoteSection Элемент, представляющий раздел сноски.
GlyphType Перечисление поддерживаемых типов глифов.
HeaderSection Элемент, представляющий раздел заголовка.
HorizontalAlignment Перечисление поддерживаемых типов горизонтального выравнивания.
HorizontalRule Элемент, представляющий горизонтальную линейку.
InlineDrawing Элемент, представляющий встроенный рисунок.
InlineImage Элемент, представляющий внедренное изображение.
ListItem Элемент, представляющий элемент списка.
NamedRange Range , имеющий имя и идентификатор, позволяющий его позднее получить.
PageBreak Элемент, представляющий разрыв страницы.
Paragraph Элемент, представляющий абзац.
ParagraphHeading Перечисление стандартных заголовков абзацев.
Person Элемент, представляющий ссылку на человека.
Position Ссылка на местоположение на вкладке документа относительно определенного элемента.
PositionedImage Изображение с фиксированной позицией, привязанное к Paragraph .
PositionedLayout Перечисление, указывающее, как расположить PositionedImage относительно окружающего текста.
Range Диапазон элементов в документе.
RangeBuilder Построитель, используемый для создания объектов Range из элементов документа.
RangeElement Обертка вокруг Element с возможным смещением начала и конца.
RichLink Элемент, представляющий ссылку на ресурс Google, например файл на Диске или видео YouTube.
Tab Вкладка в документе Google Docs.
TabType Перечисление всех типов вкладок.
Table Элемент, представляющий таблицу.
TableCell Элемент, представляющий ячейку таблицы.
TableOfContents Элемент, содержащий оглавление.
TableRow Элемент, представляющий строку таблицы.
Text Элемент, представляющий область форматированного текста.
TextAlignment Перечисление типов выравнивания текста.
UnsupportedElement Элемент, представляющий регион, который неизвестен или не может быть затронут сценарием, например номер страницы.
VerticalAlignment Перечисление поддерживаемых типов вертикального выравнивания.

Attribute

Характеристики

Свойство Тип Описание
BACKGROUND_COLOR Enum Цвет фона элемента (абзаца, таблицы и т. д.) или документа.
BOLD Enum Настройка толщины шрифта для форматированного текста.
BORDER_COLOR Enum Цвет границы для элементов таблицы.
BORDER_WIDTH Enum Ширина границы в пунктах для элементов таблицы.
CODE Enum Содержимое кода для элементов уравнения.
FONT_FAMILY Enum Настройка семейства шрифтов для форматированного текста.
FONT_SIZE Enum Настройка размера шрифта в пунктах для форматированного текста.
FOREGROUND_COLOR Enum Настройка цвета переднего плана для форматированного текста.
HEADING Enum Тип заголовка для элементов абзаца (например, DocumentApp.ParagraphHeading.HEADING1 ).
HEIGHT Enum Настройка высоты для элементов изображения.
HORIZONTAL_ALIGNMENT Enum Горизонтальное выравнивание для элементов абзаца (например, DocumentApp.HorizontalAlignment.CENTER ).
INDENT_END Enum Настройка конечного отступа для элементов абзаца в пунктах.
INDENT_FIRST_LINE Enum Настройка отступа первой строки в пунктах для элементов абзаца.
INDENT_START Enum Начальный отступ в пунктах для элементов абзаца.
ITALIC Enum Настройка стиля шрифта для форматированного текста.
GLYPH_TYPE Enum Тип глифа для элементов элемента списка.
LEFT_TO_RIGHT Enum Настройка направления текста для форматированного текста.
LINE_SPACING Enum Параметр межстрочного интервала в качестве множителя для элементов абзаца.
LINK_URL Enum URL-адрес ссылки для форматированного текста.
LIST_ID Enum Идентификатор охватывающего списка для элементов списка.
MARGIN_BOTTOM Enum Настройка нижнего поля в пунктах для элементов абзаца.
MARGIN_LEFT Enum Настройка левого поля в пунктах для элементов абзаца.
MARGIN_RIGHT Enum Настройка правого поля в пунктах для элементов абзаца.
MARGIN_TOP Enum Настройка верхнего поля в пунктах для элементов абзаца.
NESTING_LEVEL Enum Уровень вложенности элементов для элементов списка.
MINIMUM_HEIGHT Enum Минимальная настройка высоты в пунктах для элементов строки таблицы.
PADDING_BOTTOM Enum Настройка нижнего заполнения в пунктах для элементов ячейки таблицы.
PADDING_LEFT Enum Настройка левого заполнения в пунктах для элементов ячейки таблицы.
PADDING_RIGHT Enum Правильная настройка заполнения в пунктах для элементов ячейки таблицы.
PADDING_TOP Enum Настройка верхнего заполнения в пунктах для элементов ячейки таблицы.
PAGE_HEIGHT Enum Настройка высоты страницы в пунктах для документов.
PAGE_WIDTH Enum Настройка ширины страницы в пунктах для документов.
SPACING_AFTER Enum Настройка нижнего интервала в пунктах для элементов абзаца.
SPACING_BEFORE Enum Настройка верхнего интервала в пунктах для элементов абзаца.
STRIKETHROUGH Enum Настройка зачеркивания для форматированного текста.
UNDERLINE Enum Настройка подчеркивания для форматированного текста.
VERTICAL_ALIGNMENT Enum Настройка вертикального выравнивания для элементов ячеек таблицы.
WIDTH Enum Настройка ширины для ячеек таблицы и элементов изображения.

Body

Методы

Метод Тип возврата Краткое описание
appendHorizontalRule() HorizontalRule Создает и добавляет новый HorizontalRule .
appendImage(image) InlineImage Создает и добавляет новый InlineImage из указанного BLOB-объекта изображения.
appendImage(image) InlineImage Добавляет заданный InlineImage .
appendListItem(listItem) ListItem Добавляет данный ListItem .
appendListItem(text) ListItem Создает и добавляет новый ListItem содержащий указанное текстовое содержимое.
appendPageBreak() PageBreak Создает и добавляет новый PageBreak .
appendPageBreak(pageBreak) PageBreak Добавляет заданный PageBreak .
appendParagraph(paragraph) Paragraph Добавляет данный Paragraph .
appendParagraph(text) Paragraph Создает и добавляет новый Paragraph , содержащий указанное текстовое содержимое.
appendTable() Table Создает и добавляет новую Table .
appendTable(cells) Table Добавляет новую Table , содержащую TableCell для каждого указанного строкового значения.
appendTable(table) Table Добавляет данную Table .
clear() Body Очищает содержимое элемента.
copy() Body Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAttributes() Object Получает атрибуты элемента.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getHeadingAttributes(paragraphHeading) Object Получает набор атрибутов для предоставленного ParagraphHeading .
getImages() InlineImage[] Извлекает все InlineImages содержащиеся в разделе.
getListItems() ListItem[] Извлекает все ListItems содержащиеся в разделе.
getMarginBottom() Number Получает нижнее поле в пунктах.
getMarginLeft() Number Получает левое поле в пунктах.
getMarginRight() Number Получает правое поле.
getMarginTop() Number Получает верхнее поле.
getNumChildren() Integer Получает количество детей.
getPageHeight() Number Получает высоту страницы в пунктах.
getPageWidth() Number Получает ширину страницы в пунктах.
getParagraphs() Paragraph[] Извлекает все Paragraphs содержащиеся в разделе (включая ListItems ).
getParent() ContainerElement Извлекает родительский элемент элемента.
getTables() Table[] Извлекает все Tables содержащиеся в разделе.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
insertHorizontalRule(childIndex) HorizontalRule Создает и вставляет новое HorizontalRule по указанному индексу.
insertImage(childIndex, image) InlineImage Создает и вставляет InlineImage из указанного большого двоичного объекта изображения по указанному индексу.
insertImage(childIndex, image) InlineImage Вставляет заданный InlineImage по указанному индексу.
insertListItem(childIndex, listItem) ListItem Вставляет заданный ListItem по указанному индексу.
insertListItem(childIndex, text) ListItem Создает и вставляет новый ListItem по указанному индексу, содержащий указанное текстовое содержимое.
insertPageBreak(childIndex) PageBreak Создает и вставляет новый PageBreak по указанному индексу.
insertPageBreak(childIndex, pageBreak) PageBreak Вставляет заданный PageBreak по указанному индексу.
insertParagraph(childIndex, paragraph) Paragraph Вставляет данный Paragraph по указанному индексу.
insertParagraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.
insertTable(childIndex) Table Создает и вставляет новую Table по указанному индексу.
insertTable(childIndex, cells) Table Создает и вставляет новую Table , содержащую указанные ячейки, по указанному индексу.
insertTable(childIndex, table) Table Вставляет данную Table по указанному индексу.
removeChild(child) Body Удаляет указанный дочерний элемент.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(attributes) Body Устанавливает атрибуты элемента.
setHeadingAttributes(paragraphHeading, attributes) Body Устанавливает атрибуты для предоставленного ParagraphHeading .
setMarginBottom(marginBottom) Body Устанавливает нижнее поле в пунктах.
setMarginLeft(marginLeft) Body Устанавливает левое поле в пунктах.
setMarginRight(marginRight) Body Устанавливает правое поле в пунктах.
setMarginTop(marginTop) Body Устанавливает верхнее поле.
setPageHeight(pageHeight) Body Устанавливает высоту страницы в пунктах.
setPageWidth(pageWidth) Body Устанавливает ширину страницы в пунктах.
setText(text) Body Устанавливает содержимое в виде обычного текста.
setTextAlignment(textAlignment) Body Устанавливает выравнивание текста.

Bookmark

Методы

Метод Тип возврата Краткое описание
getId() String Получает идентификатор Bookmark .
getPosition() Position Получает Position Bookmark на DocumentTab .
remove() void Удаляет Bookmark .

ContainerElement

Методы

Метод Тип возврата Краткое описание
asBody() Body Возвращает текущий элемент как Body .
asEquation() Equation Возвращает текущий элемент как Equation .
asFooterSection() FooterSection Возвращает текущий элемент как FooterSection .
asFootnoteSection() FootnoteSection Возвращает текущий элемент как FootnoteSection .
asHeaderSection() HeaderSection Возвращает текущий элемент как HeaderSection .
asListItem() ListItem Возвращает текущий элемент как ListItem .
asParagraph() Paragraph Возвращает текущий элемент как Paragraph .
asTable() Table Возвращает текущий элемент в виде Table .
asTableCell() TableCell Возвращает текущий элемент как TableCell .
asTableOfContents() TableOfContents Возвращает текущий элемент как TableOfContents .
asTableRow() TableRow Возвращает текущий элемент как TableRow .
clear() ContainerElement Очищает содержимое элемента.
copy() ContainerElement Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAttributes() Object Получает атрибуты элемента.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getLinkUrl() String Получает URL-адрес ссылки.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getNumChildren() Integer Получает количество детей.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() ContainerElement Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() ContainerElement Удаляет элемент из его родителя.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(attributes) ContainerElement Устанавливает атрибуты элемента.
setLinkUrl(url) ContainerElement Устанавливает URL-адрес ссылки.
setTextAlignment(textAlignment) ContainerElement Устанавливает выравнивание текста.

Date

Методы

Метод Тип возврата Краткое описание
copy() Date Возвращает отдельную глубокую копию текущего элемента.
getAttributes() Object Получает атрибуты элемента.
getDisplayText() String Возвращает отображаемое значение, отображаемое в документе.
getLocale() String Возвращает языковой стандарт даты, используемый для отображаемого значения.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getTimestamp() Date Возвращает метку времени, связанную с датой.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() Date Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() Date Удаляет элемент из его родителя.
setAttributes(attributes) Date Устанавливает атрибуты элемента.

Document

Методы класса Document, которые напрямую обращаются к текстовому содержимому и изменяют его, работают либо на активной вкладке (в сценариях , привязанных к определенному документу), либо на первой вкладке (если активная вкладка недоступна). Сценарии, использующие эти методы (например, Document.getBody() ), можно обновить для поддержки вкладок одного из следующих элементов:

  • Используйте первую вкладку: Document.getTabs()[0].asDocumentTab().getBody()
  • Использовать все вкладки: просмотрите дерево вкладок с помощью Document.getTabs() и Tab.getChildTabs() . Для каждой вкладки в дереве вызовите Tab.asDocumentTab().getBody()
  • Использовать выбранную вкладку: Document.getTabs()[Document.getActiveTab().getId()].asDocumentTab().getBody()
    • Примечание. Это вызывает ошибку, если активная вкладка не была установлена ​​сценарием с помощью Document.setActiveTab(tabId)
  • Используйте определенную вкладку: Document.getTab(TAB_ID).asDocumentTab().getBody()

Дополнительную информацию о функции вкладок см. в разделе Работа с вкладками .

Методы

Метод Тип возврата Краткое описание
addBookmark(position) Bookmark Добавляет Bookmark в указанной Position на первую вкладку или, для сценариев, привязанных к документу, на активную вкладку.
addEditor(emailAddress) Document Добавляет данного пользователя в список редакторов Document .
addEditor(user) Document Добавляет данного пользователя в список редакторов Document .
addEditors(emailAddresses) Document Добавляет заданный массив пользователей в список редакторов Document .
addFooter() FooterSection Добавляет раздел нижнего колонтитула, если он не существует, на первую вкладку или, для сценариев, привязанных к документу, на активную вкладку.
addHeader() HeaderSection Добавляет раздел заголовка, если он не существует, на первую вкладку или, для сценариев, привязанных к документу, на активную вкладку.
addNamedRange(name, range) NamedRange Добавляет NamedRange , который представляет собой Range с именем и идентификатором, который можно использовать для последующего извлечения, на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
addViewer(emailAddress) Document Добавляет данного пользователя в список читателей Document .
addViewer(user) Document Добавляет данного пользователя в список читателей Document .
addViewers(emailAddresses) Document Добавляет заданный массив пользователей в список читателей Document .
getActiveTab() Tab Получает активную Tab пользователя в документе.
getAs(contentType) Blob Извлекает текущее содержимое Document в виде большого двоичного объекта указанного типа.
getBlob() Blob Извлекает текущее содержимое Document в виде большого двоичного объекта.
getBody() Body Извлекает Body первой вкладки или, для сценариев, привязанных к документу, DocumentBodySection активной вкладки.
getBookmark(id) Bookmark Получает Bookmark с заданным идентификатором на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
getBookmarks() Bookmark[] Получает все объекты Bookmark на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
getCursor() Position Получает курсор пользователя на активной вкладке.
getEditors() User[] Получает список редакторов этого Document .
getFooter() FooterSection Извлекает раздел нижнего колонтитула первой вкладки или, для сценариев, привязанных к документу, раздел нижнего колонтитула активной вкладки.
getFootnotes() Footnote[] Извлекает все элементы Footnote в теле первой вкладки или, для сценариев, привязанных к документу, в теле активной вкладки.
getHeader() HeaderSection Извлекает раздел заголовка первой вкладки или, для сценариев, привязанных к документу, раздел заголовка активной вкладки.
getId() String Получает уникальный идентификатор документа.
getLanguage() String Получает код языка документа.
getName() String Получает заголовок документа.
getNamedRangeById(id) NamedRange Получает NamedRange с заданным идентификатором на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
getNamedRanges() NamedRange[] Получает все объекты NamedRange на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
getNamedRanges(name) NamedRange[] Получает все объекты NamedRange с заданным именем на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
getSelection() Range Получает выбор пользователя на активной вкладке.
getSupportedLanguageCodes() String[] Получает все коды языков, которые поддерживаются в файлах Документов Google.
getTab(tabId) Tab Получает Tab с указанным идентификатором.
getTabs() Tab[] Получает все невложенные элементы Tab , являющиеся частью документа.
getUrl() String Получает URL-адрес для доступа к текущему документу.
getViewers() User[] Получает список читателей и комментаторов этого Document .
newPosition(element, offset) Position Создает новую Position , которая является ссылкой на местоположение на вкладке относительно определенного элемента на первой вкладке или, для сценариев, привязанных к документу, к активной вкладке.
newRange() RangeBuilder Создает построитель, используемый для создания объектов Range из элементов вкладки на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
removeEditor(emailAddress) Document Удаляет данного пользователя из списка редакторов Document .
removeEditor(user) Document Удаляет данного пользователя из списка редакторов Document .
removeViewer(emailAddress) Document Удаляет данного пользователя из списка читателей и комментаторов Document .
removeViewer(user) Document Удаляет данного пользователя из списка читателей и комментаторов Document .
saveAndClose() void Сохраняет текущий Document .
setActiveTab(tabId) void Устанавливает выбранную пользователем Tab в текущем документе на вкладку с указанным идентификатором.
setCursor(position) Document Устанавливает курсор пользователя по заданной Position .
setLanguage(languageCode) Document Устанавливает код языка документа.
setName(name) Document Устанавливает заголовок документа.
setSelection(range) Document Устанавливает выбор пользователя на активной вкладке с заданным Range .

DocumentApp

Характеристики

Свойство Тип Описание
Attribute Attribute Перечисление Attribute .
ElementType ElementType Перечисление ElementType .
FontFamily FontFamily Перечисление FontFamily .
GlyphType GlyphType Перечисление GlyphType .
HorizontalAlignment HorizontalAlignment Перечисление HorizontalAlignment .
ParagraphHeading ParagraphHeading Перечисление ParagraphHeading .
PositionedLayout PositionedLayout Перечисление PositionedLayout .
TextAlignment TextAlignment Перечисление TextAlignment .
VerticalAlignment VerticalAlignment Перечисление VerticalAlignment .

Методы

Метод Тип возврата Краткое описание
create(name) Document Создает и возвращает новый документ.
getActiveDocument() Document Возвращает документ, к которому привязан скрипт.
getUi() Ui Возвращает экземпляр среды пользовательского интерфейса документа, который позволяет сценарию добавлять такие функции, как меню, диалоговые окна и боковые панели.
openById(id) Document Возвращает документ с указанным идентификатором.
openByUrl(url) Document Открывает и возвращает документ с указанным URL-адресом.

DocumentTab

Методы

Метод Тип возврата Краткое описание
addBookmark(position) Bookmark Добавляет Bookmark в указанную Position .
addFooter() FooterSection Добавляет раздел нижнего колонтитула вкладки, если его нет.
addHeader() HeaderSection Добавляет раздел заголовка вкладки, если его нет.
addNamedRange(name, range) NamedRange Добавляет NamedRange , который представляет собой Range с именем и идентификатором, который можно использовать для последующего извлечения.
getBody() Body Получает Body вкладки.
getBookmark(id) Bookmark Получает Bookmark с заданным идентификатором.
getBookmarks() Bookmark[] Получает все объекты Bookmark на вкладке.
getFooter() FooterSection Извлекает нижний колонтитул вкладки, если он существует.
getFootnotes() Footnote[] Извлекает все элементы Footnote в теле вкладки.
getHeader() HeaderSection Получает раздел заголовка вкладки, если он существует.
getNamedRangeById(id) NamedRange Получает NamedRange с заданным идентификатором.
getNamedRanges() NamedRange[] Получает все объекты NamedRange на вкладке.
getNamedRanges(name) NamedRange[] Получает все объекты NamedRange на вкладке с заданным именем.
newPosition(element, offset) Position Создает новую Position , которая является ссылкой на местоположение на вкладке относительно определенного элемента.
newRange() RangeBuilder Создает построитель, используемый для создания объектов Range из элементов вкладки.

Element

Методы

Метод Тип возврата Краткое описание
asBody() Body Возвращает текущий элемент как Body .
asDate() Date Возвращает текущий элемент как Date .
asEquation() Equation Возвращает текущий элемент как Equation .
asEquationFunction() EquationFunction Возвращает текущий элемент как EquationFunction .
asEquationFunctionArgumentSeparator() EquationFunctionArgumentSeparator Возвращает текущий элемент как EquationFunctionArgumentSeparator .
asEquationSymbol() EquationSymbol Возвращает текущий элемент как EquationSymbol .
asFooterSection() FooterSection Возвращает текущий элемент как FooterSection .
asFootnote() Footnote Возвращает текущий элемент как Footnote .
asFootnoteSection() FootnoteSection Возвращает текущий элемент как FootnoteSection .
asHeaderSection() HeaderSection Возвращает текущий элемент как HeaderSection .
asHorizontalRule() HorizontalRule Возвращает текущий элемент как HorizontalRule .
asInlineDrawing() InlineDrawing Возвращает текущий элемент как InlineDrawing .
asInlineImage() InlineImage Возвращает текущий элемент как InlineImage .
asListItem() ListItem Возвращает текущий элемент как ListItem .
asPageBreak() PageBreak Возвращает текущий элемент как PageBreak .
asParagraph() Paragraph Возвращает текущий элемент как Paragraph .
asPerson() Person Возвращает текущий элемент как Person .
asRichLink() RichLink Возвращает текущий элемент как RichLink , например ссылку на файл Google Sheets.
asTable() Table Возвращает текущий элемент в виде Table .
asTableCell() TableCell Возвращает текущий элемент как TableCell .
asTableOfContents() TableOfContents Возвращает текущий элемент как TableOfContents .
asTableRow() TableRow Возвращает текущий элемент как TableRow .
asText() Text Возвращает текущий элемент как Text .
copy() Element Возвращает отдельную глубокую копию текущего элемента.
getAttributes() Object Получает атрибуты элемента.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() Element Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() Element Удаляет элемент из его родителя.
setAttributes(attributes) Element Устанавливает атрибуты элемента.

ElementType

Характеристики

Свойство Тип Описание
BODY_SECTION Enum Тип, соответствующий элементу Body .
COMMENT_SECTION Enum Тип, соответствующий элементу CommentSection .
DATE Enum Тип, соответствующий элементу Date .
EQUATION Enum Тип, соответствующий элементу Equation .
EQUATION_FUNCTION Enum Тип, соответствующий элементу EquationFunction .
EQUATION_FUNCTION_ARGUMENT_SEPARATOR Enum Тип, соответствующий элементу EquationFunctionArgumentSeparator .
EQUATION_SYMBOL Enum Тип, соответствующий элементу EquationSymbol .
RICH_LINK Enum Тип, соответствующий элементу RichLink .
FOOTER_SECTION Enum Тип, соответствующий элементу FooterSection .
FOOTNOTE Enum Тип, соответствующий элементу Footnote .
FOOTNOTE_SECTION Enum Тип, соответствующий элементу FootnoteSection .
HEADER_SECTION Enum Тип, соответствующий элементу HeaderSection .
HORIZONTAL_RULE Enum Тип, соответствующий элементу HorizontalRule .
INLINE_DRAWING Enum Тип, соответствующий элементу InlineDrawing .
INLINE_IMAGE Enum Тип, соответствующий элементу InlineImage .
LIST_ITEM Enum Тип, соответствующий элементу ListItem .
PAGE_BREAK Enum Тип, соответствующий элементу PageBreak .
PARAGRAPH Enum Тип, соответствующий элементу Paragraph .
PERSON Enum Тип, соответствующий элементу Person .
TABLE Enum Тип, соответствующий элементу Table .
TABLE_CELL Enum Тип, соответствующий элементу TableCell .
TABLE_OF_CONTENTS Enum Тип, соответствующий элементу TableOfContents .
TABLE_ROW Enum Тип, соответствующий элементу TableRow .
TEXT Enum Тип, соответствующий элементу Text .
UNSUPPORTED Enum Тип, соответствующий UnsupportedElement .

Equation

Методы

Метод Тип возврата Краткое описание
clear() Equation Очищает содержимое элемента.
copy() Equation Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAttributes() Object Получает атрибуты элемента.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getLinkUrl() String Получает URL-адрес ссылки.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getNumChildren() Integer Получает количество детей.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() Equation Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() Equation Удаляет элемент из его родителя.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(attributes) Equation Устанавливает атрибуты элемента.
setLinkUrl(url) Equation Устанавливает URL-адрес ссылки.
setTextAlignment(textAlignment) Equation Устанавливает выравнивание текста.

EquationFunction

Методы

Метод Тип возврата Краткое описание
clear() EquationFunction Очищает содержимое элемента.
copy() EquationFunction Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAttributes() Object Получает атрибуты элемента.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getCode() String Получает код, соответствующий функции уравнения.
getLinkUrl() String Получает URL-адрес ссылки.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getNumChildren() Integer Получает количество детей.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() EquationFunction Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() EquationFunction Удаляет элемент из его родителя.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(attributes) EquationFunction Устанавливает атрибуты элемента.
setLinkUrl(url) EquationFunction Устанавливает URL-адрес ссылки.
setTextAlignment(textAlignment) EquationFunction Устанавливает выравнивание текста.

EquationFunctionArgumentSeparator

Методы

Метод Тип возврата Краткое описание
copy() EquationFunctionArgumentSeparator Возвращает отдельную глубокую копию текущего элемента.
getAttributes() Object Получает атрибуты элемента.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() EquationFunctionArgumentSeparator Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() EquationFunctionArgumentSeparator Удаляет элемент из его родителя.
setAttributes(attributes) EquationFunctionArgumentSeparator Устанавливает атрибуты элемента.

EquationSymbol

Методы

Метод Тип возврата Краткое описание
copy() EquationSymbol Возвращает отдельную глубокую копию текущего элемента.
getAttributes() Object Получает атрибуты элемента.
getCode() String Получает код, соответствующий символу уравнения.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() EquationSymbol Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() EquationSymbol Удаляет элемент из его родителя.
setAttributes(attributes) EquationSymbol Устанавливает атрибуты элемента.

FontFamily

FooterSection

Методы

Метод Тип возврата Краткое описание
appendHorizontalRule() HorizontalRule Создает и добавляет новый HorizontalRule .
appendImage(image) InlineImage Создает и добавляет новый InlineImage из указанного BLOB-объекта изображения.
appendImage(image) InlineImage Добавляет заданный InlineImage .
appendListItem(listItem) ListItem Добавляет данный ListItem .
appendListItem(text) ListItem Создает и добавляет новый ListItem содержащий указанное текстовое содержимое.
appendParagraph(paragraph) Paragraph Добавляет данный Paragraph .
appendParagraph(text) Paragraph Создает и добавляет новый Paragraph , содержащий указанное текстовое содержимое.
appendTable() Table Создает и добавляет новую Table .
appendTable(cells) Table Добавляет новую Table , содержащую TableCell для каждого указанного строкового значения.
appendTable(table) Table Добавляет данную Table .
clear() FooterSection Очищает содержимое элемента.
copy() FooterSection Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAttributes() Object Получает атрибуты элемента.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getImages() InlineImage[] Извлекает все InlineImages содержащиеся в разделе.
getListItems() ListItem[] Извлекает все ListItems содержащиеся в разделе.
getNumChildren() Integer Получает количество детей.
getParagraphs() Paragraph[] Извлекает все Paragraphs содержащиеся в разделе (включая ListItems ).
getParent() ContainerElement Извлекает родительский элемент элемента.
getTables() Table[] Извлекает все Tables содержащиеся в разделе.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
insertHorizontalRule(childIndex) HorizontalRule Создает и вставляет новое HorizontalRule по указанному индексу.
insertImage(childIndex, image) InlineImage Создает и вставляет InlineImage из указанного большого двоичного объекта изображения по указанному индексу.
insertImage(childIndex, image) InlineImage Вставляет заданный InlineImage по указанному индексу.
insertListItem(childIndex, listItem) ListItem Вставляет заданный ListItem по указанному индексу.
insertListItem(childIndex, text) ListItem Создает и вставляет новый ListItem по указанному индексу, содержащий указанное текстовое содержимое.
insertParagraph(childIndex, paragraph) Paragraph Вставляет данный Paragraph по указанному индексу.
insertParagraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.
insertTable(childIndex) Table Создает и вставляет новую Table по указанному индексу.
insertTable(childIndex, cells) Table Создает и вставляет новую Table , содержащую указанные ячейки, по указанному индексу.
insertTable(childIndex, table) Table Вставляет данную Table по указанному индексу.
removeChild(child) FooterSection Удаляет указанный дочерний элемент.
removeFromParent() FooterSection Удаляет элемент из его родителя.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(attributes) FooterSection Устанавливает атрибуты элемента.
setText(text) FooterSection Устанавливает содержимое в виде обычного текста.
setTextAlignment(textAlignment) FooterSection Устанавливает выравнивание текста.

Footnote

Методы

Метод Тип возврата Краткое описание
copy() Footnote Возвращает отдельную глубокую копию текущего элемента.
getAttributes() Object Получает атрибуты элемента.
getFootnoteContents() FootnoteSection Получает содержимое элемента сноски.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
removeFromParent() Footnote Удаляет элемент из его родителя.
setAttributes(attributes) Footnote Устанавливает атрибуты элемента.

FootnoteSection

Методы

Метод Тип возврата Краткое описание
appendParagraph(paragraph) Paragraph Добавляет данный Paragraph .
appendParagraph(text) Paragraph Создает и добавляет новый Paragraph , содержащий указанное текстовое содержимое.
clear() FootnoteSection Очищает содержимое элемента.
copy() FootnoteSection Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAttributes() Object Получает атрибуты элемента.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getNumChildren() Integer Получает количество детей.
getParagraphs() Paragraph[] Извлекает все Paragraphs содержащиеся в разделе (включая ListItems ).
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
insertParagraph(childIndex, paragraph) Paragraph Вставляет данный Paragraph по указанному индексу.
insertParagraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.
removeChild(child) FootnoteSection Удаляет указанный дочерний элемент.
removeFromParent() FootnoteSection Удаляет элемент из его родителя.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(attributes) FootnoteSection Устанавливает атрибуты элемента.
setText(text) FootnoteSection Устанавливает содержимое в виде обычного текста.
setTextAlignment(textAlignment) FootnoteSection Устанавливает выравнивание текста.

GlyphType

Характеристики

Свойство Тип Описание
BULLET Enum Пуля по умолчанию, круглая и заполненная.
HOLLOW_BULLET Enum Полая пуля.
SQUARE_BULLET Enum Квадратная пуля.
NUMBER Enum Числовая пуля.
LATIN_UPPER Enum Латинская пуля в верхнем регистре.
LATIN_LOWER Enum Латинская строчная пуля.
ROMAN_UPPER Enum Римская цифра, пуля в верхнем регистре.
ROMAN_LOWER Enum Римская цифра, строчная пуля.

HeaderSection

Методы

Метод Тип возврата Краткое описание
appendHorizontalRule() HorizontalRule Создает и добавляет новый HorizontalRule .
appendImage(image) InlineImage Создает и добавляет новый InlineImage из указанного BLOB-объекта изображения.
appendImage(image) InlineImage Добавляет заданный InlineImage .
appendListItem(listItem) ListItem Добавляет данный ListItem .
appendListItem(text) ListItem Создает и добавляет новый ListItem содержащий указанное текстовое содержимое.
appendParagraph(paragraph) Paragraph Добавляет данный Paragraph .
appendParagraph(text) Paragraph Создает и добавляет новый Paragraph , содержащий указанное текстовое содержимое.
appendTable() Table Создает и добавляет новую Table .
appendTable(cells) Table Добавляет новую Table , содержащую TableCell для каждого указанного строкового значения.
appendTable(table) Table Добавляет данную Table .
clear() HeaderSection Очищает содержимое элемента.
copy() HeaderSection Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAttributes() Object Получает атрибуты элемента.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getImages() InlineImage[] Извлекает все InlineImages содержащиеся в разделе.
getListItems() ListItem[] Извлекает все ListItems содержащиеся в разделе.
getNumChildren() Integer Получает количество детей.
getParagraphs() Paragraph[] Извлекает все Paragraphs содержащиеся в разделе (включая ListItems ).
getParent() ContainerElement Извлекает родительский элемент элемента.
getTables() Table[] Извлекает все Tables содержащиеся в разделе.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
insertHorizontalRule(childIndex) HorizontalRule Создает и вставляет новое HorizontalRule по указанному индексу.
insertImage(childIndex, image) InlineImage Создает и вставляет InlineImage из указанного большого двоичного объекта изображения по указанному индексу.
insertImage(childIndex, image) InlineImage Вставляет заданный InlineImage по указанному индексу.
insertListItem(childIndex, listItem) ListItem Вставляет заданный ListItem по указанному индексу.
insertListItem(childIndex, text) ListItem Создает и вставляет новый ListItem по указанному индексу, содержащий указанное текстовое содержимое.
insertParagraph(childIndex, paragraph) Paragraph Вставляет данный Paragraph по указанному индексу.
insertParagraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.
insertTable(childIndex) Table Создает и вставляет новую Table по указанному индексу.
insertTable(childIndex, cells) Table Создает и вставляет новую Table , содержащую указанные ячейки, по указанному индексу.
insertTable(childIndex, table) Table Вставляет данную Table по указанному индексу.
removeChild(child) HeaderSection Удаляет указанный дочерний элемент.
removeFromParent() HeaderSection Удаляет элемент из его родителя.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(attributes) HeaderSection Устанавливает атрибуты элемента.
setText(text) HeaderSection Устанавливает содержимое в виде обычного текста.
setTextAlignment(textAlignment) HeaderSection Устанавливает выравнивание текста.

HorizontalAlignment

Характеристики

Свойство Тип Описание
LEFT Enum Вариант выравнивания по левому краю.
CENTER Enum Вариант выравнивания по центру.
RIGHT Enum Вариант выравнивания по правому краю.
JUSTIFY Enum Опция выравнивания по ширине.

HorizontalRule

Методы

Метод Тип возврата Краткое описание
copy() HorizontalRule Возвращает отдельную глубокую копию текущего элемента.
getAttributes() Object Получает атрибуты элемента.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
removeFromParent() HorizontalRule Удаляет элемент из его родителя.
setAttributes(attributes) HorizontalRule Устанавливает атрибуты элемента.

InlineDrawing

Методы

Метод Тип возврата Краткое описание
copy() InlineDrawing Возвращает отдельную глубокую копию текущего элемента.
getAltDescription() String Возвращает альтернативное описание рисунка.
getAltTitle() String Возвращает альтернативный заголовок рисунка.
getAttributes() Object Получает атрибуты элемента.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() InlineDrawing Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() InlineDrawing Удаляет элемент из его родителя.
setAltDescription(description) InlineDrawing Устанавливает альтернативное описание чертежа.
setAltTitle(title) InlineDrawing Устанавливает альтернативный заголовок рисунка.
setAttributes(attributes) InlineDrawing Устанавливает атрибуты элемента.

InlineImage

Методы

Метод Тип возврата Краткое описание
copy() InlineImage Возвращает отдельную глубокую копию текущего элемента.
getAltDescription() String Возвращает альтернативное описание изображения.
getAltTitle() String Возвращает альтернативный заголовок изображения.
getAs(contentType) Blob Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
getAttributes() Object Получает атрибуты элемента.
getBlob() Blob Верните данные внутри этого объекта в виде большого двоичного объекта.
getHeight() Integer Получает высоту изображения в пикселях.
getLinkUrl() String Получает URL-адрес ссылки.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getType() ElementType Получает ElementType элемента.
getWidth() Integer Получает ширину изображения в пикселях.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() InlineImage Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() InlineImage Удаляет элемент из его родителя.
setAltDescription(description) InlineImage Устанавливает альтернативное описание изображения.
setAltTitle(title) InlineImage Устанавливает альтернативный заголовок изображения.
setAttributes(attributes) InlineImage Устанавливает атрибуты элемента.
setHeight(height) InlineImage Устанавливает высоту изображения в пикселях.
setLinkUrl(url) InlineImage Устанавливает URL-адрес ссылки.
setWidth(width) InlineImage Устанавливает ширину изображения в пикселях.

ListItem

Методы

Метод Тип возврата Краткое описание
addPositionedImage(image) PositionedImage Создает и вставляет новый PositionedImage из указанного BLOB-объекта изображения.
appendHorizontalRule() HorizontalRule Создает и добавляет новый HorizontalRule .
appendInlineImage(image) InlineImage Создает и добавляет новый InlineImage из указанного BLOB-объекта изображения.
appendInlineImage(image) InlineImage Добавляет заданный InlineImage .
appendPageBreak() PageBreak Создает и добавляет новый PageBreak .
appendPageBreak(pageBreak) PageBreak Добавляет заданный PageBreak .
appendText(text) Text Создает и добавляет новый элемент Text с указанным содержимым.
appendText(text) Text Добавляет заданный элемент Text .
clear() ListItem Очищает содержимое элемента.
copy() ListItem Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAlignment() HorizontalAlignment Получает HorizontalAlignment .
getAttributes() Object Получает атрибуты элемента.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getGlyphType() GlyphType Получает GlyphType элемента списка.
getHeading() ParagraphHeading Получает ParagraphHeading .
getIndentEnd() Number Получает конечный отступ в пунктах.
getIndentFirstLine() Number Получает отступ первой строки в пунктах.
getIndentStart() Number Получает начальный отступ.
getLineSpacing() Number Получает межстрочный интервал в пунктах.
getLinkUrl() String Получает URL-адрес ссылки.
getListId() String Получает идентификатор списка.
getNestingLevel() Integer Получает уровень вложенности элемента списка.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getNumChildren() Integer Получает количество детей.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPositionedImage(id) PositionedImage Получает PositionedImage по идентификатору изображения.
getPositionedImages() PositionedImage[] Получает все объекты PositionedImage , привязанные к абзацу.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getSpacingAfter() Number Получает расстояние после элемента в пунктах.
getSpacingBefore() Number Получает расстояние перед элементом в пунктах.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
insertHorizontalRule(childIndex) HorizontalRule Создает и вставляет HorizontalRule по указанному индексу.
insertInlineImage(childIndex, image) InlineImage Создает и вставляет новый InlineImage из указанного BLOB-объекта изображения по указанному индексу.
insertInlineImage(childIndex, image) InlineImage Вставляет заданный InlineImage по указанному индексу.
insertPageBreak(childIndex) PageBreak Создает и вставляет новый PageBreak по указанному индексу.
insertPageBreak(childIndex, pageBreak) PageBreak Вставляет заданный PageBreak по указанному индексу.
insertText(childIndex, text) Text Создает и вставляет новый текстовый элемент по указанному индексу.
insertText(childIndex, text) Text Вставляет заданный элемент Text по указанному индексу с указанным текстовым содержимым.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
isLeftToRight() Boolean Получает настройку слева направо.
merge() ListItem Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeChild(child) ListItem Удаляет указанный дочерний элемент.
removeFromParent() ListItem Удаляет элемент из его родителя.
removePositionedImage(id) Boolean Удаляет PositionedImage по идентификатору изображения.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAlignment(alignment) ListItem Устанавливает HorizontalAlignment .
setAttributes(attributes) ListItem Устанавливает атрибуты элемента.
setGlyphType(glyphType) ListItem Устанавливает GlyphType элемента списка.
setHeading(heading) ListItem Устанавливает ParagraphHeading .
setIndentEnd(indentEnd) ListItem Устанавливает конечный отступ в пунктах.
setIndentFirstLine(indentFirstLine) ListItem Устанавливает отступ первой строки в пунктах.
setIndentStart(indentStart) ListItem Устанавливает начальный отступ в пунктах.
setLeftToRight(leftToRight) ListItem Устанавливает настройку слева направо.
setLineSpacing(multiplier) ListItem Устанавливает межстрочный интервал как величину, указывающую количество строк, используемых в качестве интервала.
setLinkUrl(url) ListItem Устанавливает URL-адрес ссылки.
setListId(listItem) ListItem Устанавливает идентификатор списка.
setNestingLevel(nestingLevel) ListItem Устанавливает уровень вложенности элемента списка.
setSpacingAfter(spacingAfter) ListItem Устанавливает интервал после элемента в пунктах.
setSpacingBefore(spacingBefore) ListItem Устанавливает интервал перед элементом в пунктах.
setText(text) void Устанавливает содержимое элемента списка в виде текста.
setTextAlignment(textAlignment) ListItem Устанавливает выравнивание текста.

NamedRange

Методы

Метод Тип возврата Краткое описание
getId() String Получает идентификатор этого NamedRange .
getName() String Получает имя этого NamedRange .
getRange() Range Получает диапазон элементов, связанных с этим NamedRange .
remove() void Удаляет этот NamedRange с вкладки.

PageBreak

Методы

Метод Тип возврата Краткое описание
copy() PageBreak Возвращает отдельную глубокую копию текущего элемента.
getAttributes() Object Получает атрибуты элемента.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
removeFromParent() PageBreak Удаляет элемент из его родителя.
setAttributes(attributes) PageBreak Устанавливает атрибуты элемента.

Paragraph

Методы

Метод Тип возврата Краткое описание
addPositionedImage(image) PositionedImage Создает и вставляет новый PositionedImage из указанного BLOB-объекта изображения.
appendHorizontalRule() HorizontalRule Создает и добавляет новый HorizontalRule .
appendInlineImage(image) InlineImage Создает и добавляет новый InlineImage из указанного BLOB-объекта изображения.
appendInlineImage(image) InlineImage Добавляет заданный InlineImage .
appendPageBreak() PageBreak Создает и добавляет новый PageBreak .
appendPageBreak(pageBreak) PageBreak Добавляет заданный PageBreak .
appendText(text) Text Создает и добавляет новый элемент Text с указанным содержимым.
appendText(text) Text Добавляет заданный элемент Text .
clear() Paragraph Очищает содержимое элемента.
copy() Paragraph Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAlignment() HorizontalAlignment Получает HorizontalAlignment .
getAttributes() Object Получает атрибуты элемента.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getHeading() ParagraphHeading Получает ParagraphHeading .
getIndentEnd() Number Получает конечный отступ в пунктах.
getIndentFirstLine() Number Получает отступ первой строки в пунктах.
getIndentStart() Number Получает начальный отступ.
getLineSpacing() Number Получает межстрочный интервал в пунктах.
getLinkUrl() String Получает URL-адрес ссылки.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getNumChildren() Integer Получает количество детей.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPositionedImage(id) PositionedImage Получает PositionedImage по идентификатору изображения.
getPositionedImages() PositionedImage[] Получает все объекты PositionedImage , привязанные к абзацу.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getSpacingAfter() Number Получает расстояние после элемента в пунктах.
getSpacingBefore() Number Получает расстояние перед элементом в пунктах.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
insertHorizontalRule(childIndex) HorizontalRule Создает и вставляет HorizontalRule по указанному индексу.
insertInlineImage(childIndex, image) InlineImage Создает и вставляет новый InlineImage из указанного большого двоичного объекта изображения по указанному индексу.
insertInlineImage(childIndex, image) InlineImage Вставляет заданный InlineImage по указанному индексу.
insertPageBreak(childIndex) PageBreak Создает и вставляет новый PageBreak по указанному индексу.
insertPageBreak(childIndex, pageBreak) PageBreak Вставляет заданный PageBreak по указанному индексу.
insertText(childIndex, text) Text Создает и вставляет новый текстовый элемент по указанному индексу.
insertText(childIndex, text) Text Вставляет заданный элемент Text по указанному индексу с указанным текстовым содержимым.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
isLeftToRight() Boolean Получает настройку слева направо.
merge() Paragraph Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeChild(child) Paragraph Удаляет указанный дочерний элемент.
removeFromParent() Paragraph Удаляет элемент из его родителя.
removePositionedImage(id) Boolean Удаляет PositionedImage по идентификатору изображения.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAlignment(alignment) Paragraph Устанавливает HorizontalAlignment .
setAttributes(attributes) Paragraph Устанавливает атрибуты элемента.
setHeading(heading) Paragraph Устанавливает ParagraphHeading .
setIndentEnd(indentEnd) Paragraph Устанавливает конечный отступ в пунктах.
setIndentFirstLine(indentFirstLine) Paragraph Устанавливает отступ первой строки в пунктах.
setIndentStart(indentStart) Paragraph Устанавливает начальный отступ в пунктах.
setLeftToRight(leftToRight) Paragraph Устанавливает настройку слева направо.
setLineSpacing(multiplier) Paragraph Устанавливает межстрочный интервал как величину, указывающую количество строк, используемых в качестве интервала.
setLinkUrl(url) Paragraph Устанавливает URL-адрес ссылки.
setSpacingAfter(spacingAfter) Paragraph Устанавливает интервал после элемента в пунктах.
setSpacingBefore(spacingBefore) Paragraph Устанавливает интервал перед элементом в пунктах.
setText(text) void Устанавливает содержимое абзаца как текст.
setTextAlignment(textAlignment) Paragraph Устанавливает выравнивание текста.

ParagraphHeading

Характеристики

Свойство Тип Описание
NORMAL Enum Параметр заголовка для обычного текста.
HEADING1 Enum Самый высокий вариант заголовка.
HEADING2 Enum Второй вариант заголовка.
HEADING3 Enum Третий вариант заголовка
HEADING4 Enum Четвертый вариант заголовка.
HEADING5 Enum Пятый вариант заголовка.
HEADING6 Enum Самый низкий вариант заголовка.
TITLE Enum Вариант заголовка заголовка.
SUBTITLE Enum Параметр заголовка субтитров.

Person

Методы

Метод Тип возврата Краткое описание
copy() Person Возвращает отдельную глубокую копию текущего элемента.
getAttributes() Object Получает атрибуты элемента.
getEmail() String Возвращает адрес электронной почты человека.
getName() String Возвращает отображаемое имя человека, если оно установлено.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() Person Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() Person Удаляет элемент из его родителя.
setAttributes(attributes) Person Устанавливает атрибуты элемента.

Position

Методы

Метод Тип возврата Краткое описание
getElement() Element Получает элемент, содержащий эту Position .
getOffset() Integer Получает относительное расположение этой Position внутри элемента, который ее содержит.
getSurroundingText() Text Создает искусственный элемент Text , который представляет текст и форматирование Paragraph или ListItem , содержащего Position , напрямую или через цепочку дочерних элементов.
getSurroundingTextOffset() Integer Получает смещение этой Position в элементе Text , возвращаемом методом getSurroundingText() .
insertBookmark() Bookmark Создает и вставляет новую Bookmark в эту Position .
insertInlineImage(image) InlineImage Создает и вставляет новый InlineImage в эту Position из указанного BLOB-объекта изображения.
insertText(text) Text Вставляет указанный текст в эту Position .

PositionedImage

Методы

Метод Тип возврата Краткое описание
getAs(contentType) Blob Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
getBlob() Blob Верните данные внутри этого объекта в виде большого двоичного объекта.
getHeight() Integer Получает высоту изображения в пикселях.
getId() String Получает идентификатор изображения.
getLayout() PositionedLayout Получает значение перечисления, которое показывает, как расположено изображение.
getLeftOffset() Number Получает смещение изображения в пунктах от левого абзаца.
getParagraph() Paragraph Получает Paragraph к которому привязано изображение.
getTopOffset() Number Получает смещение изображения (в пунктах) от верхнего края абзаца.
getWidth() Integer Получает ширину изображения в пикселях.
setHeight(height) PositionedImage Устанавливает высоту изображения в пикселях.
setLayout(layout) PositionedImage Устанавливает определение компоновки изображения.
setLeftOffset(offset) PositionedImage Устанавливает смещение изображения в пунктах от левого абзаца.
setTopOffset(offset) PositionedImage Устанавливает смещение изображения в пунктах от верха абзаца.
setWidth(width) PositionedImage Устанавливает ширину изображения в пикселях.

PositionedLayout

Характеристики

Свойство Тип Описание
ABOVE_TEXT Enum Изображение располагается над текстом.
BREAK_BOTH Enum Изображение разбивает текст слева и справа.
BREAK_LEFT Enum Изображение разрывает текст слева.
BREAK_RIGHT Enum Изображение разрывает текст справа.
WRAP_TEXT Enum Изображение окружено текстом.

Range

Методы

Метод Тип возврата Краткое описание
getRangeElements() RangeElement[] Получает все элементы в этом Range , включая любые частичные элементы Text (например, в случае выделения, которое включает только часть элемента Text ).

RangeBuilder

Методы

Метод Тип возврата Краткое описание
addElement(element) RangeBuilder Добавляет целый Element в этот RangeBuilder .
addElement(textElement, startOffset, endOffsetInclusive) RangeBuilder Добавляет частичный элемент Text в этот RangeBuilder .
addElementsBetween(startElement, endElementInclusive) RangeBuilder Добавляет в этот RangeBuilder два целых элемента и все элементы между ними.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) RangeBuilder Добавляет в RangeBuilder два частичных элемента Text и все элементы между ними.
addRange(range) RangeBuilder Добавляет содержимое другого Range в этот RangeBuilder .
build() Range Создает Range на основе настроек, примененных к построителю.
getRangeElements() RangeElement[] Получает все элементы в этом Range , включая любые частичные элементы Text (например, в случае выделения, которое включает только часть элемента Text ).

RangeElement

Методы

Метод Тип возврата Краткое описание
getElement() Element Получает Element , соответствующий этому RangeElement .
getEndOffsetInclusive() Integer Получает позицию конца частичного диапазона внутри элемента диапазона.
getStartOffset() Integer Получает позицию начала частичного диапазона внутри элемента диапазона.
isPartial() Boolean Определяет, охватывает ли этот элемент диапазона весь элемент или частичный набор символов элемента.

Методы

Метод Тип возврата Краткое описание
copy() RichLink Возвращает отдельную глубокую копию текущего элемента.
getAttributes() Object Получает атрибуты элемента.
getMimeType() String Возвращает MIME-тип ссылки, который доступен, если элемент является ссылкой на файл Диска, и null в противном случае.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getTitle() String Возвращает отображаемый заголовок ссылки.
getType() ElementType Получает ElementType элемента.
getUrl() String Возвращает URL-адрес ресурса.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() RichLink Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() RichLink Удаляет элемент из его родителя.
setAttributes(attributes) RichLink Устанавливает атрибуты элемента.

Tab

Методы

Метод Тип возврата Краткое описание
asDocumentTab() DocumentTab Получает содержимое вкладки в виде DocumentTab .
getChildTabs() Tab[] Извлекает дочерние вкладки, вложенные в эту вкладку.
getId() String Получает идентификатор вкладки.
getIndex() Integer Получает индекс вкладки, отсчитываемый от 0, в родительском элементе.
getTitle() String Получает заголовок вкладки.
getType() TabType Получает тип вкладки.

TabType

Характеристики

Свойство Тип Описание
DOCUMENT_TAB Enum Тип, соответствующий DocumentTab .

Table

Методы

Метод Тип возврата Краткое описание
appendTableRow() TableRow Создает и добавляет новый TableRow .
appendTableRow(tableRow) TableRow Добавляет заданный TableRow .
clear() Table Очищает содержимое элемента.
copy() Table Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAttributes() Object Получает атрибуты элемента.
getBorderColor() String Получает цвет границы.
getBorderWidth() Number Получает ширину границы в пунктах.
getCell(rowIndex, cellIndex) TableCell Извлекает TableCell по указанным индексам строки и ячейки.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getColumnWidth(columnIndex) Number Получает ширину указанного столбца таблицы в пунктах.
getLinkUrl() String Получает URL-адрес ссылки.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getNumChildren() Integer Получает количество детей.
getNumRows() Integer Получает количество TableRows .
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getRow(rowIndex) TableRow Извлекает TableRow по указанному индексу строки.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
insertTableRow(childIndex) TableRow Создает и вставляет новую TableRow по указанному индексу.
insertTableRow(childIndex, tableRow) TableRow Вставляет заданную TableRow по указанному индексу.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
removeChild(child) Table Удаляет указанный дочерний элемент.
removeFromParent() Table Удаляет элемент из его родителя.
removeRow(rowIndex) TableRow Удаляет TableRow по указанному индексу строки.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(attributes) Table Устанавливает атрибуты элемента.
setBorderColor(color) Table Устанавливает цвет границы.
setBorderWidth(width) Table Устанавливает ширину границы в пунктах.
setColumnWidth(columnIndex, width) Table Устанавливает ширину указанного столбца в пунктах.
setLinkUrl(url) Table Устанавливает URL-адрес ссылки.
setTextAlignment(textAlignment) Table Устанавливает выравнивание текста.

TableCell

Методы

Метод Тип возврата Краткое описание
appendHorizontalRule() HorizontalRule Создает и добавляет новый HorizontalRule .
appendImage(image) InlineImage Создает и добавляет новый InlineImage из указанного BLOB-объекта изображения.
appendImage(image) InlineImage Добавляет заданный InlineImage .
appendListItem(listItem) ListItem Добавляет данный ListItem .
appendListItem(text) ListItem Создает и добавляет новый ListItem .
appendParagraph(paragraph) Paragraph Добавляет данный Paragraph .
appendParagraph(text) Paragraph Создает и добавляет новый Paragraph .
appendTable() Table Создает и добавляет новую Table .
appendTable(cells) Table Добавляет новую Table , содержащую указанные ячейки.
appendTable(table) Table Добавляет данную Table .
clear() TableCell Очищает содержимое элемента.
copy() TableCell Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAttributes() Object Получает атрибуты элемента.
getBackgroundColor() String Получает цвет фона.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getColSpan() Integer Получает диапазон столбцов, который представляет собой количество столбцов ячеек таблицы, охватываемых этой ячейкой.
getLinkUrl() String Получает URL-адрес ссылки.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getNumChildren() Integer Получает количество детей.
getPaddingBottom() Number Получает нижнее отступ в пунктах.
getPaddingLeft() Number Получает левое дополнение в точках.
getPaddingRight() Number Получает правильное дополнение в точках.
getPaddingTop() Number Получает верхнее дополнение в точках.
getParent() ContainerElement Извлекает родительский элемент элемента.
getParentRow() TableRow Извлекает TableRow содержащий текущий TableCell .
getParentTable() Table Извлекает Table содержащую текущую TableCell .
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getRowSpan() Integer Получает диапазон строк, который представляет собой количество строк ячеек таблицы, охватываемых этой ячейкой.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
getVerticalAlignment() VerticalAlignment Получает VerticalAlignment .
getWidth() Number Получает ширину столбца, содержащего ячейку, в пунктах.
insertHorizontalRule(childIndex) HorizontalRule Создает и вставляет новое HorizontalRule по указанному индексу.
insertImage(childIndex, image) InlineImage Создает и вставляет InlineImage из указанного большого двоичного объекта изображения по указанному индексу.
insertImage(childIndex, image) InlineImage Вставляет заданный InlineImage по указанному индексу.
insertListItem(childIndex, listItem) ListItem Вставляет заданный ListItem по указанному индексу.
insertListItem(childIndex, text) ListItem Создает и вставляет новый ListItem по указанному индексу.
insertParagraph(childIndex, paragraph) Paragraph Вставляет данный Paragraph по указанному индексу.
insertParagraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу.
insertTable(childIndex) Table Создает и вставляет новую Table по указанному индексу.
insertTable(childIndex, cells) Table Создает и вставляет новую Table , содержащую указанные ячейки, по указанному индексу.
insertTable(childIndex, table) Table Вставляет данную Table по указанному индексу.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() TableCell Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeChild(child) TableCell Удаляет указанный дочерний элемент.
removeFromParent() TableCell Удаляет элемент из его родителя.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(attributes) TableCell Устанавливает атрибуты элемента.
setBackgroundColor(color) TableCell Устанавливает цвет фона.
setLinkUrl(url) TableCell Устанавливает URL-адрес ссылки.
setPaddingBottom(paddingBottom) TableCell Устанавливает нижнее отступ в пунктах.
setPaddingLeft(paddingLeft) TableCell Устанавливает отступ слева в пунктах.
setPaddingRight(paddingRight) TableCell Устанавливает правильное отступы в пунктах.
setPaddingTop(paddingTop) TableCell Устанавливает верхнее отступ в пунктах.
setText(text) TableCell Устанавливает содержимое в виде обычного текста.
setTextAlignment(textAlignment) TableCell Устанавливает выравнивание текста.
setVerticalAlignment(alignment) TableCell Устанавливает вертикальное выравнивание.
setWidth(width) TableCell Устанавливает ширину столбца, содержащего текущую ячейку, в пунктах.

TableOfContents

Методы

Метод Тип возврата Краткое описание
clear() TableOfContents Очищает содержимое элемента.
copy() TableOfContents Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAttributes() Object Получает атрибуты элемента.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getLinkUrl() String Получает URL-адрес ссылки.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getNumChildren() Integer Получает количество детей.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
removeFromParent() TableOfContents Удаляет элемент из его родителя.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(attributes) TableOfContents Устанавливает атрибуты элемента.
setLinkUrl(url) TableOfContents Устанавливает URL-адрес ссылки.
setTextAlignment(textAlignment) TableOfContents Устанавливает выравнивание текста.

TableRow

Методы

Метод Тип возврата Краткое описание
appendTableCell() TableCell Создает и добавляет новый TableCell .
appendTableCell(textContents) TableCell Добавляет данную TableCell содержащую указанный текст.
appendTableCell(tableCell) TableCell Добавляет заданный TableCell .
clear() TableRow Очищает содержимое элемента.
copy() TableRow Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAttributes() Object Получает атрибуты элемента.
getCell(cellIndex) TableCell Извлекает TableCell по указанному индексу ячейки.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getLinkUrl() String Получает URL-адрес ссылки.
getMinimumHeight() Number Получает минимальную высоту в пунктах.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getNumCells() Integer Получает количество ячеек в строке.
getNumChildren() Integer Получает количество детей.
getParent() ContainerElement Извлекает родительский элемент элемента.
getParentTable() Table Извлекает Table содержащую текущую строку.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
insertTableCell(childIndex) TableCell Создает и вставляет новую TableCell по указанному индексу.
insertTableCell(childIndex, textContents) TableCell Вставляет заданную TableCell по указанному индексу, содержащую заданный текст.
insertTableCell(childIndex, tableCell) TableCell Вставляет заданную TableCell по указанному индексу.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() TableRow Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeCell(cellIndex) TableCell Удаляет TableCell по указанному индексу ячейки.
removeChild(child) TableRow Удаляет указанный дочерний элемент.
removeFromParent() TableRow Удаляет элемент из его родителя.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(attributes) TableRow Устанавливает атрибуты элемента.
setLinkUrl(url) TableRow Устанавливает URL-адрес ссылки.
setMinimumHeight(minHeight) TableRow Устанавливает минимальную высоту в пунктах.
setTextAlignment(textAlignment) TableRow Устанавливает выравнивание текста.

Text

Методы

Метод Тип возврата Краткое описание
appendText(text) Text Добавляет указанный текст в конец этой текстовой области.
copy() Text Возвращает отдельную глубокую копию текущего элемента.
deleteText(startOffset, endOffsetInclusive) Text Удаляет диапазон текста.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAttributes() Object Получает атрибуты элемента.
getAttributes(offset) Object Извлекает атрибуты по указанному смещению символов.
getBackgroundColor() String Получает настройку цвета фона.
getBackgroundColor(offset) String Получает цвет фона по указанному смещению символов.
getFontFamily() String Получает настройку семейства шрифтов.
getFontFamily(offset) String Извлекает семейство шрифтов по указанному смещению символов.
getFontSize() Number Получает настройку размера шрифта.
getFontSize(offset) Number Получает размер шрифта по указанному смещению символов.
getForegroundColor() String Получает настройку цвета переднего плана.
getForegroundColor(offset) String Получает цвет переднего плана по указанному смещению символа.
getLinkUrl() String Получает URL-адрес ссылки.
getLinkUrl(offset) String Получает URL-адрес ссылки по указанному смещению символов.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getTextAlignment(offset) TextAlignment Получает выравнивание текста для одного символа.
getTextAttributeIndices() Integer[] Извлекает набор текстовых индексов, которые соответствуют началу отдельных запусков форматирования текста.
getType() ElementType Получает ElementType элемента.
insertText(offset, text) Text Вставляет указанный текст по заданному смещению символов.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
isBold() Boolean Возвращает выделенный жирным шрифтом параметр.
isBold(offset) Boolean Извлекает настройку полужирного шрифта по указанному смещению символов.
isItalic() Boolean Получает настройку курсива.
isItalic(offset) Boolean Извлекает настройку курсива по указанному смещению символов.
isStrikethrough() Boolean Получает настройку зачеркивания.
isStrikethrough(offset) Boolean Извлекает настройку зачеркивания по указанному смещению символов.
isUnderline() Boolean Получает настройку подчеркивания.
isUnderline(offset) Boolean Извлекает настройку подчеркивания по указанному смещению символов.
merge() Text Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() Text Удаляет элемент из его родителя.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(startOffset, endOffsetInclusive, attributes) Text Применяет указанные атрибуты к заданному диапазону символов.
setAttributes(attributes) Text Устанавливает атрибуты элемента.
setBackgroundColor(startOffset, endOffsetInclusive, color) Text Устанавливает цвет фона для указанного диапазона символов.
setBackgroundColor(color) Text Устанавливает цвет фона.
setBold(bold) Text Устанавливает жирный шрифт.
setBold(startOffset, endOffsetInclusive, bold) Text Устанавливает настройку жирного шрифта для указанного диапазона символов.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName) Text Устанавливает семейство шрифтов для указанного диапазона символов.
setFontFamily(fontFamilyName) Text Устанавливает семейство шрифтов.
setFontSize(startOffset, endOffsetInclusive, size) Text Устанавливает размер шрифта для указанного диапазона символов.
setFontSize(size) Text Устанавливает размер шрифта.
setForegroundColor(startOffset, endOffsetInclusive, color) Text Устанавливает цвет переднего плана для указанного диапазона символов.
setForegroundColor(color) Text Устанавливает цвет переднего плана.
setItalic(italic) Text Устанавливает курсив.
setItalic(startOffset, endOffsetInclusive, italic) Text Устанавливает курсив для указанного диапазона символов.
setLinkUrl(startOffset, endOffsetInclusive, url) Text Устанавливает URL-адрес ссылки для указанного диапазона символов.
setLinkUrl(url) Text Устанавливает URL-адрес ссылки.
setStrikethrough(strikethrough) Text Устанавливает настройку зачеркивания.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough) Text Устанавливает настройку зачеркивания для указанного диапазона символов.
setText(text) Text Устанавливает текстовое содержимое.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment) Text Устанавливает выравнивание текста для заданного диапазона символов.
setTextAlignment(textAlignment) Text Устанавливает выравнивание текста.
setUnderline(underline) Text Устанавливает настройку подчеркивания.
setUnderline(startOffset, endOffsetInclusive, underline) Text Устанавливает настройку подчеркивания для указанного диапазона символов.

TextAlignment

Характеристики

Свойство Тип Описание
NORMAL Enum Обычное выравнивание текста.
SUPERSCRIPT Enum Выравнивание текста надстрочного индекса.
SUBSCRIPT Enum Выравнивание текста нижнего индекса.

UnsupportedElement

Методы

Метод Тип возврата Краткое описание
copy() UnsupportedElement Возвращает отдельную глубокую копию текущего элемента.
getAttributes() Object Получает атрибуты элемента.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() UnsupportedElement Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() UnsupportedElement Удаляет элемент из его родителя.
setAttributes(attributes) UnsupportedElement Устанавливает атрибуты элемента.

VerticalAlignment

Характеристики

Свойство Тип Описание
BOTTOM Enum Вариант выравнивания по низу.
CENTER Enum Вариант выравнивания по центру.
TOP Enum Вариант выравнивания сверху.