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 Объект, представляющий закладку.
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, например файл на Диске или видео 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 из указанного BLOB-объекта изображения.
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 Ищет в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element Ищет в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
find Text(searchPattern, from) Range Element Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
get Child Index(child) Integer Получает дочерний индекс для указанного дочернего элемента.
get Heading Attributes(paragraphHeading) Object Извлекает набор атрибутов для предоставленного Paragraph Heading .
get Images() Inline Image[] Извлекает все Inline Images содержащиеся в разделе.
get List Items() List Item[] Извлекает все List Items содержащиеся в разделе.
get Margin Bottom() Number Получает нижнее поле в пунктах.
get Margin Left() Number Получает левое поле в пунктах.
get Margin Right() Number Получает правое поле.
get Margin Top() Number Получает верхнее поле.
get Num Children() Integer Получает количество детей.
get Page Height() Number Получает высоту страницы в пунктах.
get Page Width() Number Получает ширину страницы в пунктах.
get Paragraphs() Paragraph[] Извлекает все Paragraphs содержащиеся в разделе (включая List Items ).
get Parent() Container Element Извлекает родительский элемент элемента.
get Tables() Table[] Извлекает все Tables содержащиеся в разделе.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
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 Ищет в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element Ищет в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
find Text(searchPattern, from) Range Element Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
get Child Index(child) Integer Получает дочерний индекс для указанного дочернего элемента.
get Link Url() String Получает URL-адрес ссылки.
get Next Sibling() Element Извлекает следующий родственный элемент элемента.
get Num Children() Integer Получает количество детей.
get Parent() Container Element Извлекает родительский элемент элемента.
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Container Element Объединяет элемент с предыдущим одноуровневым элементом того же типа.
remove From Parent() Container Element Удаляет элемент из его родителя.
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 Извлекает следующий родственный элемент элемента.
get Parent() Container Element Извлекает родительский элемент элемента.
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Timestamp() Date Возвращает метку времени, связанную с датой.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Date Объединяет элемент с предыдущим одноуровневым элементом того же типа.
remove From Parent() Date Удаляет элемент из его родителя.
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 в виде большого двоичного объекта.
get Body() Body Извлекает Body первой вкладки или, для сценариев, привязанных к документу, Document Body Section активной вкладки.
get Bookmark(id) Bookmark Получает Bookmark с заданным идентификатором на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
get Bookmarks() Bookmark[] Получает все объекты Bookmark на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
get Cursor() Position Получает курсор пользователя на активной вкладке.
get Editors() User[] Получает список редакторов этого Document .
get Footer() Footer Section Извлекает раздел нижнего колонтитула первой вкладки или, для сценариев, привязанных к документу, раздел нижнего колонтитула активной вкладки.
get Footnotes() Footnote[] Извлекает все элементы Footnote в теле первой вкладки или, для сценариев, привязанных к документу, в теле активной вкладки.
get Header() Header Section Извлекает раздел заголовка первой вкладки или, для сценариев, привязанных к документу, раздел заголовка активной вкладки.
get Id() String Получает уникальный идентификатор документа.
get Language() String Получает код языка документа.
get Name() String Получает заголовок документа.
get Named Range By Id(id) Named Range Получает Named Range с заданным идентификатором на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
get Named Ranges() Named Range[] Получает все объекты Named Range на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
get Named Ranges(name) Named Range[] Получает все объекты Named Range с заданным именем на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
get Selection() Range Получает выбор пользователя на активной вкладке.
get Supported Language Codes() String[] Получает все коды языков, которые поддерживаются в файлах Документов Google.
get Tab(tabId) Tab Получает Tab с указанным идентификатором.
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 Получает Bookmark с заданным идентификатором.
get Bookmarks() Bookmark[] Получает все объекты Bookmark на вкладке.
get Footer() Footer Section Извлекает нижний колонтитул вкладки, если он существует.
get Footnotes() Footnote[] Извлекает все элементы Footnote в теле вкладки.
get Header() Header Section Получает раздел заголовка вкладки, если он существует.
get Named Range By Id(id) Named Range Получает 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 Извлекает следующий родственный элемент элемента.
get Parent() Container Element Извлекает родительский элемент элемента.
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Element Объединяет элемент с предыдущим одноуровневым элементом того же типа.
remove From Parent() Element Удаляет элемент из его родителя.
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 Ищет в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element Ищет в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
find Text(searchPattern, from) Range Element Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
get Child Index(child) Integer Получает дочерний индекс для указанного дочернего элемента.
get Link Url() String Получает URL-адрес ссылки.
get Next Sibling() Element Извлекает следующий родственный элемент элемента.
get Num Children() Integer Получает количество детей.
get Parent() Container Element Извлекает родительский элемент элемента.
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Equation Объединяет элемент с предыдущим одноуровневым элементом того же типа.
remove From Parent() Equation Удаляет элемент из его родителя.
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 Ищет в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element Ищет в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
find Text(searchPattern, from) Range Element Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
get Child Index(child) Integer Получает дочерний индекс для указанного дочернего элемента.
get Code() String Получает код, соответствующий функции уравнения.
get Link Url() String Получает URL-адрес ссылки.
get Next Sibling() Element Извлекает следующий родственный элемент элемента.
get Num Children() Integer Получает количество детей.
get Parent() Container Element Извлекает родительский элемент элемента.
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Equation Function Объединяет элемент с предыдущим одноуровневым элементом того же типа.
remove From Parent() Equation Function Удаляет элемент из его родителя.
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 Извлекает следующий родственный элемент элемента.
get Parent() Container Element Извлекает родительский элемент элемента.
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Equation Function Argument Separator Объединяет элемент с предыдущим одноуровневым элементом того же типа.
remove From Parent() Equation Function Argument Separator Удаляет элемент из его родителя.
set Attributes(attributes) Equation Function Argument Separator Устанавливает атрибуты элемента.

Equation Symbol

Методы

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

Font Family

Footer Section

Методы

Метод Тип возврата Краткое описание
append Horizontal Rule() Horizontal Rule Создает и добавляет новое Horizontal Rule .
append Image(image) Inline Image Создает и добавляет новое Inline Image из указанного BLOB-объекта изображения.
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 Ищет в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element Ищет в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
find Text(searchPattern, from) Range Element Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
get Child Index(child) Integer Получает дочерний индекс для указанного дочернего элемента.
get Images() Inline Image[] Извлекает все Inline Images содержащиеся в разделе.
get List Items() List Item[] Извлекает все List Items содержащиеся в разделе.
get Num Children() Integer Получает количество детей.
get Paragraphs() Paragraph[] Извлекает все Paragraphs содержащиеся в разделе (включая List Items ).
get Parent() Container Element Извлекает родительский элемент элемента.
get Tables() Table[] Извлекает все Tables содержащиеся в разделе.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
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 Удаляет элемент из его родителя.
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 Получает содержимое элемента сноски.
get Next Sibling() Element Извлекает следующий родственный элемент элемента.
get Parent() Container Element Извлекает родительский элемент элемента.
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
remove From Parent() Footnote Удаляет элемент из его родителя.
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 Ищет в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element Ищет в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
find Text(searchPattern, from) Range Element Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
get Child Index(child) Integer Получает дочерний индекс для указанного дочернего элемента.
get Next Sibling() Element Извлекает следующий родственный элемент элемента.
get Num Children() Integer Получает количество детей.
get Paragraphs() Paragraph[] Извлекает все Paragraphs содержащиеся в разделе (включая List Items ).
get Parent() Container Element Извлекает родительский элемент элемента.
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
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 Удаляет элемент из его родителя.
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 из указанного BLOB-объекта изображения.
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 Ищет в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element Ищет в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
find Text(searchPattern, from) Range Element Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
get Child Index(child) Integer Получает дочерний индекс для указанного дочернего элемента.
get Images() Inline Image[] Извлекает все Inline Images содержащиеся в разделе.
get List Items() List Item[] Извлекает все List Items содержащиеся в разделе.
get Num Children() Integer Получает количество детей.
get Paragraphs() Paragraph[] Извлекает все Paragraphs содержащиеся в разделе (включая List Items ).
get Parent() Container Element Извлекает родительский элемент элемента.
get Tables() Table[] Извлекает все Tables содержащиеся в разделе.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
insert Horizontal Rule(childIndex) Horizontal Rule Создает и вставляет новое Horizontal Rule по указанному индексу.
insert Image(childIndex, image) Inline Image Создает и вставляет Inline Image из указанного BLOB-объекта изображения по указанному индексу.
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 Удаляет элемент из его родителя.
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 Извлекает следующий родственный элемент элемента.
get Parent() Container Element Извлекает родительский элемент элемента.
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
remove From Parent() Horizontal Rule Удаляет элемент из его родителя.
set Attributes(attributes) Horizontal Rule Устанавливает атрибуты элемента.

Inline Drawing

Методы

