Document Service

Документ

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

// 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 Объект, представляющий собой закладку.
Container Element Обобщенный элемент, который может содержать другие элементы.
Date Элемент, представляющий отформатированную дату.
Document Документ, содержащий один или несколько объектов Tab , каждый из которых содержит форматированный текст и такие элементы, как таблицы и списки.
Document App Служба документов создает и открывает Documents , которые можно редактировать.
Document Tab Вкладка документа, содержащая форматированный текст и такие элементы, как таблицы и списки.
Element Обобщенный элемент.
Element Type Перечень всех типов элементов.
Equation Элемент, представляющий математическое выражение.
Equation Function Элемент, представляющий функцию в математическом Equation .
Equation Function Argument Separator Элемент, представляющий собой разделитель функций в математическом Equation .
Equation Symbol Элемент, представляющий собой символ в математическом Equation .
Font Family Перечень поддерживаемых шрифтов.
Footer Section Элемент, представляющий собой нижний колонтитул.
Footnote Элемент, представляющий собой сноску.
Footnote Section Элемент, представляющий собой раздел сносок.
Glyph Type Перечень поддерживаемых типов глифов.
Header Section Элемент, представляющий собой раздел заголовка.
Horizontal Alignment Перечень поддерживаемых типов горизонтального выравнивания.
Horizontal Rule Элемент, представляющий собой горизонтальную линию.
Inline Drawing Элемент, представляющий собой встроенный рисунок.
Inline Image Элемент, представляющий собой встроенное изображение.
List Item Элемент, представляющий собой элемент списка.
Named Range Range , имеющий имя и идентификатор для последующего извлечения.
Page Break Элемент, обозначающий разрыв страницы.
Paragraph Элемент, представляющий собой абзац.
Paragraph Heading Перечень стандартных заголовков абзацев.
Person Элемент, представляющий собой ссылку на человека.
Position Ссылка на местоположение на вкладке документа относительно конкретного элемента.
Positioned Image Изображение, находящееся в фиксированном положении и привязанное к Paragraph .
Positioned Layout Перечисление, определяющее способ размещения Positioned Image относительно окружающего текста.
Range Набор элементов в документе.
Range Builder Конструктор, используемый для создания объектов Range из элементов документа.
Range Element Оболочка вокруг Element с возможным начальным и конечным смещением.
Rich Link Элемент, представляющий собой ссылку на ресурс Google, например, на файл в Google Диска или видео на YouTube.
Tab Вкладка внутри документа Google Docs.
Tab Type Перечень всех типов вкладок.
Table Элемент, представляющий собой таблицу.
Table Cell Элемент, представляющий ячейку таблицы.
Table Of Contents Элемент, содержащий оглавление.
Table Row Элемент, представляющий собой строку таблицы.
Text Элемент, представляющий собой область с расширенным текстовым содержимым.
Text Alignment Перечень типов выравнивания текста.
Unsupported Element Элемент, представляющий собой область, которая неизвестна или не может быть затронута скриптом, например, номер страницы.
Vertical Alignment Перечень поддерживаемых типов вертикального выравнивания.

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 Тип заголовка для элементов абзаца (например, Document App.ParagraphHeading.HEADING1 ).
HEIGHT Enum Настройка высоты для элементов изображения.
HORIZONTAL_ALIGNMENT Enum Горизонтальное выравнивание для элементов абзаца (например, Document App.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

Методы

Метод Тип возвращаемого значения Краткое описание
append Horizontal Rule() Horizontal Rule Создает и добавляет новую Horizontal Rule .
append Image(image) Inline Image Создает и добавляет новое Inline Image из указанного блока изображений.
append Image(image) Inline Image Добавляет заданное Inline Image .
append List Item(listItem) List Item Добавляет указанный List Item .
append List Item(text) List Item Создает и добавляет новый List Item содержащий указанное текстовое содержимое.
append Page Break() Page Break Создает и добавляет новый Page Break .
append Page Break(pageBreak) Page Break Добавляет указанный Page Break .
append Paragraph(paragraph) Paragraph Добавляет данный Paragraph .
append Paragraph(text) Paragraph Создает и добавляет новый Paragraph содержащий указанное текстовое содержимое.
append Table() Table Создает и добавляет новую Table .
append Table(cells) Table Добавляет новую Table содержащую Table Cell для каждого указанного строкового значения.
append Table(table) Table Добавляет данные Table .
clear() Body Очищает содержимое элемента.
copy() Body Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Heading Attributes(paragraphHeading) Object Получает набор атрибутов для указанного Paragraph Heading .
get Images() Inline Image[] |null Извлекает все Inline Images содержащиеся в разделе.
get List Items() List Item[] |null Извлекает все List Items содержащиеся в разделе.
get Margin Bottom() Number|null Извлекает нижний отступ в пунктах.
get Margin Left() Number|null Извлекает левый край в пунктах.
get Margin Right() Number|null Восстанавливает правый край.
get Margin Top() Number|null Извлекает верхний отступ.
get Num Children() Integer Получает количество детей.
get Page Height() Number|null Получает высоту страницы в пунктах.
get Page Width() Number|null Извлекает ширину страницы в пунктах.
get Paragraphs() Paragraph[] |null Извлекает все Paragraphs содержащиеся в разделе (включая List Items ).
get Parent() Container Element |null Получает родительский элемент элемента.
get Tables() Table[] |null Извлекает все Tables содержащиеся в данном разделе.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
insert Horizontal Rule(childIndex) Horizontal Rule Создает и вставляет новую Horizontal Rule по указанному индексу.
insert Image(childIndex, image) Inline Image Создает и вставляет Inline Image из указанного блока изображений по указанному индексу.
insert Image(childIndex, image) Inline Image Вставляет заданное Inline Image по указанному индексу.
insert List Item(childIndex, listItem) List Item Вставляет заданный List Item по указанному индексу.
insert List Item(childIndex, text) List Item Создает и вставляет новый List Item по указанному индексу, содержащий указанное текстовое содержимое.
insert Page Break(childIndex) Page Break Создает и вставляет новый Page Break по указанному индексу.
insert Page Break(childIndex, pageBreak) Page Break Вставляет заданный Page Break по указанному индексу.
insert Paragraph(childIndex, paragraph) Paragraph Вставляет указанный Paragraph по указанному индексу.
insert Paragraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.
insert Table(childIndex) Table Создает и вставляет новую Table по указанному индексу.
insert Table(childIndex, cells) Table Создает и вставляет новую Table , содержащую указанные ячейки, по указанному индексу.
insert Table(childIndex, table) Table Вставляет заданную Table по указанному индексу.
remove Child(child) Body Удаляет указанный дочерний элемент.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Attributes(attributes) Body Задает атрибуты элемента.
set Heading Attributes(paragraphHeading, attributes) Body Задает атрибуты для указанного Paragraph Heading .
set Margin Bottom(marginBottom) Body Задает нижний отступ в пунктах.
set Margin Left(marginLeft) Body Задает левый отступ в пунктах.
set Margin Right(marginRight) Body Устанавливает правый отступ в пунктах.
set Margin Top(marginTop) Body Устанавливает верхний отступ.
set Page Height(pageHeight) Body Задает высоту страницы в пунктах.
set Page Width(pageWidth) Body Задает ширину страницы в пунктах.
set Text(text) Body Преобразует содержимое в обычный текст.
set Text Alignment(textAlignment) Body Задает выравнивание текста.

Bookmark

Методы

Метод Тип возвращаемого значения Краткое описание
get Id() String Получает идентификатор Bookmark .
get Position() Position Получает Position Bookmark на Document Tab .
remove() void Удаляет Bookmark .

Container Element

Методы

Метод Тип возвращаемого значения Краткое описание
as Body() Body Возвращает текущий элемент в виде Body .
as Equation() Equation Возвращает текущий элемент в виде Equation .
as Footer Section() Footer Section Возвращает текущий элемент в качестве Footer Section .
as Footnote Section() Footnote Section Возвращает текущий элемент в виде Footnote Section .
as Header Section() Header Section Возвращает текущий элемент в виде Header Section .
as List Item() List Item Возвращает текущий элемент в виде List Item .
as Paragraph() Paragraph Возвращает текущий элемент в виде Paragraph .
as Table() Table Возвращает текущий элемент в виде Table .
as Table Cell() Table Cell Возвращает текущий элемент в виде Table Cell .
as Table Of Contents() Table Of Contents Возвращает текущий элемент в виде Table Of Contents .
as Table Row() Table Row Возвращает текущий элемент в виде Table Row .
clear() Container Element Очищает содержимое элемента.
copy() Container Element Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Link Url() String|null Получает URL-адрес ссылки.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Num Children() Integer Получает количество детей.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Container Element |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove From Parent() Container Element |null Удаляет элемент из родительского элемента.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Attributes(attributes) Container Element Задает атрибуты элемента.
set Link Url(url) Container Element Задает URL-адрес ссылки.
set Text Alignment(textAlignment) Container Element Задает выравнивание текста.

Date

Методы

Метод Тип возвращаемого значения Краткое описание
copy() Date Возвращает отсоединенную, глубокую копию текущего элемента.
get Attributes() Object Получает атрибуты элемента.
get Display Text() String Возвращает отображаемое значение, которое отображается в документе.
get Locale() String Возвращает локаль даты, использованную для отображения значения.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Timestamp() Date Возвращает метку времени, связанную с датой.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Date |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove From Parent() Date |null Удаляет элемент из родительского элемента.
set Attributes(attributes) Date Задает атрибуты элемента.

Document

Методы

Метод Тип возвращаемого значения Краткое описание
add Bookmark(position) Bookmark Добавляет Bookmark в указанное Position на первую вкладку или, для скриптов, привязанных к документу, на активную вкладку.
add Editor(emailAddress) Document Добавляет указанного пользователя в список редакторов Document .
add Editor(user) Document Добавляет указанного пользователя в список редакторов Document .
add Editors(emailAddresses) Document Добавляет указанный массив пользователей в список редакторов Document .
add Footer() Footer Section Добавляет раздел нижнего колонтитула, если таковой отсутствует, на первую вкладку или, для скриптов, привязанных к документу, на активную вкладку.
add Header() Header Section Добавляет раздел заголовка, если таковой отсутствует, на первую вкладку или, для скриптов, привязанных к документу, на активную вкладку.
add Named Range(name, range) Named Range Добавляет Named Range ( Range , имеющий имя и идентификатор для последующего извлечения) на первую вкладку или, для скриптов, привязанных к документу, на активную вкладку.
add Viewer(emailAddress) Document Добавляет указанного пользователя в список пользователей, просматривающих Document .
add Viewer(user) Document Добавляет указанного пользователя в список пользователей, просматривающих Document .
add Viewers(emailAddresses) Document Добавляет указанный массив пользователей в список пользователей, просматривающих Document .
get Active Tab() Tab Получает текущую активную Tab пользователя в документе.
get As(contentType) Blob Извлекает содержимое текущего Document в виде двоичного объекта указанного типа.
get Blob() Blob Извлекает содержимое текущего Document в виде двоичного объекта (blob).
get Body() Body Извлекает Body первой вкладки или, для скриптов, связанных с документом, Document Body Section " активной вкладки.
get Bookmark(id) Bookmark |null Получает Bookmark с заданным ID на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке.
get Bookmarks() Bookmark[] Получает все объекты Bookmark на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке.
get Cursor() Position |null Перемещает курсор пользователя в активную вкладку.
get Editors() User[] Получает список редакторов для этого Document .
get Footer() Footer Section |null Извлекает нижний колонтитул первой вкладки или, для скриптов, привязанных к документу, нижний колонтитул активной вкладки.
get Footnotes() Footnote[] |null Извлекает все элементы Footnote из тела первой вкладки или, для скриптов, привязанных к документу, из тела активной вкладки.
get Header() Header Section |null Извлекает заголовок первой вкладки или, для скриптов, привязанных к документу, заголовок активной вкладки.
get Id() String Получает уникальный идентификатор документа.
get Language() String Получает код языка документа.
get Name() String Извлекает заголовок документа.
get Named Range By Id(id) Named Range |null Получает Named Range с заданным идентификатором на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке.
get Named Ranges() Named Range[] Получает все объекты Named Range на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке.
get Named Ranges(name) Named Range[] Получает все объекты Named Range с заданным именем на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке.
get Selection() Range |null Получает выбранный пользователем элемент на активной вкладке.
get Supported Language Codes() String[] Получает все коды языков, поддерживаемые в файлах Google Docs.
get Tab(tabId) Tab Получает Tab с указанным ID.
get Tabs() Tab[] Получает все невложенные Tab , являющиеся частью документа.
get Url() String Получает URL-адрес для доступа к текущему документу.
get Viewers() User[] Получает список зрителей и комментаторов для этого Document .
new Position(element, offset) Position Создает новую Position , которая представляет собой ссылку на местоположение на вкладке относительно определенного элемента на первой вкладке или, для скриптов, привязанных к документу, активной вкладки.
new Range() Range Builder Создает конструктор, используемый для построения объектов Range из элементов вкладок на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке.
remove Editor(emailAddress) Document Удаляет указанного пользователя из списка редакторов Document .
remove Editor(user) Document Удаляет указанного пользователя из списка редакторов Document .
remove Viewer(emailAddress) Document Удаляет указанного пользователя из списка пользователей, просматривающих Document и оставляющих комментарии.
remove Viewer(user) Document Удаляет указанного пользователя из списка пользователей, просматривающих Document и оставляющих комментарии.
save And Close() void Сохраняет текущий Document .
set Active Tab(tabId) void Устанавливает Tab , выбранную пользователем в текущем документе, на вкладку с указанным идентификатором.
set Cursor(position) Document Устанавливает курсор пользователя, задав его Position .
set Language(languageCode) Document Устанавливает языковой код документа.
set Name(name) Document Задает заголовок документа.
set Selection(range) Document Устанавливает выбранный пользователем элемент на активной вкладке, задав Range .

Document App

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

Свойство Тип Описание
Attribute Attribute Перечисление Attribute .
Element Type Element Type Перечисление Element Type .
Font Family Font Family Перечень шрифтов Font Family .
Glyph Type Glyph Type Перечисление Glyph Type .
Horizontal Alignment Horizontal Alignment Перечисление Horizontal Alignment .
Paragraph Heading Paragraph Heading Перечень Paragraph Heading .
Positioned Layout Positioned Layout Перечисление Positioned Layout .
Text Alignment Text Alignment Перечисление Text Alignment .
Vertical Alignment Vertical Alignment Перечисление Vertical Alignment .

Методы

Метод Тип возвращаемого значения Краткое описание
create(name) Document Создает и возвращает новый документ.
get Active Document() Document Возвращает документ, к которому привязан скрипт в качестве контейнера .
get Ui() Ui Возвращает экземпляр пользовательского интерфейса документа, позволяющий скрипту добавлять такие элементы, как меню, диалоговые окна и боковые панели.
open By Id(id) Document Возвращает документ с указанным идентификатором.
open By Url(url) Document Открывает и возвращает документ по указанному URL-адресу.

Document Tab

Методы

Метод Тип возвращаемого значения Краткое описание
add Bookmark(position) Bookmark Добавляет Bookmark в указанное Position .
add Footer() Footer Section Добавляет раздел в нижнем колонтитуле вкладки, если такового нет.
add Header() Header Section Добавляет раздел заголовка вкладки, если такового нет.
add Named Range(name, range) Named Range Добавляет Named Range , который представляет собой Range , имеющий имя и идентификатор для последующего извлечения данных.
get Body() Body Получает Body вкладки.
get Bookmark(id) Bookmark |null Получает Bookmark с заданным идентификатором.
get Bookmarks() Bookmark[] Получает все объекты Bookmark на вкладке.
get Footer() Footer Section |null Получает нижнюю часть вкладки, если она существует.
get Footnotes() Footnote[] |null Извлекает все элементы Footnote из содержимого вкладки.
get Header() Header Section |null Получает заголовок вкладки, если он существует.
get Named Range By Id(id) Named Range |null Получает Named Range с заданным идентификатором.
get Named Ranges() Named Range[] Получает все объекты Named Range на вкладке.
get Named Ranges(name) Named Range[] Получает все объекты Named Range на вкладке с заданным именем.
new Position(element, offset) Position Создает новый Position , который представляет собой ссылку на местоположение на вкладке относительно конкретного элемента.
new Range() Range Builder Создает конструктор, используемый для построения объектов Range из элементов вкладок.

Element

Методы

Метод Тип возвращаемого значения Краткое описание
as Body() Body Возвращает текущий элемент в виде Body .
as Date() Date Возвращает текущий элемент в виде Date .
as Equation() Equation Возвращает текущий элемент в виде Equation .
as Equation Function() Equation Function Возвращает текущий элемент в виде Equation Function .
as Equation Function Argument Separator() Equation Function Argument Separator Возвращает текущий элемент в виде Equation Function Argument Separator .
as Equation Symbol() Equation Symbol Возвращает текущий элемент в виде Equation Symbol .
as Footer Section() Footer Section Возвращает текущий элемент в качестве Footer Section .
as Footnote() Footnote Возвращает текущий элемент в виде Footnote .
as Footnote Section() Footnote Section Возвращает текущий элемент в виде Footnote Section .
as Header Section() Header Section Возвращает текущий элемент в виде Header Section .
as Horizontal Rule() Horizontal Rule Возвращает текущий элемент в виде Horizontal Rule .
as Inline Drawing() Inline Drawing Возвращает текущий элемент в виде Inline Drawing .
as Inline Image() Inline Image Возвращает текущий элемент в виде Inline Image .
as List Item() List Item Возвращает текущий элемент в виде List Item .
as Page Break() Page Break Возвращает текущий элемент в качестве Page Break .
as Paragraph() Paragraph Возвращает текущий элемент в виде Paragraph .
as Person() Person Возвращает текущий элемент в виде Person .
as Rich Link() Rich Link Возвращает текущий элемент в виде Rich Link , например, ссылку на файл Google Sheets.
as Table() Table Возвращает текущий элемент в виде Table .
as Table Cell() Table Cell Возвращает текущий элемент в виде Table Cell .
as Table Of Contents() Table Of Contents Возвращает текущий элемент в виде Table Of Contents .
as Table Row() Table Row Возвращает текущий элемент в виде Table Row .
as Text() Text Возвращает текущий элемент в виде Text .
copy() Element Возвращает отсоединенную, глубокую копию текущего элемента.
get Attributes() Object Получает атрибуты элемента.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Element |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove From Parent() Element |null Удаляет элемент из родительского элемента.
set Attributes(attributes) Element Задает атрибуты элемента.

Element Type

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

Свойство Тип Описание
BODY_SECTION Enum Тип, соответствующий элементу Body .
COMMENT_SECTION Enum Тип, соответствующий элементу « Comment Section .
DATE Enum Тип, соответствующий элементу Date .
EQUATION Enum Тип, соответствующий элементу Equation .
EQUATION_FUNCTION Enum Тип, соответствующий элементу Equation Function .
EQUATION_FUNCTION_ARGUMENT_SEPARATOR Enum Тип, соответствующий элементу « Equation Function Argument Separator .
EQUATION_SYMBOL Enum Тип, соответствующий элементу Equation Symbol .
RICH_LINK Enum Тип, соответствующий элементу Rich Link .
FOOTER_SECTION Enum Тип, соответствующий элементу Footer Section .
FOOTNOTE Enum Тип, соответствующий элементу Footnote .
FOOTNOTE_SECTION Enum Тип, соответствующий элементу Footnote Section .
HEADER_SECTION Enum Тип, соответствующий элементу Header Section .
HORIZONTAL_RULE Enum Тип, соответствующий элементу Horizontal Rule .
INLINE_DRAWING Enum Тип, соответствующий элементу Inline Drawing .
INLINE_IMAGE Enum Тип, соответствующий элементу Inline Image .
LIST_ITEM Enum Тип, соответствующий элементу List Item .
PAGE_BREAK Enum Тип, соответствующий элементу « Page Break .
PARAGRAPH Enum Тип, соответствующий элементу Paragraph .
PERSON Enum Тип, соответствующий элементу Person .
TABLE Enum Тип, соответствующий элементу Table .
TABLE_CELL Enum Тип, соответствующий элементу Table Cell .
TABLE_OF_CONTENTS Enum Тип, соответствующий элементу Table Of Contents .
TABLE_ROW Enum Тип, соответствующий элементу Table Row .
TEXT Enum Тип, соответствующий Text элементу.
UNSUPPORTED Enum Тип, соответствующий Unsupported Element .

Equation

Методы

Метод Тип возвращаемого значения Краткое описание
clear() Equation Очищает содержимое элемента.
copy() Equation Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Link Url() String|null Получает URL-адрес ссылки.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Num Children() Integer Получает количество детей.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Equation |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove From Parent() Equation |null Удаляет элемент из родительского элемента.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Attributes(attributes) Equation Задает атрибуты элемента.
set Link Url(url) Equation Задает URL-адрес ссылки.
set Text Alignment(textAlignment) Equation Задает выравнивание текста.

Equation Function

Методы

Метод Тип возвращаемого значения Краткое описание
clear() Equation Function Очищает содержимое элемента.
copy() Equation Function Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Code() String Получает код, соответствующий функции уравнения.
get Link Url() String|null Получает URL-адрес ссылки.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Num Children() Integer Получает количество детей.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Equation Function |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove From Parent() Equation Function |null Удаляет элемент из родительского элемента.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Attributes(attributes) Equation Function Задает атрибуты элемента.
set Link Url(url) Equation Function Задает URL-адрес ссылки.
set Text Alignment(textAlignment) Equation Function Задает выравнивание текста.

Equation Function Argument Separator

Методы

Метод Тип возвращаемого значения Краткое описание
copy() Equation Function Argument Separator Возвращает отсоединенную, глубокую копию текущего элемента.
get Attributes() Object Получает атрибуты элемента.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Equation Function Argument Separator |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove From Parent() Equation Function Argument Separator |null Удаляет элемент из родительского элемента.
set Attributes(attributes) Equation Function Argument Separator Задает атрибуты элемента.

Equation Symbol

Методы

Метод Тип возвращаемого значения Краткое описание
copy() Equation Symbol Возвращает отсоединенную, глубокую копию текущего элемента.
get Attributes() Object Получает атрибуты элемента.
get Code() String Извлекает код, соответствующий символу уравнения.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Equation Symbol |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove From Parent() Equation Symbol |null Удаляет элемент из родительского элемента.
set Attributes(attributes) Equation Symbol Задает атрибуты элемента.

Font Family

Footer Section

Методы

Метод Тип возвращаемого значения Краткое описание
append Horizontal Rule() Horizontal Rule Создает и добавляет новую Horizontal Rule .
append Image(image) Inline Image Создает и добавляет новое Inline Image из указанного блока изображений.
append Image(image) Inline Image Добавляет заданное Inline Image .
append List Item(listItem) List Item Добавляет указанный List Item .
append List Item(text) List Item Создает и добавляет новый List Item содержащий указанное текстовое содержимое.
append Paragraph(paragraph) Paragraph Добавляет данный Paragraph .
append Paragraph(text) Paragraph Создает и добавляет новый Paragraph содержащий указанное текстовое содержимое.
append Table() Table Создает и добавляет новую Table .
append Table(cells) Table Добавляет новую Table содержащую Table Cell для каждого указанного строкового значения.
append Table(table) Table Добавляет данные Table .
clear() Footer Section Очищает содержимое элемента.
copy() Footer Section Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Images() Inline Image[] |null Извлекает все Inline Images содержащиеся в разделе.
get List Items() List Item[] |null Извлекает все List Items содержащиеся в разделе.
get Num Children() Integer Получает количество детей.
get Paragraphs() Paragraph[] |null Извлекает все Paragraphs содержащиеся в разделе (включая List Items ).
get Parent() Container Element |null Получает родительский элемент элемента.
get Tables() Table[] |null Извлекает все Tables содержащиеся в данном разделе.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
insert Horizontal Rule(childIndex) Horizontal Rule Создает и вставляет новую Horizontal Rule по указанному индексу.
insert Image(childIndex, image) Inline Image Создает и вставляет Inline Image из указанного блока изображений по указанному индексу.
insert Image(childIndex, image) Inline Image Вставляет заданное Inline Image по указанному индексу.
insert List Item(childIndex, listItem) List Item Вставляет заданный List Item по указанному индексу.
insert List Item(childIndex, text) List Item Создает и вставляет новый List Item по указанному индексу, содержащий указанное текстовое содержимое.
insert Paragraph(childIndex, paragraph) Paragraph Вставляет указанный Paragraph по указанному индексу.
insert Paragraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.
insert Table(childIndex) Table Создает и вставляет новую Table по указанному индексу.
insert Table(childIndex, cells) Table Создает и вставляет новую Table , содержащую указанные ячейки, по указанному индексу.
insert Table(childIndex, table) Table Вставляет заданную Table по указанному индексу.
remove Child(child) Footer Section Удаляет указанный дочерний элемент.
remove From Parent() Footer Section |null Удаляет элемент из родительского элемента.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Attributes(attributes) Footer Section Задает атрибуты элемента.
set Text(text) Footer Section Преобразует содержимое в обычный текст.
set Text Alignment(textAlignment) Footer Section Задает выравнивание текста.

Footnote

Методы

Метод Тип возвращаемого значения Краткое описание
copy() Footnote Возвращает отсоединенную, глубокую копию текущего элемента.
get Attributes() Object Получает атрибуты элемента.
get Footnote Contents() Footnote Section |null Извлекает содержимое элемента сноски.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
remove From Parent() Footnote |null Удаляет элемент из родительского элемента.
set Attributes(attributes) Footnote Задает атрибуты элемента.

Footnote Section

Методы

Метод Тип возвращаемого значения Краткое описание
append Paragraph(paragraph) Paragraph Добавляет данный Paragraph .
append Paragraph(text) Paragraph Создает и добавляет новый Paragraph содержащий указанное текстовое содержимое.
clear() Footnote Section Очищает содержимое элемента.
copy() Footnote Section Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Num Children() Integer Получает количество детей.
get Paragraphs() Paragraph[] |null Извлекает все Paragraphs содержащиеся в разделе (включая List Items ).
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
insert Paragraph(childIndex, paragraph) Paragraph Вставляет указанный Paragraph по указанному индексу.
insert Paragraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.
remove Child(child) Footnote Section Удаляет указанный дочерний элемент.
remove From Parent() Footnote Section |null Удаляет элемент из родительского элемента.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Attributes(attributes) Footnote Section Задает атрибуты элемента.
set Text(text) Footnote Section Преобразует содержимое в обычный текст.
set Text Alignment(textAlignment) Footnote Section Задает выравнивание текста.

Glyph Type

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

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

Header Section

Методы

Метод Тип возвращаемого значения Краткое описание
append Horizontal Rule() Horizontal Rule Создает и добавляет новую Horizontal Rule .
append Image(image) Inline Image Создает и добавляет новое Inline Image из указанного блока изображений.
append Image(image) Inline Image Добавляет заданное Inline Image .
append List Item(listItem) List Item Добавляет указанный List Item .
append List Item(text) List Item Создает и добавляет новый List Item содержащий указанное текстовое содержимое.
append Paragraph(paragraph) Paragraph Добавляет данный Paragraph .
append Paragraph(text) Paragraph Создает и добавляет новый Paragraph содержащий указанное текстовое содержимое.
append Table() Table Создает и добавляет новую Table .
append Table(cells) Table Добавляет новую Table содержащую Table Cell для каждого указанного строкового значения.
append Table(table) Table Добавляет данные Table .
clear() Header Section Очищает содержимое элемента.
copy() Header Section Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Images() Inline Image[] |null Извлекает все Inline Images содержащиеся в разделе.
get List Items() List Item[] |null Извлекает все List Items содержащиеся в разделе.
get Num Children() Integer Получает количество детей.
get Paragraphs() Paragraph[] |null Извлекает все Paragraphs содержащиеся в разделе (включая List Items ).
get Parent() Container Element |null Получает родительский элемент элемента.
get Tables() Table[] |null Извлекает все Tables содержащиеся в данном разделе.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
insert Horizontal Rule(childIndex) Horizontal Rule Создает и вставляет новую Horizontal Rule по указанному индексу.
insert Image(childIndex, image) Inline Image Создает и вставляет Inline Image из указанного блока изображений по указанному индексу.
insert Image(childIndex, image) Inline Image Вставляет заданное Inline Image по указанному индексу.
insert List Item(childIndex, listItem) List Item Вставляет заданный List Item по указанному индексу.
insert List Item(childIndex, text) List Item Создает и вставляет новый List Item по указанному индексу, содержащий указанное текстовое содержимое.
insert Paragraph(childIndex, paragraph) Paragraph Вставляет указанный Paragraph по указанному индексу.
insert Paragraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.
insert Table(childIndex) Table Создает и вставляет новую Table по указанному индексу.
insert Table(childIndex, cells) Table Создает и вставляет новую Table , содержащую указанные ячейки, по указанному индексу.
insert Table(childIndex, table) Table Вставляет заданную Table по указанному индексу.
remove Child(child) Header Section Удаляет указанный дочерний элемент.
remove From Parent() Header Section |null Удаляет элемент из родительского элемента.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Attributes(attributes) Header Section Задает атрибуты элемента.
set Text(text) Header Section Преобразует содержимое в обычный текст.
set Text Alignment(textAlignment) Header Section Задает выравнивание текста.

Horizontal Alignment

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

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

Horizontal Rule

Методы

Метод Тип возвращаемого значения Краткое описание
copy() Horizontal Rule Возвращает отсоединенную, глубокую копию текущего элемента.
get Attributes() Object Получает атрибуты элемента.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
remove From Parent() Horizontal Rule |null Удаляет элемент из родительского элемента.
set Attributes(attributes) Horizontal Rule Задает атрибуты элемента.

Inline Drawing

Методы

Метод Тип возвращаемого значения Краткое описание
copy() Inline Drawing Возвращает отсоединенную, глубокую копию текущего элемента.
get Alt Description() String|null Возвращает альтернативное описание рисунка.
get Alt Title() String|null Возвращает альтернативное название рисунка.
get Attributes() Object Получает атрибуты элемента.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Inline Drawing |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove From Parent() Inline Drawing |null Удаляет элемент из родительского элемента.
set Alt Description(description) Inline Drawing Задает альтернативное описание рисунка.
set Alt Title(title) Inline Drawing Задает альтернативное название рисунка.
set Attributes(attributes) Inline Drawing Задает атрибуты элемента.

Inline Image

Методы

Метод Тип возвращаемого значения Краткое описание
copy() Inline Image Возвращает отсоединенную, глубокую копию текущего элемента.
get Alt Description() String|null Возвращает альтернативное описание изображения.
get Alt Title() String|null Возвращает альтернативное название изображения.
get As(contentType) Blob Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob), преобразованных в указанный тип содержимого.
get Attributes() Object Получает атрибуты элемента.
get Blob() Blob Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob).
get Height() Integer Извлекает высоту изображения в пикселях.
get Link Url() String|null Получает URL-адрес ссылки.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Type() Element Type Получает Element Type элемента.
get Width() Integer Получает ширину изображения в пикселях.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Inline Image |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove From Parent() Inline Image |null Удаляет элемент из родительского элемента.
set Alt Description(description) Inline Image Задает альтернативное описание изображения.
set Alt Title(title) Inline Image Задает альтернативное название изображения.
set Attributes(attributes) Inline Image Задает атрибуты элемента.
set Height(height) Inline Image Задает высоту изображения в пикселях.
set Link Url(url) Inline Image Задает URL-адрес ссылки.
set Width(width) Inline Image Задает ширину изображения в пикселях.

