Новые возможности API JavaScript 1.1 Word
WordApi 1.1 — это первый набор обязательных элементов API JavaScript для Word. Это единственный набор обязательных Word API, поддерживаемый Word 2016.
Список API
В следующей таблице перечислены API-интерфейсы в Word набор обязательных элементов API JavaScript 1.1. Справочную документацию по API для всех API, поддерживаемых Word набором обязательных api JavaScript 1.1, см. в статье Word API в наборе требований 1.1.
| Класс | Поля | Описание |
|---|---|---|
| Основной текст | clear() | Очищает объект содержимого. |
| contentControls | Возвращает коллекцию объектов элементов управления содержимым в формате форматированного текста в тексте. | |
| font | Получает формат текста, указанный для содержимого документа или раздела. | |
| getHtml() | Возвращает HTML-представление объекта body. | |
| getOoxml() | Возвращает OOXML-представление (Office Open XML) объекта содержимого. | |
| inlinePictures | Возвращает коллекцию объектов InlinePicture в тексте. | |
| insertBreak(breakType: Word. BreakType | "Страница" | "Далее" | "SectionNext" | "SectionContinuous" | SectionEven | SectionOdd | "Line", insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Пуск" | "End") | Вставляет разрыв в указанном расположении в основном документе. | |
| insertContentControl() | Заключает объект Body в оболочку с помощью элемента управления содержимым форматированного текста. | |
| insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End") | Вставляет документ в содержимое в заданном расположении. | |
| insertHtml(html: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End") | Вставляет HTML-код в указанном расположении. | |
| insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End") | Вставляет OOXML-код в указанном расположении. | |
| insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Пуск" | "End") | Вставляет абзац в указанном расположении. | |
| insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End") | Вставляет текст в содержимое в заданном расположении. | |
| paragraphs | Возвращает коллекцию объектов абзаца в тексте. | |
| parentContentControl | Получает элемент управления содержимым, содержащий документ или раздел. | |
| search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) | Выполняет поиск с указанным SearchOptions в область объекта body. | |
| select(selectionMode?: Word. SelectionMode) | Выбирает содержимое и переходит к нему в пользовательском интерфейсе Word. | |
| style | Задает имя стиля для текста. | |
| text | Возвращает текст содержимого. | |
| ContentControl | Внешний вид | Указывает внешний вид элемента управления содержимым. |
| cannotDelete | Указывает значение, указывающее, может ли пользователь удалить элемент управления содержимым. | |
| не удается edit | Указывает значение, указывающее, может ли пользователь изменять содержимое элемента управления содержимым. | |
| clear() | Очищает содержимое элемента управления содержимым. | |
| color | Задает цвет элемента управления содержимым. | |
| contentControls | Получает коллекцию объектов элементов управления содержимым в элементе управления содержимым. | |
| delete(keepContent: boolean) | Удаляет элемент управления содержимым и его содержимое. | |
| font | Получает текстовый формат элемента управления содержимым. | |
| getHtml() | Возвращает HTML-представление объекта элемента управления содержимым. | |
| getOoxml() | Возвращает OOXML-представление объекта элемента управления содержимым. | |
| id | Возвращает целое число, представляющее собой идентификатор элемента управления контентом. | |
| inlinePictures | Возвращает коллекцию объектов InlinePicture в элементе управления содержимым. | |
| insertBreak(breakType: Word. BreakType | "Страница" | "Далее" | "SectionNext" | "SectionContinuous" | SectionEven | SectionOdd | "Line", insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | "Пуск" | End | "Before" | "После") | Вставляет разрыв в указанном расположении в основном документе. | |
| insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End") | Вставляет документ в элемент управления содержимым в указанном расположении. | |
| insertHtml(html: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End") | Вставляет HTML-код в элемент управления содержимым в указанном расположении. | |
| insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End") | Вставляет OOXML в элемент управления содержимым в указанном расположении. | |
| insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | "Пуск" | End | "Before" | "После") | Вставляет абзац в указанном расположении. | |
| insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End") | Вставляет текст в элемент управления содержимым в указанном расположении. | |
| paragraphs | Возвращает коллекцию объектов абзаца в элементе управления содержимым. | |
| parentContentControl | Получает элемент управления содержимым, содержащий элемент управления содержимым. | |
| заполнительText | Задает замещающий текст элемента управления содержимым. | |
| removeWhenEdited | Указывает значение, указывающее, удаляется ли элемент управления содержимым после его изменения. | |
| 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) | Выбирает элемент управления контентом. | |
| style | Задает имя стиля для элемента управления содержимым. | |
| tag | Указывает тег для идентификации элемента управления содержимым. | |
| text | Возвращает текст элемента управления содержимым. | |
| заголовок | Задает заголовок элемента управления содержимым. | |
| type | Получает тип элемента управления содержимым. | |
| ContentControlCollection | getById(id: number) | Возвращает элемент управления содержимым по его идентификатору. |
| getByTag(tag: string) | Возвращает элементы управления содержимым с указанным тегом. | |
| getByTitle(title: string) | Возвращает элементы управления контентом с указанным заголовком. | |
| getItem(id: number) | Возвращает элемент управления содержимым по его идентификатору. | |
| items | Получает загруженные дочерние элементы в этой коллекции. | |
| Документ | body | Возвращает основной объект документа main. |
| contentControls | Возвращает коллекцию объектов элементов управления содержимым в документе. | |
| getSelection() | Возвращает текущий выбранный фрагмент документа. | |
| save() | Сохраняет документ. | |
| Сохранено | Указывает, сохранены ли изменения, внесенные в документ. | |
| sections | Возвращает коллекцию объектов section в документе. | |
| Font | bold | Указывает значение, указывающее, выделен ли шрифт полужирным шрифтом. |
| color | Задает цвет указанного шрифта. | |
| doubleStrikeThrough | Указывает значение, указывающее, имеет ли шрифт двойную зачеркивку. | |
| highlightColor | Задает цвет выделения. | |
| italic | Указывает значение, указывающее, является ли шрифт курсивом. | |
| name | Задает значение, представляющее имя шрифта. | |
| size | Задает значение, представляющее размер шрифта в пунктах. | |
| Зачеркивание | Указывает значение, указывающее, содержит ли шрифт зачеркивку. | |
| subscript | Указывает значение, указывающее, является ли шрифт подстрочным. | |
| superscript | Указывает значение, указывающее, является ли шрифт надстрочным. | |
| underline | Задает значение, указывающее тип подчеркивания шрифта. | |
| InlinePicture | altTextDescription | Указывает строку, представляющую альтернативный текст, связанный со встроенным изображением. |
| altTextTitle | Указывает строку, содержащую заголовок встроенного изображения. | |
| getBase64ImageSrc() | Возвращает строковое представление встроенного изображения в кодировке Base64. | |
| height | Задает число, описывающее высоту встроенного изображения. | |
| hyperlink | Указывает гиперссылку на изображение. | |
| insertContentControl() | Включает встроенный рисунок в элемент управления содержимым форматированного текста. | |
| lockAspectRatio | Указывает значение, указывающее, сохраняет ли встроенное изображение исходные пропорции при изменении размера. | |
| parentContentControl | Возвращает элемент управления содержимым, который содержит встроенный рисунок. | |
| width | Задает число, описывающее ширину встроенного изображения. | |
| InlinePictureCollection | items | Получает загруженные дочерние элементы в этой коллекции. |
| Paragraph | Трассы | Задает выравнивание абзаца. |
| clear() | Очищает содержимое объекта абзаца. | |
| contentControls | Возвращает коллекцию объектов элементов управления содержимым в абзаце. | |
| delete() | Удаляет абзац и его содержимое из документа. | |
| firstLineIndent | Задает значение (в пунктах) для первой строки или отступа. | |
| font | Возвращает формат текста абзаца. | |
| getHtml() | Возвращает HTML-представление объекта абзаца. | |
| getOoxml() | Возвращает OOXML-представление объекта абзаца. | |
| inlinePictures | Возвращает коллекцию объектов InlinePicture в абзаце. | |
| insertBreak(breakType: Word. BreakType | "Страница" | "Далее" | "SectionNext" | "SectionContinuous" | SectionEven | SectionOdd | "Line", insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "После") | Вставляет разрыв в указанном расположении в основном документе. | |
| insertContentControl() | Заключает объект Paragraph в элемент управления с содержимым в формате форматированного текста. | |
| insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End") | Вставляет документ в абзац в указанном расположении. | |
| insertHtml(html: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End") | Вставляет HTML в абзац в указанном расположении. | |
| insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End") | Вставляет рисунок в абзац в указанном расположении. | |
| insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End") | Вставляет OOXML в абзац в указанном расположении. | |
| insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "После") | Вставляет абзац в указанном расположении. | |
| insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End") | Вставляет текст в абзац в указанном расположении. | |
| leftIndent | Задает значение левого отступа (в пунктах) для абзаца. | |
| lineSpacing | Задает междустрочный интервал (в точках) для указанного абзаца. | |
| lineUnitAfter | Указывает интервал в строках сетки после абзаца. | |
| lineUnitBefore | Указывает интервал в строках сетки перед абзацем. | |
| outlineLevel | Задает уровень структуры для абзаца. | |
| parentContentControl | Возвращает элемент управления содержимым, содержащий абзац. | |
| rightIndent | Задает значение отступа вправо (в пунктах) для абзаца. | |
| 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. | |
| пробелПоследок | Задает интервал (в точках) после абзаца. | |
| spaceBefore | Задает интервал (в пунктах) перед абзацем. | |
| style | Задает имя стиля абзаца. | |
| text | Возвращает текст абзаца. | |
| ParagraphCollection | items | Получает загруженные дочерние элементы в этой коллекции. |
| Range | clear() | Очищает содержимое объекта диапазона. |
| contentControls | Возвращает коллекцию объектов элементов управления содержимым в диапазоне. | |
| delete() | Удаляет диапазон и его содержимое из документа. | |
| font | Возвращает формат текста диапазона. | |
| getHtml() | Возвращает HTML-представление объекта диапазона. | |
| getOoxml() | Возвращает OOXML-представление объекта диапазона. | |
| insertBreak(breakType: Word. BreakType | "Страница" | "Далее" | "SectionNext" | "SectionContinuous" | SectionEven | SectionOdd | "Line", insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "После") | Вставляет разрыв в указанном расположении в основном документе. | |
| insertContentControl() | Заключает объект Range в элемент управления с содержимым в формате форматированного текста. | |
| insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation | "Заменить" | "Пуск" | End | "Before" | "После") | Вставляет документ в указанном расположении. | |
| insertHtml(html: string, insertLocation: Word. InsertLocation | "Заменить" | "Пуск" | End | "Before" | "После") | Вставляет HTML-код в указанном расположении. | |
| insertOoxml(ooxml: string, insertLocation: Word. InsertLocation | "Заменить" | "Пуск" | End | "Before" | "После") | Вставляет OOXML-код в указанном расположении. | |
| insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "После") | Вставляет абзац в указанном расположении. | |
| insertText(text: string, insertLocation: Word. InsertLocation | "Заменить" | "Пуск" | End | "Before" | "После") | Вставляет текст в заданном расположении. | |
| paragraphs | Возвращает коллекцию объектов абзаца в диапазоне. | |
| parentContentControl | Возвращает элемент управления содержимым, содержащий диапазон. | |
| 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. | |
| style | Задает имя стиля для диапазона. | |
| text | Возвращает текст диапазона. | |
| RangeCollection | items | Получает загруженные дочерние элементы в этой коллекции. |
| SearchOptions | ignorePunct | Указывает значение, указывающее, следует ли игнорировать все знаки препинания между словами. |
| ignoreSpace | Указывает значение, указывающее, следует ли игнорировать все пробелы между словами. | |
| matchCase | Указывает значение, указывающее, следует ли выполнять поиск с учетом регистра. | |
| matchPrefix | Указывает значение, указывающее, должны ли совпадать слова, начинающиеся со строки поиска. | |
| matchSuffix | Указывает значение, указывающее, должны ли совпадать слова, заканчивающиеся строкой поиска. | |
| matchWholeWord | Указывает значение, указывающее, будет ли операция находить только целые слова, а не текст, который является частью большого слова. | |
| matchWildcards | Указывает значение, указывающее, будет ли выполняться поиск с помощью специальных операторов поиска. | |
| Section | body | Возвращает основной объект раздела. |
| getFooter(type: Word. HeaderFooterType) | Возвращает один из нижних колонтитулов раздела. | |
| getHeader(type: Word. HeaderFooterType) | Возвращает один из верхних колонтитулов раздела. | |
| SectionCollection | items | Получает загруженные дочерние элементы в этой коллекции. |
См. также
Совместная работа с нами на GitHub
Источник этого содержимого можно найти на GitHub, где также можно создавать и просматривать проблемы и запросы на вытягивание. Дополнительные сведения см. в нашем руководстве для участников.
Office Add-ins