Метод Тип возврата Краткое описание
copy() Inline Drawing Возвращает отдельную глубокую копию текущего элемента.
get Alt Description() String Возвращает альтернативное описание рисунка.
get Alt Title() String Возвращает альтернативный заголовок рисунка.
get Attributes() Object Получает атрибуты элемента.
get Next Sibling() Element Извлекает следующий родственный элемент элемента.
get Parent() Container Element Извлекает родительский элемент элемента.
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Inline Drawing Объединяет элемент с предыдущим одноуровневым элементом того же типа.
remove From Parent() Inline Drawing Удаляет элемент из его родителя.
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 Возвращает альтернативное описание изображения.
get Alt Title() String Возвращает альтернативный заголовок изображения.
get As(contentType) Blob Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
get Attributes() Object Получает атрибуты элемента.
get Blob() Blob Верните данные внутри этого объекта в виде большого двоичного объекта.
get Height() Integer Получает высоту изображения в пикселях.
get Link Url() String Получает URL-адрес ссылки.
get Next Sibling() Element Извлекает следующий родственный элемент элемента.
get Parent() Container Element Извлекает родительский элемент элемента.
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Type() Element Type Получает Element Type элемента.
get Width() Integer Получает ширину изображения в пикселях.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Inline Image Объединяет элемент с предыдущим одноуровневым элементом того же типа.
remove From Parent() Inline Image Удаляет элемент из его родителя.
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 из указанного BLOB-объекта изображения.
append Horizontal Rule() Horizontal Rule Создает и добавляет новое Horizontal Rule .
append Inline Image(image) Inline Image Создает и добавляет новое Inline Image из указанного BLOB-объекта изображения.
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 Ищет в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element Ищет в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
find Text(searchPattern, from) Range Element Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
get Alignment() Horizontal Alignment Получает Horizontal Alignment .
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
get Child Index(child) Integer Получает дочерний индекс для указанного дочернего элемента.
get Glyph Type() Glyph Type Извлекает Glyph Type элемента списка.
get Heading() Paragraph Heading Получает Paragraph Heading .
get Indent End() Number Получает конечный отступ в пунктах.
get Indent First Line() Number Получает отступ первой строки в пунктах.
get Indent Start() Number Получает начальный отступ.
get Line Spacing() Number Получает межстрочный интервал в пунктах.
get Link Url() String Получает URL-адрес ссылки.
get List Id() String Получает идентификатор списка.
get Nesting Level() Integer Получает уровень вложенности элемента списка.
get Next Sibling() Element Извлекает следующий родственный элемент элемента.
get Num Children() Integer Получает количество детей.
get Parent() Container Element Извлекает родительский элемент элемента.
get Positioned Image(id) Positioned Image Получает Positioned Image по идентификатору изображения.
get Positioned Images() Positioned Image[] Получает все объекты Positioned Image привязанные к абзацу.
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Spacing After() Number Получает расстояние после элемента в пунктах.
get Spacing Before() Number Получает расстояние перед элементом в пунктах.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
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 Получает настройку слева направо.
merge() List Item Объединяет элемент с предыдущим братом того же типа.
remove Child(child) List Item Удаляет указанный дочерний элемент.
remove From Parent() List Item Удаляет элемент от своего родителя.
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 Получает следующий элемент сестра элемента.
get Parent() Container Element Получает родительский элемент элемента.
get Previous Sibling() Element Получает предыдущий элемент сестра элемента.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
remove From Parent() Page Break Удаляет элемент от своего родителя.
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 Поиск содержимого элемента для потомка указанного типа.
find Element(elementType, from) Range Element Поиск содержимого элемента для потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Поиск содержимого элемента для указанного текстового шаблона с использованием регулярных выражений.
find Text(searchPattern, from) Range Element Поиск содержимого элемента для указанного текстового шаблона, начиная с данного результата поиска.
get Alignment() Horizontal Alignment Получает Horizontal Alignment .
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Получает дочерний элемент в указанном детском индексе.
get Child Index(child) Integer Получает индекс ребенка для указанного дочернего элемента.
get Heading() Paragraph Heading Получает Paragraph Heading .
get Indent End() Number Получает конечное отступить, в точки.
get Indent First Line() Number Получает первую линию в отступление, в точки.
get Indent Start() Number Получает начало.
get Line Spacing() Number Получает интервал между линиями, в точках.
get Link Url() String Получает URL -адрес ссылки.
get Next Sibling() Element Получает следующий элемент сестра элемента.
get Num Children() Integer Получает количество детей.
get Parent() Container Element Получает родительский элемент элемента.
get Positioned Image(id) Positioned Image Получает Positioned Image от идентификатора изображения.
get Positioned Images() Positioned Image[] Получает все Positioned Image прикрепленные к абзацу.
get Previous Sibling() Element Получает предыдущий элемент сестра элемента.
get Spacing After() Number Получает интервал после элемента, в точках.
get Spacing Before() Number Извлекает интервал перед элементом, в точках.
get Text() String Получает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
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 Получает настройку слева направо.
merge() Paragraph Объединяет элемент с предыдущим братом того же типа.
remove Child(child) Paragraph Удаляет указанный дочерний элемент.
remove From Parent() Paragraph Удаляет элемент от своего родителя.
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 Возвращает отображаемое имя человека, если установлено.
get Next Sibling() Element Получает следующий элемент сестра элемента.
get Parent() Container Element Получает родительский элемент элемента.
get Previous Sibling() Element Получает предыдущий элемент сестра элемента.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Person Объединяет элемент с предыдущим братом того же типа.
remove From Parent() Person Удаляет элемент от своего родителя.
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 Создает и вставляет новое Inline Image в этой Position из указанного изображения.
insert Text(text) Text Встает указанный текст в эту Position .

Positioned Image

Методы

Метод Тип возврата Краткое описание
get As(contentType) Blob Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
get 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 Добавляет два частичных Text элемента и все элементы между ними, в Range Builder .
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 Возвращает тип MIME ссылки, которая доступна, когда элемент является ссылкой на файл диска и в null случае.
get Next Sibling() Element Получает следующий элемент сестра элемента.
get Parent() Container Element Получает родительский элемент элемента.
get Previous Sibling() Element Получает предыдущий элемент сестра элемента.
get Title() String Возвращает титул ссылки.
get Type() Element Type Получает Element Type элемента.
get Url() String Возвращает URL ресурса.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Rich Link Объединяет элемент с предыдущим братом того же типа.
remove From Parent() Rich Link Удаляет элемент от своего родителя.
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 Поиск содержимого элемента для потомка указанного типа.
find Element(elementType, from) Range Element Поиск содержимого элемента для потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Поиск содержимого элемента для указанного текстового шаблона с использованием регулярных выражений.
find Text(searchPattern, from) Range Element Поиск содержимого элемента для указанного текстового шаблона, начиная с данного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Border Color() String Получает цвет границы.
get Border Width() Number Получает ширину границы в пунктах.
get Cell(rowIndex, cellIndex) Table Cell Извлекает Table Cell по указанным индексам строки и ячейки.
get Child(childIndex) Element Получает дочерний элемент в указанном детском индексе.
get Child Index(child) Integer Получает индекс ребенка для указанного дочернего элемента.
get Column Width(columnIndex) Number Получает ширину указанного столбца таблицы в пунктах.
get Link Url() String Получает URL -адрес ссылки.
get Next Sibling() Element Получает следующий элемент сестра элемента.
get Num Children() Integer Получает количество детей.
get Num Rows() Integer Получает количество Table Rows .
get Parent() Container Element Получает родительский элемент элемента.
get Previous Sibling() Element Получает предыдущий элемент сестра элемента.
get Row(rowIndex) Table Row Извлекает Table Row по указанному индексу строки.
get Text() String Получает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
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 Удаляет элемент от своего родителя.
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 Поиск содержимого элемента для потомка указанного типа.
find Element(elementType, from) Range Element Поиск содержимого элемента для потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Поиск содержимого элемента для указанного текстового шаблона с использованием регулярных выражений.
find Text(searchPattern, from) Range Element Поиск содержимого элемента для указанного текстового шаблона, начиная с данного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Background Color() String Получает цвет фона.
get Child(childIndex) Element Получает дочерний элемент в указанном детском индексе.
get Child Index(child) Integer Получает индекс ребенка для указанного дочернего элемента.
get Col Span() Integer Извлекает пролет колонны, который представляет собой количество столбцов табличных ячеек.
get Link Url() String Получает URL -адрес ссылки.
get Next Sibling() Element Получает следующий элемент сестра элемента.
get Num Children() Integer Получает количество детей.
get Padding Bottom() Number Получает нижнюю прокладку в точках.
get Padding Left() Number Получает левую прокладку, в точках.
get Padding Right() Number Получает правую прокладку в точках.
get Padding Top() Number Получает верхнюю прокладку в точках.
get Parent() Container Element Получает родительский элемент элемента.
get Parent Row() Table Row Получает Table Row , содержащую текущую Table Cell .
get Parent Table() Table Получает Table содержащую текущую Table Cell .
get Previous Sibling() Element Получает предыдущий элемент сестра элемента.
get Row Span() Integer Извлекает пролет ряда, который представляет собой количество рядов табличных ячеек, которые эта ячейка простирается.
get Text() String Получает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
get Vertical Alignment() Vertical Alignment Получает Vertical Alignment .
get Width() Number Получает ширину колонны, содержащей ячейку, в точках.
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 Объединяет элемент с предыдущим братом того же типа.
remove Child(child) Table Cell Удаляет указанный дочерний элемент.
remove From Parent() Table Cell Удаляет элемент от своего родителя.
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 Поиск содержимого элемента для потомка указанного типа.
find Element(elementType, from) Range Element Поиск содержимого элемента для потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Поиск содержимого элемента для указанного текстового шаблона с использованием регулярных выражений.
find Text(searchPattern, from) Range Element Поиск содержимого элемента для указанного текстового шаблона, начиная с данного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Получает дочерний элемент в указанном детском индексе.
get Child Index(child) Integer Получает индекс ребенка для указанного дочернего элемента.
get Link Url() String Получает URL -адрес ссылки.
get Next Sibling() Element Получает следующий элемент сестра элемента.
get Num Children() Integer Получает количество детей.
get Parent() Container Element Получает родительский элемент элемента.
get Previous Sibling() Element Получает предыдущий элемент сестра элемента.
get Text() String Получает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
remove From Parent() Table Of Contents Удаляет элемент от своего родителя.
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 Поиск содержимого элемента для потомка указанного типа.
find Element(elementType, from) Range Element Поиск содержимого элемента для потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Поиск содержимого элемента для указанного текстового шаблона с использованием регулярных выражений.
find Text(searchPattern, from) Range Element Поиск содержимого элемента для указанного текстового шаблона, начиная с данного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Cell(cellIndex) Table Cell Получает Table Cell в указанном индексе ячейки.
get Child(childIndex) Element Получает дочерний элемент в указанном детском индексе.
get Child Index(child) Integer Получает индекс ребенка для указанного дочернего элемента.
get Link Url() String Получает URL -адрес ссылки.
get Minimum Height() Number Получает минимальную высоту, в точках.
get Next Sibling() Element Получает следующий элемент сестра элемента.
get Num Cells() Integer Получает количество ячеек в ряду.
get Num Children() Integer Получает количество детей.
get Parent() Container Element Получает родительский элемент элемента.
get Parent Table() Table Получает Table содержащую текущую строку.
get Previous Sibling() Element Получает предыдущий элемент сестра элемента.
get Text() String Получает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
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 Объединяет элемент с предыдущим братом того же типа.
remove Cell(cellIndex) Table Cell Удаляет Table Cell в указанном индексе ячейки.
remove Child(child) Table Row Удаляет указанный дочерний элемент.
remove From Parent() Table Row Удаляет элемент от своего родителя.
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 Поиск содержимого элемента для указанного текстового шаблона с использованием регулярных выражений.
find Text(searchPattern, from) Range Element Поиск содержимого элемента для указанного текстового шаблона, начиная с данного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Attributes(offset) Object Получает атрибуты при указанном смещении символов.
get Background Color() String Получает настройку цвета фона.
get Background Color(offset) String Получает цвет фона в указанном смещении символов.
get Font Family() String Получает семейную обстановку шрифтов.
get Font Family(offset) String Получает семейство шрифтов в указанное смещение персонажа.
get Font Size() Number Получает настройку размера шрифта.
get Font Size(offset) Number Получает размер шрифта в указанном смещении символов.
get Foreground Color() String Получает настройку цвета переднего плана.
get Foreground Color(offset) String Получает цвет переднего плана при указанном смещении символов.
get Link Url() String Получает URL -адрес ссылки.
get Link Url(offset) String Получает URL -адрес ссылки при указанном смещении символов.
get Next Sibling() Element Получает следующий элемент сестра элемента.
get Parent() Container Element Получает родительский элемент элемента.
get Previous Sibling() Element Получает предыдущий элемент сестра элемента.
get Text() String Получает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
get Text Alignment(offset) Text Alignment Получает выравнивание текста для одного персонажа.
get Text Attribute Indices() Integer[] Получает набор текстовых индексов, которые соответствуют началу отличительных прогонов форматирования текста.
get Type() Element Type Получает Element Type элемента.
insert Text(offset, text) Text Вставьте указанный текст в заданное смещение символов.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
is Bold() Boolean Получает жирную настройку.
is Bold(offset) Boolean Получает смелую настройку при указанном смещении символов.
is Italic() Boolean Получает курсивную обстановку.
is Italic(offset) Boolean Получает курсивную настройку при указанном смещении символов.
is Strikethrough() Boolean Получает настройку удара.
is Strikethrough(offset) Boolean Получает настройку удара при указанном смещении символов.
is Underline() Boolean Получает подчеркивание настройки.
is Underline(offset) Boolean Получает подчеркивание настройки при указанном смещении символов.
merge() Text Объединяет элемент с предыдущим братом того же типа.
remove From Parent() Text Удаляет элемент от своего родителя.
replace Text(searchPattern, replacement) Element Заменяет все входы данного текстового шаблона данной заменяющей строкой, используя регулярные выражения.
set Attributes(startOffset, endOffsetInclusive, attributes) Text Применяет указанные атрибуты к данному диапазону символов.
set Attributes(attributes) Text Устанавливает атрибуты элемента.
set Background Color(startOffset, endOffsetInclusive, color) Text Устанавливает цвет фона для указанного диапазона символов.
set Background Color(color) Text Устанавливает цвет фона.
set Bold(bold) Text Устанавливает жирную настройку.
set Bold(startOffset, endOffsetInclusive, bold) Text Устанавливает настройку жирного шрифта для указанного диапазона символов.
set Font Family(startOffset, endOffsetInclusive, fontFamilyName) Text Устанавливает семейство шрифтов для указанного диапазона символов.
set Font Family(fontFamilyName) Text Устанавливает семью шрифтов.
set Font Size(startOffset, endOffsetInclusive, size) Text Устанавливает размер шрифта для указанного диапазона символов.
set Font Size(size) Text Устанавливает размер шрифта.
set Foreground Color(startOffset, endOffsetInclusive, color) Text Устанавливает цвет переднего плана для указанного диапазона символов.
set Foreground Color(color) Text Устанавливает цвет переднего плана.
set Italic(italic) Text Устанавливает курсивную обстановку.
set Italic(startOffset, endOffsetInclusive, italic) Text Устанавливает курсивную настройку для указанного диапазона символов.
set Link Url(startOffset, endOffsetInclusive, url) Text Устанавливает URL -адрес ссылки для указанного диапазона символов.
set Link Url(url) Text Устанавливает URL -адрес ссылки.
set Strikethrough(strikethrough) Text Устанавливает настройку Strikethrough.
set Strikethrough(startOffset, endOffsetInclusive, strikethrough) Text Устанавливает настройку Strikethrough для указанного диапазона символов.
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 Выравнивание текста SuperScript.
SUBSCRIPT Enum Выравнивание текста подписания.