List Item

Методы

Метод Тип возвращаемого значения Краткое описание
add Positioned Image(image) Positioned Image Создает и вставляет новое Positioned Image из указанного блока изображений.
append Horizontal Rule() Horizontal Rule Создает и добавляет новую Horizontal Rule .
append Inline Image(image) Inline Image Создает и добавляет новое Inline Image из указанного блока изображений.
append Inline Image(image) Inline Image Добавляет заданное Inline Image .
append Page Break() Page Break Создает и добавляет новый Page Break .
append Page Break(pageBreak) Page Break Добавляет указанный Page Break .
append Text(text) Text Создает и добавляет новый Text элемент с указанным содержимым.
append Text(text) Text Добавляет заданный Text элемент.
clear() List Item Очищает содержимое элемента.
copy() List Item Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Alignment() Horizontal Alignment |null Получает Horizontal Alignment .
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Glyph Type() Glyph Type |null Получает Glyph Type элемента списка.
get Heading() Paragraph Heading |null Извлекает Paragraph Heading .
get Indent End() Number|null Извлекает конечный отступ в пунктах.
get Indent First Line() Number|null Извлекает отступ первой строки в пунктах.
get Indent Start() Number|null Извлекает начальный отступ.
get Line Spacing() Number|null Извлекает межстрочный интервал в пунктах.
get Link Url() String|null Получает URL-адрес ссылки.
get List Id() String|null Получает идентификатор списка.
get Nesting Level() Integer Получает уровень вложенности элемента списка.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Num Children() Integer Получает количество детей.
get Parent() Container Element |null Получает родительский элемент элемента.
get Positioned Image(id) Positioned Image Получает Positioned Image по его идентификатору.
get Positioned Images() Positioned Image[] Получает все объекты Positioned Image привязанные к абзацу.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Spacing After() Number|null Определяет расстояние после элемента в пунктах.
get Spacing Before() Number|null Извлекает отступ перед элементом в пунктах.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
insert Horizontal Rule(childIndex) Horizontal Rule Создает и вставляет Horizontal Rule по указанному индексу.
insert Inline Image(childIndex, image) Inline Image Создает и вставляет новое Inline Image из указанного блока изображений по указанному индексу.
insert Inline Image(childIndex, image) Inline Image Вставляет заданное Inline Image по указанному индексу.
insert Page Break(childIndex) Page Break Создает и вставляет новый Page Break по указанному индексу.
insert Page Break(childIndex, pageBreak) Page Break Вставляет заданный Page Break по указанному индексу.
insert Text(childIndex, text) Text Создает и вставляет новый текстовый элемент по указанному индексу.
insert Text(childIndex, text) Text Вставляет заданный Text элемент по указанному индексу с указанным текстовым содержимым.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
is Left To Right() Boolean|null Извлекает настройку "слева направо".
merge() List Item |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove Child(child) List Item Удаляет указанный дочерний элемент.
remove From Parent() List Item |null Удаляет элемент из родительского элемента.
remove Positioned Image(id) Boolean Удаляет Positioned Image по его идентификатору.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Alignment(alignment) List Item Задает Horizontal Alignment .
set Attributes(attributes) List Item Задает атрибуты элемента.
set Glyph Type(glyphType) List Item Задает Glyph Type для элемента списка.
set Heading(heading) List Item Задает Paragraph Heading .
set Indent End(indentEnd) List Item Задает отступ в конце строки в пунктах.
set Indent First Line(indentFirstLine) List Item Задает отступ первой строки в пунктах.
set Indent Start(indentStart) List Item Задает начальный отступ в пунктах.
set Left To Right(leftToRight) List Item Задает направление слева направо.
set Line Spacing(multiplier) List Item Задает межстрочный интервал в виде величины, указывающей количество строк, используемых для отступа.
set Link Url(url) List Item Задает URL-адрес ссылки.
set List Id(listItem) List Item Задает идентификатор списка.
set Nesting Level(nestingLevel) List Item Задает уровень вложенности элемента списка.
set Spacing After(spacingAfter) List Item Задает отступ после элемента в пунктах.
set Spacing Before(spacingBefore) List Item Задает отступ перед элементом в пунктах.
set Text(text) void Устанавливает содержимое элемента списка в виде текста.
set Text Alignment(textAlignment) List Item Задает выравнивание текста.

