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

  • Статья

В WordApi 1.5 добавлена поддержка сносок, концевых сносок, событий управления содержимым и управления стилем.

Список API

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

Класс Поля Описание
Application retrieveStylesFromBase64(base64File: string) Выполните синтаксический анализ стилей из файла Base64 шаблона и верните формат JSON полученных стилей в виде строки.
Основной текст концевые сноски Возвращает коллекцию концевых сносок в тексте.
Сноски Возвращает коллекцию сносок в тексте.
getContentControls(options?: Word. ContentControlOptions) Возвращает поддерживаемые элементы управления содержимым в тексте.
ContentControl концевые сноски Возвращает коллекцию концевых сносок в элементе управления содержимым.
Сноски Возвращает коллекцию сносок в элементе управления содержимым.
getContentControls(options?: Word. ContentControlOptions) Возвращает поддерживаемые в данный момент дочерние элементы управления содержимым в этом элементе управления содержимым.
onDataChanged Происходит при изменении данных в элементе управления содержимым.
onDeleted Происходит при удалении элемента управления содержимым.
onEntered Происходит при вводе элемента управления содержимым.
onExited Происходит при выходе из элемента управления содержимым, например при выходе курсора из элемента управления содержимым.
onSelectionChanged Происходит при изменении выделения в элементе управления содержимым.
ContentControlAddedEventArgs eventType Тип события.
Идентификаторы Возвращает идентификаторы элементов управления содержимым.
источник Источник события.
ContentControlCollection getByChangeTrackingStates(changeTrackingStates: Word. ChangeTrackingState[]) Возвращает элементы управления содержимым, имеющие указанное состояние отслеживания.
ContentControlDataChangedEventArgs eventType Тип события.
Идентификаторы Возвращает идентификаторы элементов управления содержимым.
источник Источник события.
ContentControlDeletedEventArgs eventType Тип события.
Идентификаторы Возвращает идентификаторы элементов управления содержимым.
источник Источник события.
ContentControlEnteredEventArgs eventType Тип события.
Идентификаторы Возвращает идентификаторы элементов управления содержимым.
источник Источник события.
ContentControlExitedEventArgs eventType Тип события.
Идентификаторы Возвращает идентификаторы элементов управления содержимым.
источник Источник события.
ContentControlOptions types Массив типов элементов управления содержимым, элемент должен быть "RichText" или "PlainText".
ContentControlSelectionChangedEventArgs eventType Тип события.
Идентификаторы Возвращает идентификаторы элементов управления содержимым.
источник Источник события.
Документ addStyle(name: string, type: Word. StyleType) Добавляет стиль в документ по имени и типу.
close(closeBehavior?: Word. CloseBehavior) Закрывает текущий документ.
getContentControls(options?: Word. ContentControlOptions) Возвращает поддерживаемые элементы управления содержимым в документе.
getEndnoteBody() Возвращает концевые сноски документа в одном тексте.
getFootnoteBody() Возвращает сноски документа в одном тексте.
getStyles() Возвращает объект StyleCollection, представляющий весь набор стилей документа.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Заменить" | "Пуск" | "End", insertFileOptions?: Word. InsertFileOptions) Вставляет документ в целевой документ в определенном расположении с дополнительными свойствами.
onContentControlAdded Происходит при добавлении элемента управления содержимым.
save(saveBehavior?: Word. SaveBehavior, fileName?: string) Сохраняет документ.
Поле code Указывает инструкцию по коду поля.
data Указывает данные в поле Addin.
delete() Удаляет поле.
kind Возвращает тип поля.
locked Указывает, заблокировано ли поле.
select(selectionMode?: Word. SelectionMode) Выбирает поле.
type Возвращает тип поля.
updateResult() Обновления поле.
FieldCollection getByTypes(types: Word. FieldType[]) Возвращает коллекцию объектов Field, включая указанные типы полей.
InsertFileOptions importChangeTrackingMode Указывает, следует ли импортировать состояние режима отслеживания изменений из исходного документа.
importPageColor Указывает, следует ли импортировать цвет страницы и другую фоновую информацию из исходного документа.
importParagraphSpacing Указывает, следует ли импортировать интервал между абзацами из исходного документа.
importStyles Указывает, следует ли импортировать стили из исходного документа.
importTheme Указывает, следует ли импортировать тему из исходного документа.
NoteItem body Представляет основной объект элемента заметки.
delete() Удаляет элемент заметки.
getNext() Возвращает следующий элемент заметки того же типа.
getNextOrNullObject() Возвращает следующий элемент заметки того же типа.
reference Представляет ссылку на сноску или концевую сноску в документе main.
type Представляет тип элемента заметки: сноска или концевая сноска.
NoteItemCollection getFirst() Возвращает первый элемент заметки в этой коллекции.
getFirstOrNullObject() Возвращает первый элемент заметки в этой коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
Paragraph концевые сноски Возвращает коллекцию концевых сносок в абзаце.
Сноски Возвращает коллекцию сносок в абзаце.
getContentControls(options?: Word. ContentControlOptions) Возвращает поддерживаемые в настоящее время элементы управления содержимым в абзаце.
ParagraphFormat Трассы Задает выравнивание для указанных абзацев.
firstLineIndent Задает значение (в точках) для первой строки или висячий отступ.
keepTogether Указывает, остаются ли все строки в указанных абзацах на одной и той же странице, когда Microsoft Word репагирует документ.
keepWithNext Указывает, остается ли указанный абзац на той же странице, что и следующий за ним абзац, когда microsoft Word репагинирует документ.
leftIndent Указывает левый отступ.
lineSpacing Задает междустрочный интервал (в точках) для указанных абзацев.
lineUnitAfter Указывает интервал (в линиях сетки) после указанных абзацев.
lineUnitBefore Указывает интервал (в линиях сетки) перед указанными абзацами.
mirrorIndents Указывает, имеют ли левую и правую отступы одинаковой ширины.
outlineLevel Задает уровень структуры для указанных абзацев.
rightIndent Задает правый отступ (в точках) для указанных абзацев.
пробелПоследок Указывает интервал (в точках) после указанного абзаца или текстового столбца.
spaceBefore Задает интервал (в точках) перед указанными абзацами.
widowControl Указывает, остаются ли первая и последняя строки указанного абзаца на той же странице, что и остальная часть абзаца, когда Microsoft Word повторно перенастроит документ.
Range концевые сноски Возвращает коллекцию концевых сносок в диапазоне.
Сноски Возвращает коллекцию сносок в диапазоне.
getContentControls(options?: Word. ContentControlOptions) Возвращает поддерживаемые в настоящее время элементы управления содержимым в диапазоне.
insertEndnote(insertText?: string) Вставляет концевую сноску.
insertField(insertLocation: Word. InsertLocation | "Заменить" | "Пуск" | End | "Before" | "After", fieldType?: Word. FieldType, text?: string, removeFormatting?: boolean) Вставляет поле в указанное расположение.
insertFootnote(insertText?: string) Вставляет сноску.
Style baseStyle Возвращает имя существующего стиля для использования в качестве базового форматирования другого стиля.
Builtin Возвращает значение, указывающее, является ли указанный стиль встроенным.
delete() Удаляет стиль.
font Возвращает объект шрифта, представляющий форматирование символов указанного стиля.
InUse Возвращает значение, указывающее, является ли указанный стиль встроенным стилем, который был изменен или применен в документе, или новым стилем, созданным в документе.
Связан Возвращает значение, указывающее, является ли стиль связанным стилем, который можно использовать как для форматирования абзаца, так и для символов.
nameLocal Возвращает имя стиля на языке пользователя.
nextParagraphStyle Возвращает имя стиля, который будет автоматически применен к новому абзацу, который вставляется после абзаца, отформатированного с указанным стилем.
paragraphFormat Возвращает объект ParagraphFormat, представляющий параметры абзаца для указанного стиля.
Приоритет Указывает приоритет.
quickStyle Указывает, соответствует ли стиль доступному быстрому стилю.
type Возвращает тип стиля.
unhideWhenUsed Указывает, будет ли указанный стиль отображаться в качестве рекомендуемого стиля в области стилей и задач Стили в Microsoft Word после его использования в документе.
Видимость Указывает, отображается ли указанный стиль в качестве рекомендуемого стиля в коллекции Стили и в области задач Стили.
StyleCollection getByName(name: string) Получите объект стиля по его имени.
getByNameOrNullObject(name: string) Если соответствующий стиль не существует, то этот метод возвращает объект со свойством isNullObjecttrue.
getCount() Возвращает количество стилей в коллекции.
getItem(index: number) Возвращает объект стиля по индексу в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
Table концевые сноски Возвращает коллекцию концевых сносок в таблице.
Сноски Возвращает коллекцию сносок в таблице.
TableRow концевые сноски Возвращает коллекцию концевых сносок в строке таблицы.
Сноски Возвращает коллекцию сносок в строке таблицы.

См. также