Unsupported Element

Методы

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

Vertical Alignment

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

Свойство Тип Описание
BOTTOM Enum Вариант выравнивания дна.
CENTER Enum Вариант выравнивания центра.
TOP Enum Вариант высшего выравнивания.
,
Документ

Эта служба позволяет сценариям создавать, получать доступ и изменять файлы 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, такой как файл диска или видео на 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 Поиск содержимого элемента для потомка указанного типа.
find Element(elementType, from) Range Element Поиск содержимого элемента для потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Поиск содержимого элемента для указанного текстового шаблона с использованием регулярных выражений.
find Text(searchPattern, from) Range Element Поиск содержимого элемента для указанного текстового шаблона, начиная с данного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Получает дочерний элемент в указанном детском индексе.
get Child Index(child) Integer Получает индекс ребенка для указанного дочернего элемента.
get Heading Attributes(paragraphHeading) Object Получает набор атрибутов для предусмотренного Paragraph Heading .
get Images() Inline Image[] Извлекает все Inline Images содержащиеся в разделе.
get List Items() List Item[] Извлекает все List Items содержащиеся в разделе.
get Margin Bottom() Number Получает нижний край, в точках.
get Margin Left() Number Получает левый край, в очках.
get Margin Right() Number Получает правильный край.
get Margin Top() Number Получает верхний край.
get Num Children() Integer Получает количество детей.
get Page Height() Number Получает высоту страницы в очках.
get Page Width() Number Получает ширину страницы в очках.
get Paragraphs() Paragraph[] Извлекает все Paragraphs содержащиеся в разделе (включая List Items ).
get Parent() Container Element Получает родительский элемент элемента.
get Tables() Table[] Извлекает все Tables содержащиеся в разделе.
get Text() String Получает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
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 Поиск содержимого элемента для потомка указанного типа.
find Element(elementType, from) Range Element Поиск содержимого элемента для потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Поиск содержимого элемента для указанного текстового шаблона с использованием регулярных выражений.
find Text(searchPattern, from) Range Element Поиск содержимого элемента для указанного текстового шаблона, начиная с данного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Child(childIndex) Element Получает дочерний элемент в указанном детском индексе.
get Child Index(child) Integer Получает индекс ребенка для указанного дочернего элемента.
get Link Url() String Получает URL -адрес ссылки.
get Next Sibling() Element Получает следующий элемент сестра элемента.
get Num Children() Integer Получает количество детей.
get Parent() Container Element Получает родительский элемент элемента.
get Previous Sibling() Element Получает предыдущий элемент сестра элемента.
get Text() String Получает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Container Element Объединяет элемент с предыдущим братом того же типа.
remove From Parent() Container Element Удаляет элемент от своего родителя.
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 Получает следующий элемент сестра элемента.
get Parent() Container Element Получает родительский элемент элемента.
get Previous Sibling() Element Получает предыдущий элемент сестра элемента.
get Timestamp() Date Возвращает метку времени, связанную с датой.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Date Объединяет элемент с предыдущим братом того же типа.
remove From Parent() Date Удаляет элемент от своего родителя.
set Attributes(attributes) Date Устанавливает атрибуты элемента.

Document

Методы

Метод Тип возврата Краткое описание
add Bookmark(position) Bookmark Добавляет Bookmark в данной Position к первой вкладке или, для сценариев, которые связаны с документом, Active Tab.
add Editor(emailAddress) Document Добавляет данного пользователя в список редакторов для Document .
add Editor(user) Document Добавляет данного пользователя в список редакторов для Document .
add Editors(emailAddresses) Document Добавляет заданный массив пользователей в список редакторов для Document .
add Footer() Footer Section Добавляет раздел нижнего колонтитула, если нет, к первой вкладке или, для сценариев, которые связаны с документом, Active Tab.
add Header() Header Section Adds a header section, if none exists, to the first tab or, for scripts that are bound to a document, the active tab.
add Named Range(name, range) Named Range Adds a Named Range , which is a Range that has a name and ID to use for later retrieval, in the first tab or, for scripts that are bound to a document, the active tab.
add Viewer(emailAddress) Document Adds the given user to the list of viewers for the Document .
add Viewer(user) Document Adds the given user to the list of viewers for the Document .
add Viewers(emailAddresses) Document Adds the given array of users to the list of viewers for the Document .
get Active Tab() Tab Gets the user's currently active Tab in the document.
get As(contentType) Blob Retrieves the current Document contents as a blob of the specified type.
get Blob() Blob Retrieves the current Document contents as a blob.
get Body() Body Retrieves the first tab's Body or, for scripts that are bound to a document, the active tab's Document Body Section .
get Bookmark(id) Bookmark Gets the Bookmark with the given ID in the first tab or, for scripts that are bound to a document, the active tab.
get Bookmarks() Bookmark[] Gets all Bookmark objects in the first tab or, for scripts that are bound to a document, the active tab.
get Cursor() Position Gets the user's cursor in the active tab.
get Editors() User[] Gets the list of editors for this Document .
get Footer() Footer Section Retrieves the first tab's footer section or, for scripts that are bound to a document, the active tab's footer section.
get Footnotes() Footnote[] Retrieves all the Footnote elements in the first tab's body or, for scripts that are bound to a document, the active tab's body.
get Header() Header Section Retrieves the first tab's header section or, for scripts that are bound to a document, the active tab's header section.
get Id() String Retrieves the document's unique identifier.
get Language() String Gets the document's language code.
get Name() String Retrieves the title of the document.
get Named Range By Id(id) Named Range Gets the Named Range with the given ID in the first tab or, for scripts that are bound to a document, the active tab.
get Named Ranges() Named Range[] Gets all Named Range objects in the first tab or, for scripts that are bound to a document, the active tab.
get Named Ranges(name) Named Range[] Gets all Named Range objects with the given name in the first tab or, for scripts that are bound to a document, the active tab.
get Selection() Range Gets the user's selection in the active tab.
get Supported Language Codes() String[] Gets all language codes that are supported in Google Docs files.
get Tab(tabId) Tab Gets the Tab with the specified ID.
get Tabs() Tab[] Gets all unnested Tab s that are part of the document.
get Url() String Retrieves the URL to access the current document.
get Viewers() User[] Gets the list of viewers and commenters for this Document .
new Position(element, offset) Position Creates a new Position , which is a reference to a location in the tab, relative to a specific element in the first tab or, for scripts that are bound to a document, the active tab.
new Range() Range Builder Creates a builder used to construct Range objects from tab elements in the first tab or, for scripts that are bound to a document, the active tab.
remove Editor(emailAddress) Document Removes the given user from the list of editors for the Document .
remove Editor(user) Document Removes the given user from the list of editors for the Document .
remove Viewer(emailAddress) Document Removes the given user from the list of viewers and commenters for the Document .
remove Viewer(user) Document Removes the given user from the list of viewers and commenters for the Document .
save And Close() void Saves the current Document .
set Active Tab(tabId) void Sets the user's selected Tab in the current document to the tab with the specified ID.
set Cursor(position) Document Sets the user's cursor, given a Position .
set Language(languageCode) Document Sets the document's language code.
set Name(name) Document Sets the document title.
set Selection(range) Document Sets the user's selection in the active tab, given a Range .

Document App

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