Named Range

Методы

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

Page Break

Методы

Метод Тип возвращаемого значения Краткое описание
copy() Page Break Возвращает отсоединенную, глубокую копию текущего элемента.
get Attributes() Object Получает атрибуты элемента.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
remove From Parent() Page Break |null Удаляет элемент из родительского элемента.
set Attributes(attributes) Page Break Задает атрибуты элемента.

Paragraph

Методы

Метод Тип возвращаемого значения Краткое описание
add Positioned Image(image) Positioned Image Создает и вставляет новое Positioned Image из указанного блока изображений.
append Horizontal Rule() Horizontal Rule Создает и добавляет новую Horizontal Rule .
append Inline Image(image) Inline Image Создает и добавляет новое Inline Image из указанного блока изображений.
append Inline Image(image) Inline Image Добавляет заданное Inline Image .
append Page Break() Page Break Создает и добавляет новый Page Break .
append Page Break(pageBreak) Page Break Добавляет указанный Page Break .
append Text(text) Text Создает и добавляет новый Text элемент с указанным содержимым.
append Text(text) Text Добавляет заданный Text элемент.
clear() Paragraph Очищает содержимое элемента.
copy() Paragraph Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Alignment() Horizontal Alignment |null Получает Horizontal Alignment .
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Heading() Paragraph Heading |null Извлекает Paragraph Heading .
get Indent End() Number|null Извлекает конечный отступ в пунктах.
get Indent First Line() Number|null Извлекает отступ первой строки в пунктах.
get Indent Start() Number|null Извлекает начальный отступ.
get Line Spacing() Number|null Извлекает межстрочный интервал в пунктах.
get Link Url() String|null Получает URL-адрес ссылки.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Num Children() Integer Получает количество детей.
get Parent() Container Element |null Получает родительский элемент элемента.
get Positioned Image(id) Positioned Image Получает Positioned Image по его идентификатору.
get Positioned Images() Positioned Image[] Получает все объекты Positioned Image привязанные к абзацу.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Spacing After() Number|null Определяет расстояние после элемента в пунктах.
get Spacing Before() Number|null Извлекает отступ перед элементом в пунктах.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
insert Horizontal Rule(childIndex) Horizontal Rule Создает и вставляет Horizontal Rule по указанному индексу.
insert Inline Image(childIndex, image) Inline Image Создает и вставляет новое Inline Image из указанного блока изображений по указанному индексу.
insert Inline Image(childIndex, image) Inline Image Вставляет заданное Inline Image по указанному индексу.
insert Page Break(childIndex) Page Break Создает и вставляет новый Page Break по указанному индексу.
insert Page Break(childIndex, pageBreak) Page Break Вставляет заданный Page Break по указанному индексу.
insert Text(childIndex, text) Text Создает и вставляет новый текстовый элемент по указанному индексу.
insert Text(childIndex, text) Text Вставляет заданный Text элемент по указанному индексу с указанным текстовым содержимым.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
is Left To Right() Boolean|null Извлекает настройку "слева направо".
merge() Paragraph |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove Child(child) Paragraph Удаляет указанный дочерний элемент.
remove From Parent() Paragraph |null Удаляет элемент из родительского элемента.
remove Positioned Image(id) Boolean Удаляет Positioned Image по его идентификатору.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Alignment(alignment) Paragraph Задает Horizontal Alignment .
set Attributes(attributes) Paragraph Задает атрибуты элемента.
set Heading(heading) Paragraph Задает Paragraph Heading .
set Indent End(indentEnd) Paragraph Задает отступ в конце строки в пунктах.
set Indent First Line(indentFirstLine) Paragraph Задает отступ первой строки в пунктах.
set Indent Start(indentStart) Paragraph Задает начальный отступ в пунктах.
set Left To Right(leftToRight) Paragraph Задает направление слева направо.
set Line Spacing(multiplier) Paragraph Задает межстрочный интервал в виде величины, указывающей количество строк, используемых для отступа.
set Link Url(url) Paragraph Задает URL-адрес ссылки.
set Spacing After(spacingAfter) Paragraph Задает отступ после элемента в пунктах.
set Spacing Before(spacingBefore) Paragraph Задает отступ перед элементом в пунктах.
set Text(text) void Устанавливает содержимое абзаца в виде текста.
set Text Alignment(textAlignment) Paragraph Задает выравнивание текста.

