Новые возможности API JavaScript 1.4 Word

  • Статья

В WordApi 1.4 добавлена поддержка закладок, отслеживания изменений, комментариев, настраиваемых XML-частей, полей, а также объединения и разделения ячеек таблицы.

Список API

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

Класс Поля Описание
Основной текст fields Возвращает коллекцию объектов полей в тексте.
getComments() Возвращает примечания, связанные с текстом.
getReviewedText(changeTrackingVersion?: Word. ChangeTrackingVersion) Возвращает проверенный текст на основе выбора ChangeTrackingVersion.
Comment authorEmail Получает электронную почту автора примечания.
authorName Получает имя автора примечания.
content Указывает содержимое комментария в виде обычного текста.
contentRange Указывает диапазон содержимого комментария.
creationDate Возвращает дату создания комментария.
delete() Удаляет комментарий и его ответы.
getRange() Возвращает диапазон в документе main, в котором находится комментарий.
id Возвращает идентификатор комментария.
replies Возвращает коллекцию объектов ответа, связанных с комментарием.
reply(replyText: string) Добавляет новый ответ в конец потока комментариев.
Решены Указывает состояние потока комментариев.
CommentCollection getFirst() Возвращает первый комментарий в коллекции.
getFirstOrNullObject() Возвращает первый комментарий в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
CommentContentRange bold Задает значение, указывающее, выделен ли текст комментария полужирным шрифтом.
hyperlink Возвращает первую гиперссылку в диапазоне или задает для него гиперссылку.
insertText(text: string, insertLocation: Word. InsertLocation | "Заменить" | "Пуск" | End | "Before" | "После") Вставляет текст в указанное место.
Isempty Проверяет, является ли длина диапазона нулевой.
italic Указывает значение, указывающее, является ли текст комментария курсивом.
Зачеркивание Указывает значение, указывающее, содержит ли текст комментария зачеркивку.
text Возвращает текст диапазона комментариев.
underline Задает значение, указывающее тип подчеркивания текста комментария.
CommentReply authorEmail Получает электронную почту автора ответа на примечание.
authorName Получает имя автора ответа на примечание.
content Указывает содержимое ответа примечания.
contentRange Указывает диапазон содержимого commentReply.
creationDate Возвращает дату создания ответа на комментарий.
delete() Удаляет ответ на примечание.
id Возвращает идентификатор ответа на комментарий.
parentComment Возвращает родительский комментарий этого ответа.
CommentReplyCollection getFirst() Возвращает первый ответ на комментарий в коллекции.
getFirstOrNullObject() Возвращает первый ответ на комментарий в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
ContentControl fields Возвращает коллекцию объектов полей в элементе управления содержимым.
getComments() Возвращает комментарии, связанные с элементом управления содержимым.
getReviewedText(changeTrackingVersion?: Word. ChangeTrackingVersion) Возвращает проверенный текст на основе выбора ChangeTrackingVersion.
CustomXmlPart delete() Удаляет пользовательскую XML-часть.
deleteAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string) Удаляет атрибут с заданным именем из элемента, определяемого xpath.
deleteElement(xpath: string, namespaceMappings: { [key: string]: string }) Удаляет элемент, определенный xpath.
getXml() Возвращает полное XML-содержимое настраиваемой ЧАСТИ XML.
id Возвращает идентификатор настраиваемой XML-части.
insertAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string) Вставляет атрибут с заданным именем и значением в элемент, определенный xpath.
insertElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string }, index?: number) Вставляет заданный XML-код под родительский элемент, определенный xpath в дочернем индексе позиции.
Namespaceuri Возвращает URI пространства имен настраиваемой XML-части.
query(xpath: string, namespaceMappings: { [key: string]: string }) Запрашивает XML-содержимое пользовательской XML-части.
setXml(xml: string) Задает полное XML-содержимое настраиваемой ЧАСТИ XML.
updateAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string) Обновления значение атрибута с заданным именем элемента, определяемого xpath.
updateElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string }) Обновления XML-код элемента, определяемого xpath.
CustomXmlPartCollection add(xml: string) Добавляет в документ новую пользовательскую XML-часть.
getByNamespace(namespaceUri: string) Получает новую ограниченную коллекцию пользовательских XML-частей, пространства имен которых совпадают с указанным пространством имен.
getCount() Возвращает число элементов в коллекции.
getItem(id: string) Получает пользовательскую XML-часть по идентификатору.
getItemOrNullObject(id: строка) Получает пользовательскую XML-часть по идентификатору.
items Получает загруженные дочерние элементы в этой коллекции.
CustomXmlPartScopedCollection getCount() Возвращает число элементов в коллекции.
getItem(id: string) Получает пользовательскую XML-часть по идентификатору.
getItemOrNullObject(id: строка) Получает пользовательскую XML-часть по идентификатору.
getOnlyItem() Если коллекция содержит ровно один элемент, этот метод возвращает его.
getOnlyItemOrNullObject() Если коллекция содержит ровно один элемент, этот метод возвращает его.
items Получает загруженные дочерние элементы в этой коллекции.
Документ changeTrackingMode Указывает режим ChangeTracking.
customXmlParts Возвращает пользовательские XML-части в документе.
deleteBookmark(name: string) Удаляет закладку, если она существует, из документа.
getBookmarkRange(name: string) Возвращает диапазон закладки.
getBookmarkRangeOrNullObject(name: string) Возвращает диапазон закладки.
settings Возвращает параметры надстройки в документе.
Поле code Возвращает инструкцию кода поля.
getNext() Возвращает следующее поле.
getNextOrNullObject() Возвращает следующее поле.
parentBody Возвращает родительский текст поля.
parentContentControl Возвращает элемент управления содержимым, содержащий поле .
parentContentControlOrNullObject Возвращает элемент управления содержимым, содержащий поле .
parentTable Возвращает таблицу, содержащую поле .
parentTableCell Возвращает ячейку таблицы, содержащую поле.
parentTableCellOrNullObject Возвращает ячейку таблицы, содержащую поле.
parentTableOrNullObject Возвращает таблицу, содержащую поле .
result Возвращает результирующих данных поля.
FieldCollection getFirst() Возвращает первое поле в этой коллекции.
getFirstOrNullObject() Возвращает первое поле в этой коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
Paragraph fields Возвращает коллекцию полей в абзаце.
getComments() Возвращает примечания, связанные с абзацем.
getReviewedText(changeTrackingVersion?: Word. ChangeTrackingVersion) Возвращает проверенный текст на основе выбора ChangeTrackingVersion.
Range fields Возвращает коллекцию объектов полей в диапазоне.
getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean) Возвращает имена всех закладок в диапазоне или перекрывающих его.
getComments() Возвращает комментарии, связанные с диапазоном.
getReviewedText(changeTrackingVersion?: Word. ChangeTrackingVersion) Возвращает проверенный текст на основе выбора ChangeTrackingVersion.
insertBookmark(name: string) Вставляет закладку в диапазон.
insertComment(commentText: string) Вставьте комментарий в диапазон.
Параметр delete() Удаляет параметр.
key Возвращает ключ параметра.
value Задает значение параметра.
SettingCollection add(key: string, value: any) Создает новый параметр или задает существующий параметр.
deleteAll() Удаляет все параметры в этой надстройке.
getCount() Возвращает количество параметров.
getItem(key: string) Возвращает объект параметра по ключу с учетом регистра.
getItemOrNullObject(key: string) Возвращает объект параметра по ключу с учетом регистра.
items Получает загруженные дочерние элементы в этой коллекции.
Table fields Возвращает коллекцию объектов полей в таблице.
mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number) Объединяет ячейки, ограниченные включительно первой и последней ячейками.
TableCell split(rowCount: number, columnCount: number) Разбивает ячейку на указанное количество строк и столбцов.
TableRow fields Возвращает коллекцию объектов полей в строке таблицы.
merge() Объединяет строку в одну ячейку.

См. также