Свойство Тип Описание
Attribute Attribute The Attribute enumeration.
Element Type Element Type The Element Type enumeration.
Font Family Font Family The Font Family enumeration.
Glyph Type Glyph Type The Glyph Type enumeration.
Horizontal Alignment Horizontal Alignment The Horizontal Alignment enumeration.
Paragraph Heading Paragraph Heading The Paragraph Heading enumeration.
Positioned Layout Positioned Layout The Positioned Layout enumeration.
Text Alignment Text Alignment The Text Alignment enumeration.
Vertical Alignment Vertical Alignment The Vertical Alignment enumeration.

Методы

Метод Тип возврата Краткое описание
create(name) Document Creates and returns a new document.
get Active Document() Document Returns the document to which the script is container-bound .
get Ui() Ui Returns an instance of the document's user-interface environment that allows the script to add features like menus, dialogs, and sidebars.
open By Id(id) Document Returns the document with the specified ID.
open By Url(url) Document Opens and returns the document with the specified URL.

Document Tab

Методы

Метод Тип возврата Краткое описание
add Bookmark(position) Bookmark Adds a Bookmark at the given Position .
add Footer() Footer Section Adds a tab footer section, if none exists.
add Header() Header Section Adds a tab header section, if none exists.
add Named Range(name, range) Named Range Adds a Named Range , which is a Range that has a name and ID to use for later retrieval.
get Body() Body Retrieves the tab's Body .
get Bookmark(id) Bookmark Gets the Bookmark with the given ID.
get Bookmarks() Bookmark[] Gets all Bookmark objects in the tab.
get Footer() Footer Section Retrieves the tab's footer section, if one exists.
get Footnotes() Footnote[] Retrieves all the Footnote elements in the tab's body.
get Header() Header Section Retrieves the tab's header section, if one exists.
get Named Range By Id(id) Named Range Gets the Named Range with the given ID.
get Named Ranges() Named Range[] Gets all Named Range objects in the tab.
get Named Ranges(name) Named Range[] Gets all Named Range objects in the tab with the given name.
new Position(element, offset) Position Creates a new Position , which is a reference to a location in the tab, relative to a specific element.
new Range() Range Builder Creates a builder used to construct Range objects from tab elements.

Element

Методы

Метод Тип возврата Краткое описание
as Body() Body Returns the current element as a Body .
as Date() Date Returns the current element as a Date .
as Equation() Equation Returns the current element as an Equation .
as Equation Function() Equation Function Returns the current element as a Equation Function .
as Equation Function Argument Separator() Equation Function Argument Separator Returns the current element as a Equation Function Argument Separator .
as Equation Symbol() Equation Symbol Returns the current element as a Equation Symbol .
as Footer Section() Footer Section Returns the current element as a Footer Section .
as Footnote() Footnote Returns the current element as a Footnote .
as Footnote Section() Footnote Section Returns the current element as a Footnote Section .
as Header Section() Header Section Returns the current element as a Header Section .
as Horizontal Rule() Horizontal Rule Returns the current element as a Horizontal Rule .
as Inline Drawing() Inline Drawing Returns the current element as a Inline Drawing .
as Inline Image() Inline Image Returns the current element as a Inline Image .
as List Item() List Item Returns the current element as a List Item .
as Page Break() Page Break Returns the current element as a Page Break .
as Paragraph() Paragraph Returns the current element as a Paragraph .
as Person() Person Returns the current element as a Person .
as Rich Link() Rich Link Returns the current element as a Rich Link , for example, a link to a Google Sheets file.
as Table() Table Returns the current element as a Table .
as Table Cell() Table Cell Returns the current element as a Table Cell .
as Table Of Contents() Table Of Contents Returns the current element as a Table Of Contents .
as Table Row() Table Row Returns the current element as a Table Row .
as Text() Text Returns the current element as a Text .
copy() Element Returns a detached, deep copy of the current element.
get Attributes() Object Retrieves the element's attributes.
get Next Sibling() Element Retrieves the element's next sibling element.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Type() Element Type Retrieves the element's Element Type .
is At Document End() Boolean Determines whether the element is at the end of the Document .
merge() Element Merges the element with the preceding sibling of the same type.
remove From Parent() Element Removes the element from its parent.
set Attributes(attributes) Element Sets the element's attributes.

Element Type

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

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

Equation

Методы

Метод Тип возврата Краткое описание
clear() Equation Clears the contents of the element.
copy() Equation Returns a detached, deep copy of the current element.
edit As Text() Text Obtains a Text version of the current element, for editing.
find Element(elementType) Range Element Searches the contents of the element for a descendant of the specified type.
find Element(elementType, from) Range Element Searches the contents of the element for a descendant of the specified type, starting from the specified Range Element .
find Text(searchPattern) Range Element Searches the contents of the element for the specified text pattern using regular expressions.
find Text(searchPattern, from) Range Element Searches the contents of the element for the specified text pattern, starting from a given search result.
get Attributes() Object Retrieves the element's attributes.
get Child(childIndex) Element Retrieves the child element at the specified child index.
get Child Index(child) Integer Retrieves the child index for the specified child element.
get Link Url() String Retrieves the link url.
get Next Sibling() Element Retrieves the element's next sibling element.
get Num Children() Integer Retrieves the number of children.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Text() String Retrieves the contents of the element as a text string.
get Text Alignment() Text Alignment Gets the text alignment.
get Type() Element Type Retrieves the element's Element Type .
is At Document End() Boolean Determines whether the element is at the end of the Document .
merge() Equation Merges the element with the preceding sibling of the same type.
remove From Parent() Equation Removes the element from its parent.
replace Text(searchPattern, replacement) Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
set Attributes(attributes) Equation Sets the element's attributes.
set Link Url(url) Equation Sets the link url.
set Text Alignment(textAlignment) Equation Sets the text alignment.

Equation Function

Методы

Метод Тип возврата Краткое описание
clear() Equation Function Clears the contents of the element.
copy() Equation Function Returns a detached, deep copy of the current element.
edit As Text() Text Obtains a Text version of the current element, for editing.
find Element(elementType) Range Element Searches the contents of the element for a descendant of the specified type.
find Element(elementType, from) Range Element Searches the contents of the element for a descendant of the specified type, starting from the specified Range Element .
find Text(searchPattern) Range Element Searches the contents of the element for the specified text pattern using regular expressions.
find Text(searchPattern, from) Range Element Searches the contents of the element for the specified text pattern, starting from a given search result.
get Attributes() Object Retrieves the element's attributes.
get Child(childIndex) Element Retrieves the child element at the specified child index.
get Child Index(child) Integer Retrieves the child index for the specified child element.
get Code() String Retrieves the code corresponding to the equation function.
get Link Url() String Retrieves the link url.
get Next Sibling() Element Retrieves the element's next sibling element.
get Num Children() Integer Retrieves the number of children.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Text() String Retrieves the contents of the element as a text string.
get Text Alignment() Text Alignment Gets the text alignment.
get Type() Element Type Retrieves the element's Element Type .
is At Document End() Boolean Determines whether the element is at the end of the Document .
merge() Equation Function Merges the element with the preceding sibling of the same type.
remove From Parent() Equation Function Removes the element from its parent.
replace Text(searchPattern, replacement) Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
set Attributes(attributes) Equation Function Sets the element's attributes.
set Link Url(url) Equation Function Sets the link url.
set Text Alignment(textAlignment) Equation Function Sets the text alignment.

Equation Function Argument Separator

Методы

Метод Тип возврата Краткое описание
copy() Equation Function Argument Separator Returns a detached, deep copy of the current element.
get Attributes() Object Retrieves the element's attributes.
get Next Sibling() Element Retrieves the element's next sibling element.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Type() Element Type Retrieves the element's Element Type .
is At Document End() Boolean Determines whether the element is at the end of the Document .
merge() Equation Function Argument Separator Merges the element with the preceding sibling of the same type.
remove From Parent() Equation Function Argument Separator Removes the element from its parent.
set Attributes(attributes) Equation Function Argument Separator Sets the element's attributes.

Equation Symbol

Методы

Метод Тип возврата Краткое описание
copy() Equation Symbol Returns a detached, deep copy of the current element.
get Attributes() Object Retrieves the element's attributes.
get Code() String Retrieves the code corresponding to the equation symbol.
get Next Sibling() Element Retrieves the element's next sibling element.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Type() Element Type Retrieves the element's Element Type .
is At Document End() Boolean Determines whether the element is at the end of the Document .
merge() Equation Symbol Merges the element with the preceding sibling of the same type.
remove From Parent() Equation Symbol Removes the element from its parent.
set Attributes(attributes) Equation Symbol Sets the element's attributes.

Font Family

Footer Section

Методы

Метод Тип возврата Краткое описание
append Horizontal Rule() Horizontal Rule Creates and appends a new Horizontal Rule .
append Image(image) Inline Image Creates and appends a new Inline Image from the specified image blob.
append Image(image) Inline Image Appends the given Inline Image .
append List Item(listItem) List Item Appends the given List Item .
append List Item(text) List Item Создает и добавляет новый List Item содержащий указанное текстовое содержимое.
append Paragraph(paragraph) Paragraph Appends the given Paragraph .
append Paragraph(text) Paragraph Создает и добавляет новый Paragraph содержащий указанное текстовое содержимое.
append Table() Table Creates and appends a new Table .
append Table(cells) Table Добавляет новую Table , содержащую Table Cell для каждого указанного строкового значения.
append Table(table) Table Appends the given Table .
clear() Footer Section Clears the contents of the element.
copy() Footer Section Returns a detached, deep copy of the current element.
edit As Text() Text Obtains a Text version of the current element, for editing.
find Element(elementType) Range Element Searches the contents of the element for a descendant of the specified type.
find Element(elementType, from) Range Element Searches the contents of the element for a descendant of the specified type, starting from the specified Range Element .
find Text(searchPattern) Range Element Searches the contents of the element for the specified text pattern using regular expressions.
find Text(searchPattern, from) Range Element Searches the contents of the element for the specified text pattern, starting from a given search result.
get Attributes() Object Retrieves the element's attributes.
get Child(childIndex) Element Retrieves the child element at the specified child index.
get Child Index(child) Integer Retrieves the child index for the specified child element.
get Images() Inline Image[] Извлекает все Inline Images содержащиеся в разделе.
get List Items() List Item[] Извлекает все List Items содержащиеся в разделе.
get Num Children() Integer Retrieves the number of children.
get Paragraphs() Paragraph[] Извлекает все Paragraphs содержащиеся в разделе (включая List Items ).
get Parent() Container Element Retrieves the element's parent element.
get Tables() Table[] Извлекает все Tables содержащиеся в разделе.
get Text() String Retrieves the contents of the element as a text string.
get Text Alignment() Text Alignment Gets the text alignment.
get Type() Element Type Retrieves the element's Element Type .
insert Horizontal Rule(childIndex) Horizontal Rule Creates and inserts a new Horizontal Rule at the specified index.
insert Image(childIndex, image) Inline Image Creates and inserts an Inline Image from the specified image blob, at the specified index.
insert Image(childIndex, image) Inline Image Inserts the given Inline Image at the specified index.
insert List Item(childIndex, listItem) List Item Inserts the given List Item at the specified index.
insert List Item(childIndex, text) List Item Создает и вставляет новый List Item по указанному индексу, содержащий указанное текстовое содержимое.
insert Paragraph(childIndex, paragraph) Paragraph Inserts the given Paragraph at the specified index.
insert Paragraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.
insert Table(childIndex) Table Creates and inserts a new Table at the specified index.
insert Table(childIndex, cells) Table Creates and inserts a new Table containing the specified cells, at the specified index.
insert Table(childIndex, table) Table Inserts the given Table at the specified index.
remove Child(child) Footer Section Removes the specified child element.
remove From Parent() Footer Section Removes the element from its parent.
replace Text(searchPattern, replacement) Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
set Attributes(attributes) Footer Section Sets the element's attributes.
set Text(text) Footer Section Sets the contents as plain text.
set Text Alignment(textAlignment) Footer Section Sets the text alignment.