Paragraph Heading

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

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

Person

Методы

Метод Тип возвращаемого значения Краткое описание
copy() Person Возвращает отсоединенную, глубокую копию текущего элемента.
get Attributes() Object Получает атрибуты элемента.
get Email() String Возвращает адрес электронной почты пользователя.
get Name() String|null Возвращает отображаемое имя пользователя, если оно задано.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Person |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove From Parent() Person |null Удаляет элемент из родительского элемента.
set Attributes(attributes) Person Задает атрибуты элемента.

Position

Методы

Метод Тип возвращаемого значения Краткое описание
get Element() Element Получает элемент, содержащий этот Position .
get Offset() Integer Получает относительное местоположение Position внутри содержащего его элемента.
get Surrounding Text() Text Создает искусственный Text элемент, представляющий текст и форматирование Paragraph или List Item , содержащего Position , либо напрямую, либо через цепочку дочерних элементов.
get Surrounding Text Offset() Integer Получает смещение этой Position внутри Text элемента, возвращаемого функцией get Surrounding Text() .
insert Bookmark() Bookmark Создает и вставляет новую Bookmark в указанное Position .
insert Inline Image(image) Inline Image |null Создает и вставляет новое Inline Image в указанную Position из заданного блока изображений.
insert Text(text) Text |null Вставляет указанный текст в эту Position .

