Поделиться через

Новые возможности API JavaScript для Word 1.3

  • Статья

В WordApi 1.3 добавлена дополнительная поддержка элементов управления содержимым и параметров уровня документа.

Список API

В следующей таблице перечислены API в Word наборе обязательных элементов API JavaScript 1.3. Справочную документацию по API для всех API, поддерживаемых Word набором обязательных api JavaScript 1.3 или более ранней версии, см. в статье Word API в наборе требований 1.3 или более ранней версии.

Класс Поля Описание
Application createDocument(base64File?: string) Создает документ с помощью дополнительного файла .docx в кодировке Base64.
Основной текст getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | Word. RangeLocation.content | "Целое" | "Пуск" | End | "После" | "Содержимое") Возвращает весь основной текст (либо его начальную или конечную точку) в виде диапазона.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Пуск" | "End", values?: string[][]) Вставляет таблицу с указанным количеством строк и столбцов.
lists Возвращает коллекцию объектов списков в основном тексте.
parentBody Возвращает родительский текст основного текста.
parentBodyOrNullObject Возвращает родительский текст основного текста.
parentContentControlOrNullObject Получает элемент управления содержимым, содержащий документ или раздел.
parentSection Возвращает родительский раздел основного текста.
parentSectionOrNullObject Возвращает родительский раздел основного текста.
styleBuiltIn Задает встроенное имя стиля для текста.
Таблицы Возвращает коллекцию объектов таблиц в основном тексте.
type Возвращает тип основного текста.
ContentControl getRange(rangeLocation?: Word. RangeLocation | "Целое" | "Пуск" | End | "Before" | "После" | "Содержимое") Возвращает весь элемент управления содержимым (либо его начальную или конечную точку) в виде диапазона.
getTextRanges(endingMarks: string[], trimSpacing?: boolean) Получает текстовые диапазоны в элементе управления содержимым с помощью знаков препинания и (или) других конечных знаков.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | "Пуск" | End | "Before" | "After", values?: string[][]) Вставляет таблицу с указанным количеством строк и столбцов в элемент управления содержимым или рядом с ним.
lists Возвращает коллекцию объектов списков в элементе управления содержимым.
parentBody Возвращает родительский текст элемента управления содержимым.
parentContentControlOrNullObject Получает элемент управления содержимым, содержащий элемент управления содержимым.
parentTable Возвращает таблицу, содержащую элемент управления содержимым.
parentTableCell Возвращает ячейку таблицы, содержащую элемент управления содержимым.
parentTableCellOrNullObject Возвращает ячейку таблицы, содержащую элемент управления содержимым.
parentTableOrNullObject Возвращает таблицу, содержащую элемент управления содержимым.
split(разделители: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean) Разделяет элемент управления содержимым на дочерние диапазоны с помощью разделителей.
styleBuiltIn Задает встроенное имя стиля для элемента управления содержимым.
Подтип Возвращает подтип элемента управления содержимым.
Таблицы Возвращает коллекцию объектов таблиц в элементе управления содержимым.
ContentControlCollection getByIdOrNullObject(id: number) Возвращает элемент управления содержимым по его идентификатору.
getByTypes(types: Word. ContentControlType[]) Возвращает элементы управления содержимым, имеющие указанные типы.
getFirst() Возвращает первый элемент управления содержимым в коллекции.
getFirstOrNullObject() Возвращает первый элемент управления содержимым в коллекции.
CustomProperty delete() Удаляет настраиваемое свойство.
key Возвращает ключ настраиваемого свойства.
type Получает тип значения настраиваемого свойства.
value Задает значение настраиваемого свойства.
CustomPropertyCollection add(key: string, value: any) Создает или задает настраиваемое свойство.
deleteAll() Удаляет все настраиваемые свойства в коллекции.
getCount() Получает количество настраиваемых свойств.
getItem(key: string) Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра.
getItemOrNullObject(key: string) Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра.
items Получает загруженные дочерние элементы в этой коллекции.
Документ properties Возвращает свойства документа.
DocumentCreated open() Открывает документ.
DocumentProperties Applicationname Возвращает имя приложения для документа.
Автор Указывает автора документа.
Категории Указывает категорию документа.
comments Указывает примечания документа.
company Указывает компанию документа.
creationDate Возвращает дату создания документа.
customProperties Возвращает коллекцию настраиваемых свойств документа.
format Задает формат документа.
Ключевые слова Указывает ключевые слова документа.
lastAuthor Возвращает последнего автора документа.
lastPrintDate Возвращает дату последней печати документа.
lastSaveTime Возвращает время последнего сохранения документа.
manager Указывает диспетчер документа.
revisionNumber Возвращает номер редакции документа.
Безопасности Возвращает параметры безопасности документа.
subject Задает тему документа.
template Возвращает шаблон документа.
заголовок Указывает название документа.
InlinePicture getNext() Возвращает следующий встроенный рисунок.
getNextOrNullObject() Возвращает следующий встроенный рисунок.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | "Целое" | "Пуск" | "End") Возвращает рисунок (либо его начальную или конечную точку) в виде диапазона.
parentContentControlOrNullObject Возвращает элемент управления содержимым, который содержит встроенный рисунок.
parentTable Возвращает таблицу, содержащую встроенный рисунок.
parentTableCell Возвращает ячейку таблицы, содержащую встроенный рисунок.
parentTableCellOrNullObject Возвращает ячейку таблицы, содержащую встроенный рисунок.
parentTableOrNullObject Возвращает таблицу, содержащую встроенный рисунок.
InlinePictureCollection getFirst() Возвращает первый встроенный рисунок в коллекции.
getFirstOrNullObject() Возвращает первый встроенный рисунок в коллекции.
List getLevelParagraphs(level: number) Возвращает абзацы, обнаруженные на указанном уровне списка.
getLevelString(level: number) Возвращает маркер, число или рисунок на указанном уровне в виде строки.
id Возвращает идентификатор списка.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | "Пуск" | End | "Before" | "После") Вставляет абзац в указанном расположении.
levelExistences Проверяет наличие каждого из 9 уровней в списке.
levelTypes Возвращает типы всех 9 уровней списка.
paragraphs Возвращает абзацы в списке.
setLevelAlignment(level: number, выравнивание: Word. Выравнивание) Задает выравнивание маркера, номера или рисунка на указанном уровне в списке.
setLevelBullet(level: number, listBullet: Word. ListBullet, charCode?: number, fontName?: string) Задает формат маркеров на указанном уровне списка.
setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number) Задает два отступа на указанном уровне списка.
setLevelNumbering(level: number, listNumbering: Word. ListNumbering, formatString?: строка массива<| число>) Задает формат нумерации на указанном уровне списка.
setLevelStartingNumber(level: number, startingNumber: number) Задает начальный номер на указанном уровне списка.
ListCollection getById(id: number) Возвращает список по идентификатору.
getByIdOrNullObject(id: number) Возвращает список по идентификатору.
getFirst() Возвращает первый список в коллекции.
getFirstOrNullObject() Возвращает первый список в коллекции.
getItem(id: number) Возвращает объект списка по его идентификатору.
items Получает загруженные дочерние элементы в этой коллекции.
ListItem getAncestor(parentOnly?: boolean) Возвращает родительский элемент списка или ближайший предок, если родитель не существует.
getAncestorOrNullObject(parentOnly?: boolean) Возвращает родительский элемент списка или ближайший предок, если родитель не существует.
getDescendants(directChildrenOnly?: boolean) Возвращает всех потомков элемента списка.
level Задает уровень элемента в списке.
listString Возвращает маркер, номер или рисунок элемента списка в виде строки.
siblingIndex Возвращает порядковый номер элемента списка относительно элементов того же уровня.
Paragraph attachToList(listId: number, level: number) Позволяет присоединить абзац к существующему списку на указанном уровне.
detachFromList() Перемещает абзац за пределы списка (если он является элементом списка).
getNext() Возвращает следующий абзац.
getNextOrNullObject() Возвращает следующий абзац.
getPrevious() Возвращает предыдущий абзац.
getPreviousOrNullObject() Возвращает предыдущий абзац.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | Word. RangeLocation.content | "Целое" | "Пуск" | End | "После" | "Содержимое") Возвращает весь абзац (либо его начальную или конечную точку) в виде диапазона.
getTextRanges(endingMarks: string[], trimSpacing?: boolean) Возвращает текстовые диапазоны в абзаце с помощью знаков препинания и (или) других конечных знаков.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "After", values?: string[][]) Вставляет таблицу с указанным количеством строк и столбцов.
isLastParagraph Указывает, что абзац является последним в родительском тексте.
isListItem Проверяет, является ли абзац элементом списка.
list Возвращает объект List, к которому относится абзац.
listItem Возвращает объект ListItem для абзаца.
listItemOrNullObject Возвращает объект ListItem для абзаца.
listOrNullObject Возвращает объект List, к которому относится абзац.
parentBody Возвращает родительский текст абзаца.
parentContentControlOrNullObject Возвращает элемент управления содержимым, содержащий абзац.
parentTable Возвращает таблицу, содержащую абзац.
parentTableCell Возвращает ячейку таблицы, содержащую абзац.
parentTableCellOrNullObject Возвращает ячейку таблицы, содержащую абзац.
parentTableOrNullObject Возвращает таблицу, содержащую абзац.
split(разделители: string[], trimDelimiters?: boolean, trimSpacing?: boolean) Разделяет абзац на дочерние диапазоны с помощью разделителей.
startNewList() Создает список, начинающийся с данного абзаца.
styleBuiltIn Указывает встроенное имя стиля для абзаца.
tableNestingLevel Возвращает уровень таблицы, содержащей абзац.
ParagraphCollection getFirst() Возвращает первый абзац в коллекции.
getFirstOrNullObject() Возвращает первый абзац в коллекции.
getLast() Возвращает последний абзац в коллекции.
getLastOrNullObject() Возвращает последний абзац в коллекции.
Range compareLocationWith(range: Word. Диапазон) Сравнивает расположение данного диапазона с расположением другого диапазона.
expandTo(range: Word. Диапазон) Возвращает новый диапазон, который простирается в том или ином направлении от данного диапазона и перекрывает другой диапазон.
expandToOrNullObject(range: Word. Диапазон) Возвращает новый диапазон, который простирается в том или ином направлении от данного диапазона и перекрывает другой диапазон.
getHyperlinkRanges() Возвращает дочерние диапазоны гиперссылок в данном диапазоне.
getNextTextRange(endingMarks: string[], trimSpacing?: boolean) Возвращает следующий текстовый диапазон с помощью знаков препинания и (или) других конечных знаков.
getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean) Возвращает следующий текстовый диапазон с помощью знаков препинания и (или) других конечных знаков.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | Word. RangeLocation.content | "Целое" | "Пуск" | End | "После" | "Содержимое") Клонирует диапазон либо получает его начальную или конечную точку в виде нового диапазона.
getTextRanges(endingMarks: string[], trimSpacing?: boolean) Возвращает текстовые дочерние диапазоны в диапазоне с помощью знаков препинания и (или) других конечных знаков.
hyperlink Возвращает первую гиперссылку в диапазоне или задает для него гиперссылку.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "After", values?: string[][]) Вставляет таблицу с указанным количеством строк и столбцов.
intersectWith(range: Word. Диапазон) Возвращает новый диапазон, представляющий собой пересечение данного диапазона с другим.
intersectWithOrNullObject(range: Word. Диапазон) Возвращает новый диапазон, представляющий собой пересечение данного диапазона с другим.
Isempty Проверяет, является ли длина диапазона нулевой.
lists Возвращает коллекцию объектов списков в диапазоне.
parentBody Возвращает родительский текст диапазона.
parentContentControlOrNullObject Возвращает элемент управления содержимым, содержащий диапазон.
parentTable Возвращает таблицу, содержащую диапазон.
parentTableCell Возвращает ячейку таблицы, содержащую диапазон.
parentTableCellOrNullObject Возвращает ячейку таблицы, содержащую диапазон.
parentTableOrNullObject Возвращает таблицу, содержащую диапазон.
split(разделители: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean) Разделяет диапазон на дочерние диапазоны с помощью разделителей.
styleBuiltIn Задает встроенное имя стиля для диапазона.
Таблицы Возвращает коллекцию объектов таблиц в диапазоне.
RangeCollection getFirst() Возвращает первый диапазон в коллекции.
getFirstOrNullObject() Возвращает первый диапазон в коллекции.
RequestContext application [Набор API: WordApi 1.3] *
Section getNext() Возвращает следующий раздел.
getNextOrNullObject() Возвращает следующий раздел.
SectionCollection getFirst() Возвращает первый раздел в коллекции.
getFirstOrNullObject() Возвращает первый раздел в коллекции.
Table addColumns(insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Пуск" | "End", columnCount: number, values?: string[][]) Добавляет столбцы в начале или в конце таблицы, используя первый или последний из имеющихся столбцов в качестве шаблона.
addRows(insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Пуск" | "End", rowCount: number, values?: string[][]) Добавляет строки в начале или в конце таблицы, используя первую или последнюю из имеющихся строк в качестве шаблона.
Трассы Задает выравнивание таблицы по столбцу страницы.
autoFitWindow() Автоматически подбирает ширину столбцов таблицы в соответствии с шириной окна.
clear() Очищает содержимое таблицы.
delete() Удаляет всю таблицу.
deleteColumns(columnIndex: number, columnCount?: number) Удаляет определенные столбцы.
deleteRows(rowIndex: number, rowCount?: number) Удаляет определенные строки.
distributeColumns() Равномерно распределяет ширину столбцов.
font Возвращает шрифт.
getBorder(borderLocation: Word. BorderLocation) Возвращает стиль указанной границы.
getCell(rowIndex: number, cellIndex: number) Возвращает ячейку таблицы в указанной строке и указанном столбце.
getCellOrNullObject(rowIndex: number, cellIndex: number) Возвращает ячейку таблицы в указанной строке и указанном столбце.
getCellPadding(cellPaddingLocation: Word. CellPaddingLocation) Возвращает размер поля ячейки в точках.
getNext() Возвращает следующую таблицу.
getNextOrNullObject() Возвращает следующую таблицу.
getParagraphAfter() Возвращает абзац после таблицы.
getParagraphAfterOrNullObject() Возвращает абзац после таблицы.
getParagraphBefore() Возвращает абзац перед таблицей.
getParagraphBeforeOrNullObject() Возвращает абзац перед таблицей.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | "Целое" | "Пуск" | End | "После") Возвращает диапазон, содержащий данную таблицу, либо диапазон в начале или в конце таблицы.
headerRowCount Указывает количество строк заголовков.
horizontalAlignment Задает горизонтальное выравнивание каждой ячейки в таблице.
insertContentControl() Вставляет в таблицу элемент управления содержимым.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "После") Вставляет абзац в указанном расположении.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "After", values?: string[][]) Вставляет таблицу с указанным количеством строк и столбцов.
isUniform Указывает, однородны ли все строки таблицы.
nestingLevel Возвращает уровень вложенности таблицы.
parentBody Возвращает родительский текст таблицы.
parentContentControl Возвращает элемент управления содержимым, содержащий таблицу.
parentContentControlOrNullObject Возвращает элемент управления содержимым, содержащий таблицу.
parentTable Возвращает таблицу, которая содержит данную таблицу.
parentTableCell Возвращает ячейку таблицы, содержащую данную таблицу.
parentTableCellOrNullObject Возвращает ячейку таблицы, содержащую данную таблицу.
parentTableOrNullObject Возвращает таблицу, которая содержит данную таблицу.
Rowcount Получает количество строк в таблице.
строки Возвращает все строки таблицы.
search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) Выполняет поиск с указанным searchOptions в область объекта таблицы.
select(selectionMode?: Word. SelectionMode) Выбирает таблицу либо позицию в начале или в конце таблицы, а затем переходит к ней в Word.
setCellPadding(cellPaddingLocation: Word. CellPaddingLocation, cellPadding: number) Задает размер поля ячейки в точках.
shadingColor Задает цвет заливки.
style Задает имя стиля для таблицы.
styleBandedColumns Указывает, содержит ли таблица чередуемые столбцы.
styleBandedRows Указывает, содержит ли таблица чередуемые строки.
styleBuiltIn Задает встроенное имя стиля для таблицы.
styleFirstColumn Указывает, содержит ли таблица первый столбец со специальным стилем.
styleLastColumn Указывает, содержит ли таблица последний столбец со специальным стилем.
styleTotalRow Указывает, содержит ли таблица итоговую (последнюю) строку со специальным стилем.
Таблицы Возвращает дочерние таблицы, вложенные на один уровень ниже.
values Задает текстовые значения в таблице в виде массива JavaScript 2D.
verticalAlignment Задает вертикальное выравнивание каждой ячейки в таблице.
width Задает ширину таблицы в точках.
TableBorder color Задает цвет границы таблицы.
type Указывает тип границы таблицы.
width Задает ширину (в точках) границы таблицы.
TableCell body Возвращает объект тела ячейки.
cellIndex Получает индекс ячейки в строке.
columnWidth Задает ширину столбца ячейки в точках.
deleteColumn() Удаляет столбец, содержащий данную ячейку.
deleteRow() Удаляет строку, содержащую данную ячейку.
getBorder(borderLocation: Word. BorderLocation) Возвращает стиль указанной границы.
getCellPadding(cellPaddingLocation: Word. CellPaddingLocation) Возвращает размер поля ячейки в точках.
getNext() Возвращает следующую ячейку.
getNextOrNullObject() Возвращает следующую ячейку.
horizontalAlignment Задает горизонтальное выравнивание ячейки.
insertColumns(insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]) Добавляет столбцы слева или справа от ячейки, используя столбец этой ячейки в качестве шаблона.
insertRows(insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]) Вставляет строки над ячейкой или под ней, используя строку этой ячейки в качестве шаблона.
parentRow Получает родительскую строку ячейки.
parentTable Возвращает родительскую таблицу ячейки.
rowIndex Получает индекс строки ячейки в таблице.
setCellPadding(cellPaddingLocation: Word. CellPaddingLocation, cellPadding: number) Задает размер поля ячейки в точках.
shadingColor Задает цвет заливки ячейки.
value Задает текст ячейки.
verticalAlignment Задает вертикальное выравнивание ячейки.
width Возвращает ширину ячейки в точках.
TableCellCollection getFirst() Возвращает первую ячейку таблицы в коллекции.
getFirstOrNullObject() Возвращает первую ячейку таблицы в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
TableCollection getFirst() Возвращает первую таблицу в коллекции.
getFirstOrNullObject() Возвращает первую таблицу в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
TableRow cellCount Получает количество ячеек в строке.
Клетки Возвращает ячейки.
clear() Очищает содержимое строки.
delete() Удаляет всю строку.
font Возвращает шрифт.
getBorder(borderLocation: Word. BorderLocation) Возвращает стиль границ ячеек в строке.
getCellPadding(cellPaddingLocation: Word. CellPaddingLocation) Возвращает размер поля ячейки в точках.
getNext() Возвращает следующую строку.
getNextOrNullObject() Возвращает следующую строку.
horizontalAlignment Задает горизонтальное выравнивание каждой ячейки в строке.
insertRows(insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]) Вставляет строки, используя данную строку в качестве шаблона.
isHeader Проверяет, является ли элемент строкой заголовков.
parentTable Возвращает родительскую таблицу.
preferredHeight Задает предпочтительную высоту строки в точках.
rowIndex Получает индекс строки в родительской таблице.
search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) Выполняет поиск с указанным параметром SearchOptions в область строки.
select(selectionMode?: Word. SelectionMode) Выбирает строку и переходит к ней в Word.
setCellPadding(cellPaddingLocation: Word. CellPaddingLocation, cellPadding: number) Задает размер поля ячейки в точках.
shadingColor Задает цвет заливки.
values Задает текстовые значения в строке в виде массива JavaScript 2D.
verticalAlignment Задает вертикальное выравнивание ячеек в строке.
TableRowCollection getFirst() Возвращает первую строку в коллекции.
getFirstOrNullObject() Возвращает первую строку в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.

См. также