Footnote

Методы

Метод Тип возврата Краткое описание
copy() Footnote Returns a detached, deep copy of the current element.
get Attributes() Object Retrieves the element's attributes.
get Footnote Contents() Footnote Section Retrieves the contents of the footnote element.
get Next Sibling() Element Retrieves the element's next sibling element.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Type() Element Type Retrieves the element's Element Type .
is At Document End() Boolean Determines whether the element is at the end of the Document .
remove From Parent() Footnote Removes the element from its parent.
set Attributes(attributes) Footnote Sets the element's attributes.

Footnote Section

Методы

Метод Тип возврата Краткое описание
append Paragraph(paragraph) Paragraph Appends the given Paragraph .
append Paragraph(text) Paragraph Создает и добавляет новый Paragraph содержащий указанное текстовое содержимое.
clear() Footnote Section Clears the contents of the element.
copy() Footnote Section Returns a detached, deep copy of the current element.
edit As Text() Text Obtains a Text version of the current element, for editing.
find Element(elementType) Range Element Searches the contents of the element for a descendant of the specified type.
find Element(elementType, from) Range Element Searches the contents of the element for a descendant of the specified type, starting from the specified Range Element .
find Text(searchPattern) Range Element Searches the contents of the element for the specified text pattern using regular expressions.
find Text(searchPattern, from) Range Element Searches the contents of the element for the specified text pattern, starting from a given search result.
get Attributes() Object Retrieves the element's attributes.
get Child(childIndex) Element Retrieves the child element at the specified child index.
get Child Index(child) Integer Retrieves the child index for the specified child element.
get Next Sibling() Element Retrieves the element's next sibling element.
get Num Children() Integer Retrieves the number of children.
get Paragraphs() Paragraph[] Извлекает все Paragraphs содержащиеся в разделе (включая List Items ).
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Text() String Retrieves the contents of the element as a text string.
get Text Alignment() Text Alignment Gets the text alignment.
get Type() Element Type Retrieves the element's Element Type .
insert Paragraph(childIndex, paragraph) Paragraph Inserts the given Paragraph at the specified index.
insert Paragraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.
remove Child(child) Footnote Section Removes the specified child element.
remove From Parent() Footnote Section Removes the element from its parent.
replace Text(searchPattern, replacement) Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
set Attributes(attributes) Footnote Section Sets the element's attributes.
set Text(text) Footnote Section Sets the contents as plain text.
set Text Alignment(textAlignment) Footnote Section Sets the text alignment.

Glyph Type

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

Свойство Тип Описание
BULLET Enum The default bullet, circular and filled.
HOLLOW_BULLET Enum A hollow bullet.
SQUARE_BULLET Enum A square bullet.
NUMBER Enum A number based bullet.
LATIN_UPPER Enum A latin, uppercase bullet.
LATIN_LOWER Enum A latin, lowercase bullet.
ROMAN_UPPER Enum A roman numeral, uppercase bullet.
ROMAN_LOWER Enum A roman numeral, lowercase bullet.

Header Section

Методы

Метод Тип возврата Краткое описание
append Horizontal Rule() Horizontal Rule Creates and appends a new Horizontal Rule .
append Image(image) Inline Image Creates and appends a new Inline Image from the specified image blob.
append Image(image) Inline Image Appends the given Inline Image .
append List Item(listItem) List Item Appends the given List Item .
append List Item(text) List Item Создает и добавляет новый List Item содержащий указанное текстовое содержимое.
append Paragraph(paragraph) Paragraph Appends the given Paragraph .
append Paragraph(text) Paragraph Создает и добавляет новый Paragraph содержащий указанное текстовое содержимое.
append Table() Table Creates and appends a new Table .
append Table(cells) Table Добавляет новую Table , содержащую Table Cell для каждого указанного строкового значения.
append Table(table) Table Appends the given Table .
clear() Header Section Clears the contents of the element.
copy() Header Section Returns a detached, deep copy of the current element.
edit As Text() Text Obtains a Text version of the current element, for editing.
find Element(elementType) Range Element Searches the contents of the element for a descendant of the specified type.
find Element(elementType, from) Range Element Searches the contents of the element for a descendant of the specified type, starting from the specified Range Element .
find Text(searchPattern) Range Element Searches the contents of the element for the specified text pattern using regular expressions.
find Text(searchPattern, from) Range Element Searches the contents of the element for the specified text pattern, starting from a given search result.
get Attributes() Object Retrieves the element's attributes.
get Child(childIndex) Element Retrieves the child element at the specified child index.
get Child Index(child) Integer Retrieves the child index for the specified child element.
get Images() Inline Image[] Извлекает все Inline Images содержащиеся в разделе.
get List Items() List Item[] Извлекает все List Items содержащиеся в разделе.
get Num Children() Integer Retrieves the number of children.
get Paragraphs() Paragraph[] Извлекает все Paragraphs содержащиеся в разделе (включая List Items ).
get Parent() Container Element Retrieves the element's parent element.
get Tables() Table[] Извлекает все Tables содержащиеся в разделе.
get Text() String Retrieves the contents of the element as a text string.
get Text Alignment() Text Alignment Gets the text alignment.
get Type() Element Type Retrieves the element's Element Type .
insert Horizontal Rule(childIndex) Horizontal Rule Creates and inserts a new Horizontal Rule at the specified index.
insert Image(childIndex, image) Inline Image Creates and inserts an Inline Image from the specified image blob, at the specified index.
insert Image(childIndex, image) Inline Image Inserts the given Inline Image at the specified index.
insert List Item(childIndex, listItem) List Item Inserts the given List Item at the specified index.
insert List Item(childIndex, text) List Item Создает и вставляет новый List Item по указанному индексу, содержащий указанное текстовое содержимое.
insert Paragraph(childIndex, paragraph) Paragraph Inserts the given Paragraph at the specified index.
insert Paragraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.
insert Table(childIndex) Table Creates and inserts a new Table at the specified index.
insert Table(childIndex, cells) Table Creates and inserts a new Table containing the specified cells, at the specified index.
insert Table(childIndex, table) Table Inserts the given Table at the specified index.
remove Child(child) Header Section Removes the specified child element.
remove From Parent() Header Section Removes the element from its parent.
replace Text(searchPattern, replacement) Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
set Attributes(attributes) Header Section Sets the element's attributes.
set Text(text) Header Section Sets the contents as plain text.
set Text Alignment(textAlignment) Header Section Sets the text alignment.

Horizontal Alignment

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

Свойство Тип Описание
LEFT Enum The left-alignment option.
CENTER Enum The center-alignment option.
RIGHT Enum The right-alignment option.
JUSTIFY Enum The justify-alignment option.

Horizontal Rule

Методы

Метод Тип возврата Краткое описание
copy() Horizontal Rule Returns a detached, deep copy of the current element.
get Attributes() Object Retrieves the element's attributes.
get Next Sibling() Element Retrieves the element's next sibling element.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Type() Element Type Retrieves the element's Element Type .
is At Document End() Boolean Determines whether the element is at the end of the Document .
remove From Parent() Horizontal Rule Removes the element from its parent.
set Attributes(attributes) Horizontal Rule Sets the element's attributes.

Inline Drawing

Методы

Метод Тип возврата Краткое описание
copy() Inline Drawing Returns a detached, deep copy of the current element.
get Alt Description() String Returns the drawing's alternate description.
get Alt Title() String Returns the drawing's alternate title.
get Attributes() Object Retrieves the element's attributes.
get Next Sibling() Element Retrieves the element's next sibling element.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Type() Element Type Retrieves the element's Element Type .
is At Document End() Boolean Determines whether the element is at the end of the Document .
merge() Inline Drawing Merges the element with the preceding sibling of the same type.
remove From Parent() Inline Drawing Removes the element from its parent.
set Alt Description(description) Inline Drawing Sets the drawing's alternate description.
set Alt Title(title) Inline Drawing Sets the drawing's alternate title.
set Attributes(attributes) Inline Drawing Sets the element's attributes.

Inline Image

Методы

Метод Тип возврата Краткое описание
copy() Inline Image Returns a detached, deep copy of the current element.
get Alt Description() String Returns the image's alternate description.
get Alt Title() String Returns the image's alternate title.
get As(contentType) Blob Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
get Attributes() Object Retrieves the element's attributes.
get Blob() Blob Верните данные внутри этого объекта в виде большого двоичного объекта.
get Height() Integer Retrieves the image's height, in pixels.
get Link Url() String Retrieves the link URL.
get Next Sibling() Element Retrieves the element's next sibling element.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Type() Element Type Retrieves the element's Element Type .
get Width() Integer Retrieves the image's width, in pixels.
is At Document End() Boolean Determines whether the element is at the end of the Document .
merge() Inline Image Merges the element with the preceding sibling of the same type.
remove From Parent() Inline Image Removes the element from its parent.
set Alt Description(description) Inline Image Sets the image's alternate description.
set Alt Title(title) Inline Image Sets the image's alternate title.
set Attributes(attributes) Inline Image Sets the element's attributes.
set Height(height) Inline Image Sets the image's height, in pixels.
set Link Url(url) Inline Image Sets the link URL.
set Width(width) Inline Image Sets the image's width, in pixels.

List Item

Методы