Positioned Image

Методы

Метод Тип возвращаемого значения Краткое описание
get As(contentType) Blob Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob), преобразованных в указанный тип содержимого.
get Blob() Blob Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob).
get Height() Integer Извлекает высоту изображения в пикселях.
get Id() String Получает идентификатор изображения.
get Layout() Positioned Layout Получает значение перечисления, описывающее способ размещения изображения.
get Left Offset() Number Определяет смещение изображения в пунктах относительно левого края абзаца.
get Paragraph() Paragraph Получает Paragraph к которому привязано изображение.
get Top Offset() Number Получает смещение изображения в пунктах от начала абзаца.
get Width() Integer Получает ширину изображения в пикселях.
set Height(height) Positioned Image Задает высоту изображения в пикселях.
set Layout(layout) Positioned Image Задает параметры компоновки изображения.
set Left Offset(offset) Positioned Image Задает смещение изображения в пунктах от левого края абзаца.
set Top Offset(offset) Positioned Image Задает смещение изображения в пунктах от верхней части абзаца.
set Width(width) Positioned Image Задает ширину изображения в пикселях.

Positioned Layout

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

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

Range

Методы

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

Range Builder

Методы

Метод Тип возвращаемого значения Краткое описание
add Element(element) Range Builder Добавляет целый Element в этот Range Builder .
add Element(textElement, startOffset, endOffsetInclusive) Range Builder Добавляет частичный Text элемент в этот Range Builder .
add Elements Between(startElement, endElementInclusive) Range Builder Добавляет в этот Range Builder два целых элемента, а также все элементы между ними.
add Elements Between(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) Range Builder Добавляет в Range Builder два элемента "Частичный Text и все элементы между ними.
add Range(range) Range Builder Добавляет содержимое другого Range в этот Range Builder .
build() Range Создает Range на основе настроек, примененных к конструктору.
get Range Elements() Range Element[] Получает все элементы в этом Range , включая любые частично выделенные Text элементы (например, в случае выделения, включающего только часть Text элемента).