Метод Тип возврата Краткое описание
add Positioned Image(image) Positioned Image Creates and inserts a new Positioned Image from the specified image blob.
append Horizontal Rule() Horizontal Rule Creates and appends a new Horizontal Rule .
append Inline Image(image) Inline Image Creates and appends a new Inline Image from the specified image blob.
append Inline Image(image) Inline Image Appends the given Inline Image .
append Page Break() Page Break Creates and appends a new Page Break .
append Page Break(pageBreak) Page Break Appends the given Page Break .
append Text(text) Text Creates and appends a new Text element with the specified contents.
append Text(text) Text Appends the given Text element.
clear() List Item Clears the contents of the element.
copy() List Item Returns a detached, deep copy of the current element.
edit As Text() Text Obtains a Text version of the current element, for editing.
find Element(elementType) Range Element Searches the contents of the element for a descendant of the specified type.
find Element(elementType, from) Range Element Searches the contents of the element for a descendant of the specified type, starting from the specified Range Element .
find Text(searchPattern) Range Element Searches the contents of the element for the specified text pattern using regular expressions.
find Text(searchPattern, from) Range Element Searches the contents of the element for the specified text pattern, starting from a given search result.
get Alignment() Horizontal Alignment Retrieves the Horizontal Alignment .
get Attributes() Object Retrieves the element's attributes.
get Child(childIndex) Element Retrieves the child element at the specified child index.
get Child Index(child) Integer Retrieves the child index for the specified child element.
get Glyph Type() Glyph Type Retrieves the list item's Glyph Type .
get Heading() Paragraph Heading Retrieves the Paragraph Heading .
get Indent End() Number Retrieves the end indentation, in points.
get Indent First Line() Number Retrieves the first line indentation, in points.
get Indent Start() Number Retrieves the start indentation.
get Line Spacing() Number Retrieves the line spacing, in points.
get Link Url() String Retrieves the link url.
get List Id() String Retrieves the list ID.
get Nesting Level() Integer Retrieves the list item's nesting level.
get Next Sibling() Element Retrieves the element's next sibling element.
get Num Children() Integer Retrieves the number of children.
get Parent() Container Element Retrieves the element's parent element.
get Positioned Image(id) Positioned Image Gets a Positioned Image by the image's ID.
get Positioned Images() Positioned Image[] Gets all Positioned Image objects anchored to the paragraph.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Spacing After() Number Retrieves the spacing after the element, in points.
get Spacing Before() Number Retrieves the spacing before the element, in points.
get Text() String Retrieves the contents of the element as a text string.
get Text Alignment() Text Alignment Gets the text alignment.
get Type() Element Type Retrieves the element's Element Type .
insert Horizontal Rule(childIndex) Horizontal Rule Creates and inserts a Horizontal Rule at the specified index.
insert Inline Image(childIndex, image) Inline Image Creates and inserts a new Inline Image from the specified image blob, at the specified index.
insert Inline Image(childIndex, image) Inline Image Inserts the given Inline Image at the specified index.
insert Page Break(childIndex) Page Break Creates and inserts a new Page Break at the specified index.
insert Page Break(childIndex, pageBreak) Page Break Inserts the given Page Break at the specified index.
insert Text(childIndex, text) Text Creates and inserts a new text element at the specified index.
insert Text(childIndex, text) Text Inserts the given Text element at the specified index, with the specified text contents.
is At Document End() Boolean Determines whether the element is at the end of the Document .
is Left To Right() Boolean Retrieves the left-to-right setting.
merge() List Item Merges the element with the preceding sibling of the same type.
remove Child(child) List Item Removes the specified child element.
remove From Parent() List Item Removes the element from its parent.
remove Positioned Image(id) Boolean Removes a Positioned Image by the image's ID.
replace Text(searchPattern, replacement) Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
set Alignment(alignment) List Item Sets the Horizontal Alignment .
set Attributes(attributes) List Item Sets the element's attributes.
set Glyph Type(glyphType) List Item Sets the list item's Glyph Type .
set Heading(heading) List Item Sets the Paragraph Heading .
set Indent End(indentEnd) List Item Sets the end indentation, in points.
set Indent First Line(indentFirstLine) List Item Sets the first line indentation, in points.
set Indent Start(indentStart) List Item Sets the start indentation, in points.
set Left To Right(leftToRight) List Item Sets the left-to-right setting.
set Line Spacing(multiplier) List Item Sets the line spacing, as a quantity indicating the number of lines to use for spacing.
set Link Url(url) List Item Sets the link url.
set List Id(listItem) List Item Sets the list ID.
set Nesting Level(nestingLevel) List Item Sets the list item's nesting level.
set Spacing After(spacingAfter) List Item Sets the spacing after the element, in points.
set Spacing Before(spacingBefore) List Item Sets the spacing before the element, in points.
set Text(text) void Sets the contents of the list item as text.
set Text Alignment(textAlignment) List Item Sets the text alignment.

Named Range

Методы

Метод Тип возврата Краткое описание
get Id() String Gets the ID of this Named Range .
get Name() String Gets the name of this Named Range .
get Range() Range Gets the range of elements associated with this Named Range .
remove() void Removes this Named Range from the tab.

Page Break

Методы

Метод Тип возврата Краткое описание
copy() Page Break Returns a detached, deep copy of the current element.
get Attributes() Object Retrieves the element's attributes.
get Next Sibling() Element Retrieves the element's next sibling element.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Type() Element Type Retrieves the element's Element Type .
is At Document End() Boolean Determines whether the element is at the end of the Document .
remove From Parent() Page Break Removes the element from its parent.
set Attributes(attributes) Page Break Sets the element's attributes.

Paragraph

Методы

Метод Тип возврата Краткое описание
add Positioned Image(image) Positioned Image Creates and inserts a new Positioned Image from the specified image blob.
append Horizontal Rule() Horizontal Rule Creates and appends a new Horizontal Rule .
append Inline Image(image) Inline Image Creates and appends a new Inline Image from the specified image blob.
append Inline Image(image) Inline Image Appends the given Inline Image .
append Page Break() Page Break Creates and appends a new Page Break .
append Page Break(pageBreak) Page Break Appends the given Page Break .
append Text(text) Text Creates and appends a new Text element with the specified contents.
append Text(text) Text Appends the given Text element.
clear() Paragraph Clears the contents of the element.
copy() Paragraph Returns a detached, deep copy of the current element.
edit As Text() Text Obtains a Text version of the current element, for editing.
find Element(elementType) Range Element Searches the contents of the element for a descendant of the specified type.
find Element(elementType, from) Range Element Searches the contents of the element for a descendant of the specified type, starting from the specified Range Element .
find Text(searchPattern) Range Element Searches the contents of the element for the specified text pattern using regular expressions.
find Text(searchPattern, from) Range Element Searches the contents of the element for the specified text pattern, starting from a given search result.
get Alignment() Horizontal Alignment Retrieves the Horizontal Alignment .
get Attributes() Object Retrieves the element's attributes.
get Child(childIndex) Element Retrieves the child element at the specified child index.
get Child Index(child) Integer Retrieves the child index for the specified child element.
get Heading() Paragraph Heading Retrieves the Paragraph Heading .
get Indent End() Number Retrieves the end indentation, in points.
get Indent First Line() Number Retrieves the first line indentation, in points.
get Indent Start() Number Retrieves the start indentation.
get Line Spacing() Number Retrieves the line spacing, in points.
get Link Url() String Retrieves the link url.
get Next Sibling() Element Retrieves the element's next sibling element.
get Num Children() Integer Retrieves the number of children.
get Parent() Container Element Retrieves the element's parent element.
get Positioned Image(id) Positioned Image Gets a Positioned Image by the image's ID.
get Positioned Images() Positioned Image[] Gets all Positioned Image objects anchored to the paragraph.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Spacing After() Number Retrieves the spacing after the element, in points.
get Spacing Before() Number Retrieves the spacing before the element, in points.
get Text() String Retrieves the contents of the element as a text string.
get Text Alignment() Text Alignment Gets the text alignment.
get Type() Element Type Retrieves the element's Element Type .
insert Horizontal Rule(childIndex) Horizontal Rule Creates and inserts a Horizontal Rule at the specified index.
insert Inline Image(childIndex, image) Inline Image Creates and inserts a new Inline Image from the specified image blob, at the specified index.
insert Inline Image(childIndex, image) Inline Image Inserts the given Inline Image at the specified index.
insert Page Break(childIndex) Page Break Creates and inserts a new Page Break at the specified index.
insert Page Break(childIndex, pageBreak) Page Break Inserts the given Page Break at the specified index.
insert Text(childIndex, text) Text Creates and inserts a new text element at the specified index.
insert Text(childIndex, text) Text Inserts the given Text element at the specified index, with the specified text contents.
is At Document End() Boolean Determines whether the element is at the end of the Document .
is Left To Right() Boolean Retrieves the left-to-right setting.
merge() Paragraph Merges the element with the preceding sibling of the same type.
remove Child(child) Paragraph Removes the specified child element.
remove From Parent() Paragraph Removes the element from its parent.
remove Positioned Image(id) Boolean Removes a Positioned Image by the image's ID.
replace Text(searchPattern, replacement) Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
set Alignment(alignment) Paragraph Sets the Horizontal Alignment .
set Attributes(attributes) Paragraph Sets the element's attributes.
set Heading(heading) Paragraph Sets the Paragraph Heading .
set Indent End(indentEnd) Paragraph Sets the end indentation, in points.
set Indent First Line(indentFirstLine) Paragraph Sets the first line indentation, in points.
set Indent Start(indentStart) Paragraph Sets the start indentation, in points.
set Left To Right(leftToRight) Paragraph Sets the left-to-right setting.
set Line Spacing(multiplier) Paragraph Sets the line spacing, as a quantity indicating the number of lines to use for spacing.
set Link Url(url) Paragraph Sets the link url.
set Spacing After(spacingAfter) Paragraph Sets the spacing after the element, in points.
set Spacing Before(spacingBefore) Paragraph Sets the spacing before the element, in points.
set Text(text) void Sets the contents of the paragraph as text.
set Text Alignment(textAlignment) Paragraph Sets the text alignment.

Paragraph Heading

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

Свойство Тип Описание
NORMAL Enum The heading option for normal text.
HEADING1 Enum The highest heading option.
HEADING2 Enum The second heading option.
HEADING3 Enum The third heading option
HEADING4 Enum The fourth heading option.
HEADING5 Enum The fifth heading option.
HEADING6 Enum The lowest heading option.
TITLE Enum The title heading option.
SUBTITLE Enum The subtitle heading option.

Person

Методы

Метод Тип возврата Краткое описание
copy() Person Returns a detached, deep copy of the current element.
get Attributes() Object Retrieves the element's attributes.
get Email() String Returns the person's email address.
get Name() String Returns the person's display name, if set.
get Next Sibling() Element Retrieves the element's next sibling element.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Type() Element Type Retrieves the element's Element Type .
is At Document End() Boolean Determines whether the element is at the end of the Document .
merge() Person Merges the element with the preceding sibling of the same type.
remove From Parent() Person Removes the element from its parent.
set Attributes(attributes) Person Sets the element's attributes.

Position

Методы

Метод Тип возврата Краткое описание
get Element() Element Gets the element that contains this Position .
get Offset() Integer Gets this Position 's relative location within the element that contains it.
get Surrounding Text() Text Creates an artificial Text element that represents the text and formatting of the Paragraph or List Item that contains the Position , either directly or through a chain of child elements.
get Surrounding Text Offset() Integer Gets the offset of this Position within the Text element returned by get Surrounding Text() .
insert Bookmark() Bookmark Creates and inserts a new Bookmark at this Position .
insert Inline Image(image) Inline Image Creates and inserts a new Inline Image at this Position from the specified image blob.
insert Text(text) Text Inserts the specified text at this Position .

Positioned Image

Методы

Метод Тип возврата Краткое описание
get As(contentType) Blob Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
get Blob() Blob Верните данные внутри этого объекта в виде большого двоичного объекта.
get Height() Integer Retrieves the image's height, in pixels.
get Id() String Gets the image's ID.
get Layout() Positioned Layout Gets an enum value that represents how the image is laid out.
get Left Offset() Number Gets the image's offset, in points, from the paragraph's left.
get Paragraph() Paragraph Gets the Paragraph the image is anchored to.
get Top Offset() Number Gets the image's offset, in points, from the paragraph's top.
get Width() Integer Retrieves the image's width, in pixels.
set Height(height) Positioned Image Sets the image's height, in pixels.
set Layout(layout) Positioned Image Sets the definition of how the image is laid out.
set Left Offset(offset) Positioned Image Sets the image's offset, in points, from the paragraph's left.
set Top Offset(offset) Positioned Image Sets the image's offset, in points, from the paragraph's top.
set Width(width) Positioned Image Sets the image's width, in pixels.

Positioned Layout

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

Свойство Тип Описание
ABOVE_TEXT Enum The image is positioned above the text.
BREAK_BOTH Enum The image breaks the text on the left and right.
BREAK_LEFT Enum The image breaks the text on the left.
BREAK_RIGHT Enum The image breaks the text on the right.
WRAP_TEXT Enum The image is wrapped by text.

Range

Методы

Метод Тип возврата Краткое описание
get Range Elements() Range Element[] Gets all elements in this Range , including any partial Text elements (for example, in the case of a selection that includes only part of a Text element).

Range Builder

Методы

Метод Тип возврата Краткое описание
add Element(element) Range Builder Adds an entire Element to this Range Builder .
add Element(textElement, startOffset, endOffsetInclusive) Range Builder Adds a partial Text element to this Range Builder .
add Elements Between(startElement, endElementInclusive) Range Builder Adds two entire elements, and all elements between them, to this Range Builder .
add Elements Between(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) Range Builder Adds two partial Text elements, and all elements between them, to the Range Builder .
add Range(range) Range Builder Adds the contents of another Range to this Range Builder .
build() Range Constructs a Range from the settings applied to the builder.
get Range Elements() Range Element[] Gets all elements in this Range , including any partial Text elements (for example, in the case of a selection that includes only part of a Text element).

Range Element

Методы

Метод Тип возврата Краткое описание
get Element() Element Gets the Element that corresponds to this Range Element .
get End Offset Inclusive() Integer Gets the position of the end of a partial range within the range element.
get Start Offset() Integer Gets the position of the start of a partial range within the range element.
is Partial() Boolean Determines whether this range element covers the entire element or a partial selection of the element's characters.

Методы

Метод Тип возврата Краткое описание
copy() Rich Link Returns a detached, deep copy of the current element.
get Attributes() Object Retrieves the element's attributes.
get Mime Type() String Returns the MIME type of the link, which is available when the item is a link to a Drive file and null otherwise.
get Next Sibling() Element Retrieves the element's next sibling element.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Title() String Returns the link's displayed title.
get Type() Element Type Retrieves the element's Element Type .
get Url() String Returns the URL of the resource.
is At Document End() Boolean Determines whether the element is at the end of the Document .
merge() Rich Link Merges the element with the preceding sibling of the same type.
remove From Parent() Rich Link Removes the element from its parent.
set Attributes(attributes) Rich Link Sets the element's attributes.

Tab

Методы

Метод Тип возврата Краткое описание
as Document Tab() Document Tab Retrieves the tab contents as a Document Tab .
get Child Tabs() Tab[] Retrieves the child tabs nested within this tab.
get Id() String Retrieves the ID of the tab.
get Index() Integer Retrieves the 0-based index of the tab within the parent.
get Title() String Retrieves the title of the tab.
get Type() Tab Type Retrieves the type of tab.

Tab Type

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

Свойство Тип Описание
DOCUMENT_TAB Enum The type corresponding to Document Tab .

Table

Методы

Метод Тип возврата Краткое описание
append Table Row() Table Row Создает и добавляет новую Table Row .
append Table Row(tableRow) Table Row Добавляет данную Table Row .
clear() Table Clears the contents of the element.
copy() Table Returns a detached, deep copy of the current element.
edit As Text() Text Obtains a Text version of the current element, for editing.
find Element(elementType) Range Element Searches the contents of the element for a descendant of the specified type.
find Element(elementType, from) Range Element Searches the contents of the element for a descendant of the specified type, starting from the specified Range Element .
find Text(searchPattern) Range Element Searches the contents of the element for the specified text pattern using regular expressions.
find Text(searchPattern, from) Range Element Searches the contents of the element for the specified text pattern, starting from a given search result.
get Attributes() Object Retrieves the element's attributes.
get Border Color() String Получает цвет границы.
get Border Width() Number Получает ширину границы в пунктах.
get Cell(rowIndex, cellIndex) Table Cell Извлекает Table Cell по указанным индексам строки и ячейки.
get Child(childIndex) Element Retrieves the child element at the specified child index.
get Child Index(child) Integer Retrieves the child index for the specified child element.
get Column Width(columnIndex) Number Получает ширину указанного столбца таблицы в пунктах.
get Link Url() String Retrieves the link url.
get Next Sibling() Element Retrieves the element's next sibling element.
get Num Children() Integer Retrieves the number of children.
get Num Rows() Integer Получает количество Table Rows .
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Row(rowIndex) Table Row Извлекает Table Row по указанному индексу строки.
get Text() String Retrieves the contents of the element as a text string.
get Text Alignment() Text Alignment Gets the text alignment.
get Type() Element Type Retrieves the element's Element Type .
insert Table Row(childIndex) Table Row Создает и вставляет новую Table Row по указанному индексу.
insert Table Row(childIndex, tableRow) Table Row Вставляет данную Table Row по указанному индексу.
is At Document End() Boolean Determines whether the element is at the end of the Document .
remove Child(child) Table Removes the specified child element.
remove From Parent() Table Removes the element from its parent.
remove Row(rowIndex) Table Row Удаляет Table Row по указанному индексу строки.
replace Text(searchPattern, replacement) Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
set Attributes(attributes) Table Sets the element's attributes.
set Border Color(color) Table Устанавливает цвет границы.
set Border Width(width) Table Sets the border width, in points.
set Column Width(columnIndex, width) Table Устанавливает ширину указанного столбца в пунктах.
set Link Url(url) Table Sets the link url.
set Text Alignment(textAlignment) Table Sets the text alignment.

Table Cell

Методы

Метод Тип возврата Краткое описание
append Horizontal Rule() Horizontal Rule Creates and appends a new Horizontal Rule .
append Image(image) Inline Image Creates and appends a new Inline Image from the specified image blob.
append Image(image) Inline Image Appends the given Inline Image .
append List Item(listItem) List Item Appends the given List Item .
append List Item(text) List Item Creates and appends a new List Item .
append Paragraph(paragraph) Paragraph Appends the given Paragraph .
append Paragraph(text) Paragraph Creates and appends a new Paragraph .
append Table() Table Creates and appends a new Table .
append Table(cells) Table Appends a new Table containing the specified cells.
append Table(table) Table Appends the given Table .
clear() Table Cell Clears the contents of the element.
copy() Table Cell Returns a detached, deep copy of the current element.
edit As Text() Text Obtains a Text version of the current element, for editing.
find Element(elementType) Range Element Searches the contents of the element for a descendant of the specified type.
find Element(elementType, from) Range Element Searches the contents of the element for a descendant of the specified type, starting from the specified Range Element .
find Text(searchPattern) Range Element Searches the contents of the element for the specified text pattern using regular expressions.
find Text(searchPattern, from) Range Element Searches the contents of the element for the specified text pattern, starting from a given search result.
get Attributes() Object Retrieves the element's attributes.
get Background Color() String Retrieves the background color.
get Child(childIndex) Element Retrieves the child element at the specified child index.
get Child Index(child) Integer Retrieves the child index for the specified child element.
get Col Span() Integer Retrieves the column span, which is the number of columns of table cells this cell spans.
get Link Url() String Retrieves the link url.
get Next Sibling() Element Retrieves the element's next sibling element.
get Num Children() Integer Retrieves the number of children.
get Padding Bottom() Number Retrieves the bottom padding, in points.
get Padding Left() Number Retrieves the left padding, in points.
get Padding Right() Number Retrieves the right padding, in points.
get Padding Top() Number Retrieves the top padding, in points.
get Parent() Container Element Retrieves the element's parent element.
get Parent Row() Table Row Retrieves the Table Row containing the current Table Cell .
get Parent Table() Table Retrieves the Table containing the current Table Cell .
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Row Span() Integer Retrieves the row span, which is the number of rows of table cells this cell spans.
get Text() String Retrieves the contents of the element as a text string.
get Text Alignment() Text Alignment Gets the text alignment.
get Type() Element Type Retrieves the element's Element Type .
get Vertical Alignment() Vertical Alignment Retrieves the Vertical Alignment .
get Width() Number Retrieves the width of the column containing the cell, in points.
insert Horizontal Rule(childIndex) Horizontal Rule Creates and inserts a new Horizontal Rule at the specified index.
insert Image(childIndex, image) Inline Image Creates and inserts an Inline Image from the specified image blob, at the specified index.
insert Image(childIndex, image) Inline Image Inserts the given Inline Image at the specified index.
insert List Item(childIndex, listItem) List Item Inserts the given List Item at the specified index.
insert List Item(childIndex, text) List Item Creates and inserts a new List Item at the specified index.
insert Paragraph(childIndex, paragraph) Paragraph Inserts the given Paragraph at the specified index.
insert Paragraph(childIndex, text) Paragraph Creates and inserts a new Paragraph at the specified index.
insert Table(childIndex) Table Creates and inserts a new Table at the specified index.
insert Table(childIndex, cells) Table Creates and inserts a new Table containing the specified cells, at the specified index.
insert Table(childIndex, table) Table Inserts the given Table at the specified index.
is At Document End() Boolean Determines whether the element is at the end of the Document .
merge() Table Cell Merges the element with the preceding sibling of the same type.
remove Child(child) Table Cell Removes the specified child element.
remove From Parent() Table Cell Removes the element from its parent.
replace Text(searchPattern, replacement) Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
set Attributes(attributes) Table Cell Sets the element's attributes.
set Background Color(color) Table Cell Sets the background color.
set Link Url(url) Table Cell Sets the link url.
set Padding Bottom(paddingBottom) Table Cell Sets the bottom padding, in points.
set Padding Left(paddingLeft) Table Cell Sets the left padding, in points.
set Padding Right(paddingRight) Table Cell Sets the right padding, in points.
set Padding Top(paddingTop) Table Cell Sets the top padding, in points.
set Text(text) Table Cell Sets the contents as plain text.
set Text Alignment(textAlignment) Table Cell Sets the text alignment.
set Vertical Alignment(alignment) Table Cell Sets the vertical alignment.
set Width(width) Table Cell Sets the width of the column containing the current cell, in points.