Range Element

Методы

Метод Тип возвращаемого значения Краткое описание
get Element() Element Получает Element , соответствующий данному Range Element .
get End Offset Inclusive() Integer Получает позицию конца частичного диапазона внутри элемента диапазона.
get Start Offset() Integer Получает позицию начала частичного диапазона внутри элемента диапазона.
is Partial() Boolean Определяет, охватывает ли данный диапазон символов весь элемент или лишь его часть.

Методы

Метод Тип возвращаемого значения Краткое описание
copy() Rich Link Возвращает отсоединенную, глубокую копию текущего элемента.
get Attributes() Object Получает атрибуты элемента.
get Mime Type() String|null Возвращает MIME-тип ссылки, который доступен, если элемент является ссылкой на файл в Google Диска, и null в противном случае.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Title() String Возвращает отображаемый заголовок ссылки.
get Type() Element Type Получает Element Type элемента.
get Url() String Возвращает URL-адрес ресурса.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Rich Link |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove From Parent() Rich Link |null Удаляет элемент из родительского элемента.
set Attributes(attributes) Rich Link Задает атрибуты элемента.

Tab

Методы

Метод Тип возвращаемого значения Краткое описание
as Document Tab() Document Tab Извлекает содержимое вкладки в виде Document Tab .
get Child Tabs() Tab[] Извлекает дочерние вкладки, вложенные в эту вкладку.
get Id() String Получает идентификатор вкладки.
get Index() Integer Извлекает индекс вкладки внутри родительского элемента, начинающийся с 0.
get Title() String Получает заголовок вкладки.
get Type() Tab Type Определяет тип вкладки.