Table Of Contents

Методы

Метод Тип возврата Краткое описание
clear() Table Of Contents Clears the contents of the element.
copy() Table Of Contents Returns a detached, deep copy of the current element.
edit As Text() Text Obtains a Text version of the current element, for editing.
find Element(elementType) Range Element Searches the contents of the element for a descendant of the specified type.
find Element(elementType, from) Range Element Searches the contents of the element for a descendant of the specified type, starting from the specified Range Element .
find Text(searchPattern) Range Element Searches the contents of the element for the specified text pattern using regular expressions.
find Text(searchPattern, from) Range Element Searches the contents of the element for the specified text pattern, starting from a given search result.
get Attributes() Object Retrieves the element's attributes.
get Child(childIndex) Element Retrieves the child element at the specified child index.
get Child Index(child) Integer Retrieves the child index for the specified child element.
get Link Url() String Retrieves the link url.
get Next Sibling() Element Retrieves the element's next sibling element.
get Num Children() Integer Retrieves the number of children.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Text() String Retrieves the contents of the element as a text string.
get Text Alignment() Text Alignment Gets the text alignment.
get Type() Element Type Retrieves the element's Element Type .
is At Document End() Boolean Determines whether the element is at the end of the Document .
remove From Parent() Table Of Contents Removes the element from its parent.
replace Text(searchPattern, replacement) Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
set Attributes(attributes) Table Of Contents Sets the element's attributes.
set Link Url(url) Table Of Contents Sets the link url.
set Text Alignment(textAlignment) Table Of Contents Sets the text alignment.

Table Row

Методы

Метод Тип возврата Краткое описание
append Table Cell() Table Cell Creates and appends a new Table Cell .
append Table Cell(textContents) Table Cell Appends the given Table Cell containing the specified text.
append Table Cell(tableCell) Table Cell Appends the given Table Cell .
clear() Table Row Clears the contents of the element.
copy() Table Row Returns a detached, deep copy of the current element.
edit As Text() Text Obtains a Text version of the current element, for editing.
find Element(elementType) Range Element Searches the contents of the element for a descendant of the specified type.
find Element(elementType, from) Range Element Searches the contents of the element for a descendant of the specified type, starting from the specified Range Element .
find Text(searchPattern) Range Element Searches the contents of the element for the specified text pattern using regular expressions.
find Text(searchPattern, from) Range Element Searches the contents of the element for the specified text pattern, starting from a given search result.
get Attributes() Object Retrieves the element's attributes.
get Cell(cellIndex) Table Cell Retrieves the Table Cell at the specified cell index.
get Child(childIndex) Element Retrieves the child element at the specified child index.
get Child Index(child) Integer Retrieves the child index for the specified child element.
get Link Url() String Retrieves the link url.
get Minimum Height() Number Retrieves the minimum height, in points.
get Next Sibling() Element Retrieves the element's next sibling element.
get Num Cells() Integer Retrieves the number of cells in the row.
get Num Children() Integer Retrieves the number of children.
get Parent() Container Element Retrieves the element's parent element.
get Parent Table() Table Retrieves the Table containing the current row.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Text() String Retrieves the contents of the element as a text string.
get Text Alignment() Text Alignment Gets the text alignment.
get Type() Element Type Retrieves the element's Element Type .
insert Table Cell(childIndex) Table Cell Creates and inserts a new Table Cell at the specified index.
insert Table Cell(childIndex, textContents) Table Cell Inserts the given Table Cell at the specified index, containing the given text.
insert Table Cell(childIndex, tableCell) Table Cell Inserts the given Table Cell at the specified index.
is At Document End() Boolean Determines whether the element is at the end of the Document .
merge() Table Row Merges the element with the preceding sibling of the same type.
remove Cell(cellIndex) Table Cell Removes the Table Cell at the specified cell index.
remove Child(child) Table Row Removes the specified child element.
remove From Parent() Table Row Removes the element from its parent.
replace Text(searchPattern, replacement) Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
set Attributes(attributes) Table Row Sets the element's attributes.
set Link Url(url) Table Row Sets the link url.
set Minimum Height(minHeight) Table Row Sets the minimum height, in points.
set Text Alignment(textAlignment) Table Row Sets the text alignment.

Text

Методы

Метод Тип возврата Краткое описание
append Text(text) Text Adds the specified text to the end of this text region.
copy() Text Returns a detached, deep copy of the current element.
delete Text(startOffset, endOffsetInclusive) Text Deletes a range of text.
edit As Text() Text Obtains a Text version of the current element, for editing.
find Text(searchPattern) Range Element Searches the contents of the element for the specified text pattern using regular expressions.
find Text(searchPattern, from) Range Element Searches the contents of the element for the specified text pattern, starting from a given search result.
get Attributes() Object Retrieves the element's attributes.
get Attributes(offset) Object Retrieves the attributes at the specified character offset.
get Background Color() String Retrieves the background color setting.
get Background Color(offset) String Retrieves the background color at the specified character offset.
get Font Family() String Retrieves the font family setting.
get Font Family(offset) String Retrieves the font family at the specified character offset.
get Font Size() Number Retrieves the font size setting.
get Font Size(offset) Number Retrieves the font size at the specified character offset.
get Foreground Color() String Retrieves the foreground color setting.
get Foreground Color(offset) String Retrieves the foreground color at the specified character offset.
get Link Url() String Retrieves the link url.
get Link Url(offset) String Retrieves the link URL at the specified character offset.
get Next Sibling() Element Retrieves the element's next sibling element.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Text() String Retrieves the contents of the element as a text string.
get Text Alignment() Text Alignment Gets the text alignment.
get Text Alignment(offset) Text Alignment Gets the text alignment for a single character.
get Text Attribute Indices() Integer[] Retrieves the set of text indices that correspond to the start of distinct text formatting runs.
get Type() Element Type Retrieves the element's Element Type .
insert Text(offset, text) Text Inserts the specified text at the given character offset.
is At Document End() Boolean Determines whether the element is at the end of the Document .
is Bold() Boolean Retrieves the bold setting.
is Bold(offset) Boolean Retrieves the bold setting at the specified character offset.
is Italic() Boolean Retrieves the italic setting.
is Italic(offset) Boolean Retrieves the italic setting at the specified character offset.
is Strikethrough() Boolean Retrieves the strikethrough setting.
is Strikethrough(offset) Boolean Retrieves the strikethrough setting at the specified character offset.
is Underline() Boolean Retrieves the underline setting.
is Underline(offset) Boolean Retrieves the underline setting at the specified character offset.
merge() Text Merges the element with the preceding sibling of the same type.
remove From Parent() Text Removes the element from its parent.
replace Text(searchPattern, replacement) Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
set Attributes(startOffset, endOffsetInclusive, attributes) Text Applies the specified attributes to the given character range.
set Attributes(attributes) Text Sets the element's attributes.
set Background Color(startOffset, endOffsetInclusive, color) Text Sets the background color for the specified character range.
set Background Color(color) Text Sets the background color.
set Bold(bold) Text Sets the bold setting.
set Bold(startOffset, endOffsetInclusive, bold) Text Sets the bold setting for the specified character range.
set Font Family(startOffset, endOffsetInclusive, fontFamilyName) Text Sets the font family for the specified character range.
set Font Family(fontFamilyName) Text Sets the font family.
set Font Size(startOffset, endOffsetInclusive, size) Text Sets the font size for the specified character range.
set Font Size(size) Text Sets the font size.
set Foreground Color(startOffset, endOffsetInclusive, color) Text Sets the foreground color for the specified character range.
set Foreground Color(color) Text Sets the foreground color.
set Italic(italic) Text Sets the italic setting.
set Italic(startOffset, endOffsetInclusive, italic) Text Sets the italic setting for the specified character range.
set Link Url(startOffset, endOffsetInclusive, url) Text Sets the link URL for the specified character range.
set Link Url(url) Text Sets the link url.
set Strikethrough(strikethrough) Text Sets the strikethrough setting.
set Strikethrough(startOffset, endOffsetInclusive, strikethrough) Text Sets the strikethrough setting for the specified character range.
set Text(text) Text Sets the text contents.
set Text Alignment(startOffset, endOffsetInclusive, textAlignment) Text Sets the text alignment for a given character range.
set Text Alignment(textAlignment) Text Sets the text alignment.
set Underline(underline) Text Sets the underline setting.
set Underline(startOffset, endOffsetInclusive, underline) Text Sets the underline setting for the specified character range.

Text Alignment

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

Свойство Тип Описание
NORMAL Enum The normal text alignment.
SUPERSCRIPT Enum The superscript text alignment.
SUBSCRIPT Enum The subscript text alignment.

Unsupported Element

Методы

Метод Тип возврата Краткое описание
copy() Unsupported Element Returns a detached, deep copy of the current element.
get Attributes() Object Retrieves the element's attributes.
get Next Sibling() Element Retrieves the element's next sibling element.
get Parent() Container Element Retrieves the element's parent element.
get Previous Sibling() Element Retrieves the element's previous sibling element.
get Type() Element Type Retrieves the element's Element Type .
is At Document End() Boolean Determines whether the element is at the end of the Document .
merge() Unsupported Element Merges the element with the preceding sibling of the same type.
remove From Parent() Unsupported Element Removes the element from its parent.
set Attributes(attributes) Unsupported Element Sets the element's attributes.

Vertical Alignment

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

Свойство Тип Описание
BOTTOM Enum The bottom-alignment option.
CENTER Enum The center-alignment option.
TOP Enum The top-alignment option.