Tab Type

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

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

Table

Методы

Метод Тип возвращаемого значения Краткое описание
append Table Row() Table Row Создает и добавляет новую Table Row .
append Table Row(tableRow) Table Row Добавляет указанную Table Row .
clear() Table Очищает содержимое элемента.
copy() Table Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Border Color() String|null Получает цвет границы.
get Border Width() Number|null Извлекает ширину границы в пунктах.
get Cell(rowIndex, cellIndex) Table Cell |null Извлекает Table Cell по указанным индексам строки и ячейки.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Column Width(columnIndex) Number|null Извлекает ширину указанного столбца таблицы в пунктах.
get Link Url() String|null Получает URL-адрес ссылки.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Num Children() Integer Получает количество детей.
get Num Rows() Integer Получает количество Table Rows .
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Row(rowIndex) Table Row |null Извлекает Table Row по указанному индексу.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
insert Table Row(childIndex) Table Row Создает и вставляет новую Table Row по указанному индексу.
insert Table Row(childIndex, tableRow) Table Row Вставляет указанную Table Row по указанному индексу.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
remove Child(child) Table Удаляет указанный дочерний элемент.
remove From Parent() Table |null Удаляет элемент из родительского элемента.
remove Row(rowIndex) Table Row Удаляет Table Row по указанному индексу.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Attributes(attributes) Table Задает атрибуты элемента.
set Border Color(color) Table Задает цвет границы.
set Border Width(width) Table Задает ширину границы в пунктах.
set Column Width(columnIndex, width) Table Задает ширину указанного столбца в пунктах.
set Link Url(url) Table Задает URL-адрес ссылки.
set Text Alignment(textAlignment) Table Задает выравнивание текста.

Table Cell

Методы

Метод Тип возвращаемого значения Краткое описание
append Horizontal Rule() Horizontal Rule Создает и добавляет новую Horizontal Rule .
append Image(image) Inline Image Создает и добавляет новое Inline Image из указанного блока изображений.
append Image(image) Inline Image Добавляет заданное Inline Image .
append List Item(listItem) List Item Добавляет указанный List Item .
append List Item(text) List Item Создает и добавляет новый List Item .
append Paragraph(paragraph) Paragraph Добавляет данный Paragraph .
append Paragraph(text) Paragraph Создает и добавляет новый Paragraph .
append Table() Table Создает и добавляет новую Table .
append Table(cells) Table Добавляет новую Table содержащую указанные ячейки.
append Table(table) Table Добавляет данные Table .
clear() Table Cell Очищает содержимое элемента.
copy() Table Cell Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Background Color() String|null Получает цвет фона.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Col Span() Integer Получает значение параметра column span, которое представляет собой количество столбцов ячеек таблицы, охватываемых данной ячейкой.
get Link Url() String|null Получает URL-адрес ссылки.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Num Children() Integer Получает количество детей.
get Padding Bottom() Number|null Извлекает нижний отступ в точках.
get Padding Left() Number|null Извлекает левый отступ в пунктах.
get Padding Right() Number|null Извлекает отступ справа в пунктах.
get Padding Top() Number|null Извлекает верхний отступ в пунктах.
get Parent() Container Element |null Получает родительский элемент элемента.
get Parent Row() Table Row |null Извлекает Table Row содержащую текущую Table Cell .
get Parent Table() Table |null Извлекает Table содержащую текущую Table Cell .
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Row Span() Integer Получает значение диапазона строк, то есть количество строк ячеек таблицы, которые занимает данная ячейка.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
get Vertical Alignment() Vertical Alignment |null Получает значение Vertical Alignment .
get Width() Number|null Извлекает ширину столбца, содержащего ячейку, в пунктах.
insert Horizontal Rule(childIndex) Horizontal Rule Создает и вставляет новую Horizontal Rule по указанному индексу.
insert Image(childIndex, image) Inline Image Создает и вставляет Inline Image из указанного блока изображений по указанному индексу.
insert Image(childIndex, image) Inline Image Вставляет заданное Inline Image по указанному индексу.
insert List Item(childIndex, listItem) List Item Вставляет заданный List Item по указанному индексу.
insert List Item(childIndex, text) List Item Создает и вставляет новый List Item по указанному индексу.
insert Paragraph(childIndex, paragraph) Paragraph Вставляет указанный Paragraph по указанному индексу.
insert Paragraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу.
insert Table(childIndex) Table Создает и вставляет новую Table по указанному индексу.
insert Table(childIndex, cells) Table Создает и вставляет новую Table , содержащую указанные ячейки, по указанному индексу.
insert Table(childIndex, table) Table Вставляет заданную Table по указанному индексу.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Table Cell |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove Child(child) Table Cell Удаляет указанный дочерний элемент.
remove From Parent() Table Cell |null Удаляет элемент из родительского элемента.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Attributes(attributes) Table Cell Задает атрибуты элемента.
set Background Color(color) Table Cell Задает цвет фона.
set Link Url(url) Table Cell Задает URL-адрес ссылки.
set Padding Bottom(paddingBottom) Table Cell Задает нижний отступ в пунктах.
set Padding Left(paddingLeft) Table Cell Задает левый отступ в пунктах.
set Padding Right(paddingRight) Table Cell Устанавливает правильный отступ в пунктах.
set Padding Top(paddingTop) Table Cell Задает верхний отступ в пунктах.
set Text(text) Table Cell Преобразует содержимое в обычный текст.
set Text Alignment(textAlignment) Table Cell Задает выравнивание текста.
set Vertical Alignment(alignment) Table Cell Задает вертикальное выравнивание.
set Width(width) Table Cell Задает ширину столбца, содержащего текущую ячейку, в пунктах.

Table Of Contents

Методы

Метод Тип возвращаемого значения Краткое описание
clear() Table Of Contents Очищает содержимое элемента.
copy() Table Of Contents Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Link Url() String|null Получает URL-адрес ссылки.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Num Children() Integer Получает количество детей.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
remove From Parent() Table Of Contents |null Удаляет элемент из родительского элемента.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Attributes(attributes) Table Of Contents Задает атрибуты элемента.
set Link Url(url) Table Of Contents Задает URL-адрес ссылки.
set Text Alignment(textAlignment) Table Of Contents Задает выравнивание текста.

Table Row

Методы

Метод Тип возвращаемого значения Краткое описание
append Table Cell() Table Cell Создает и добавляет новую Table Cell .
append Table Cell(textContents) Table Cell Добавляет текст в указанную Table Cell .
append Table Cell(tableCell) Table Cell Добавляет содержимое указанной Table Cell .
clear() Table Row Очищает содержимое элемента.
copy() Table Row Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Cell(cellIndex) Table Cell |null Извлекает Table Cell по указанному индексу.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Link Url() String|null Получает URL-адрес ссылки.
get Minimum Height() Number|null Определяет минимальную высоту в точках.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Num Cells() Integer Получает количество ячеек в строке.
get Num Children() Integer Получает количество детей.
get Parent() Container Element |null Получает родительский элемент элемента.
get Parent Table() Table |null Извлекает Table содержащую текущую строку.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
insert Table Cell(childIndex) Table Cell Создает и вставляет новую Table Cell по указанному индексу.
insert Table Cell(childIndex, textContents) Table Cell Вставляет заданную Table Cell по указанному индексу, содержащую заданный текст.
insert Table Cell(childIndex, tableCell) Table Cell Вставляет заданную Table Cell по указанному индексу.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Table Row |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove Cell(cellIndex) Table Cell Удаляет Table Cell по указанному индексу.
remove Child(child) Table Row Удаляет указанный дочерний элемент.
remove From Parent() Table Row |null Удаляет элемент из родительского элемента.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Attributes(attributes) Table Row Задает атрибуты элемента.
set Link Url(url) Table Row Задает URL-адрес ссылки.
set Minimum Height(minHeight) Table Row Устанавливает минимальную высоту в пунктах.
set Text Alignment(textAlignment) Table Row Задает выравнивание текста.

Text

Методы

Метод Тип возвращаемого значения Краткое описание
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 Задает уровень подчеркивания для указанного диапазона символов.

Text Alignment

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

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

Unsupported Element

Методы

Метод Тип возвращаемого значения Краткое описание
copy() Unsupported Element Возвращает отсоединенную, глубокую копию текущего элемента.
get Attributes() Object Получает атрибуты элемента.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Parent() Container Element |null Получает родительский элемент элемента.
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Unsupported Element |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove From Parent() Unsupported Element |null Удаляет элемент из родительского элемента.
set Attributes(attributes) Unsupported Element Задает атрибуты элемента.

Vertical Alignment

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

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