Word.Document class

Объект Document является объектом верхнего уровня. Объект Document содержит один или несколько разделов, элементы управления содержимым и текст, содержащий содержимое документа.

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-change-tracking.yaml

// Gets the current change tracking mode.
await Word.run(async (context) => {
  const document: Word.Document = context.document;
  document.load("changeTrackingMode");
  await context.sync();

  if (document.changeTrackingMode === Word.ChangeTrackingMode.trackMineOnly) {
    console.log("Only my changes are being tracked.");
  } else if (document.changeTrackingMode === Word.ChangeTrackingMode.trackAll) {
    console.log("Everyone's changes are being tracked.");
  } else {
    console.log("No changes are being tracked.");
  }
});

Свойства

activeTheme	Получает имя активной темы и параметры форматирования.
activeThemeDisplayName	Получает отображаемое имя активной темы.
activeWindow	Получает активное окно документа.
areFilePropertiesPasswordEncrypted	Сообщает, шифрует ли Word свойства файлов для документов, защищенных паролем.
areGrammaticalErrorsShown	Указывает, помечаются ли грамматические ошибки в документе волнистой зеленой линией.
areMathDefaultsUsed	Указывает, следует ли использовать математические параметры по умолчанию при создании новых уравнений.
areNewerFeaturesDisabled	Указывает, следует ли отключать функции, появившиеся после указанной версии.
areSpellingErrorsShown	Указывает, подчеркивает ли Microsoft Word орфографические ошибки в документе.
areStylesUpdatedOnOpen	Указывает, будут ли стили в этом документе обновляться в соответствии со стилями во вложенном шаблоне при каждом открытии документа.
areTrueTypeFontsEmbedded	Указывает, внедряет ли Microsoft Word шрифты TrueType в документ при его сохранении.
attachedTemplate	Указывает объект, `Template` представляющий шаблон, прикрепленный к документу.
autoHyphenation	Указывает, включено ли автоматическое расстановка переносов для документа.
autoSaveOn	Указывает, сохраняются ли изменения в документе автоматически.
background	Получает `Shape` объект, который представляет фоновое изображение для документа.
bibliography	Возвращает объект, `Bibliography` представляющий библиографические ссылки, содержащиеся в документе.
body	Получает `Body` объект основного документа. Основной текст — это текст, который исключает верхние, нижние колонтитулы, сноски, текстовые поля и т. д.
bookmarks	Возвращает объект, `BookmarkCollection` представляющий все закладки в документе.
builtInDocumentProperties	Получает объект, `DocumentProperties` представляющий все встроенные свойства документа.
changeTrackingMode	Определяет режим ChangeTracking.
characters	Получает объект, `RangeScopedCollection` который представляет все символы в документе.
coauthoring	Получает `Coauthoring` объект для управления совместным редактированием документа.
codeName	Получает кодовое имя документа.
comments	Получает объект, `CommentCollection` представляющий все примечания в документе.
compatibilityMode	Получает режим совместимости, который Word использует при открытии документа.
consecutiveHyphensLimit	Определяет максимальное количество последовательных строк, которые могут заканчиваться дефисами.
content	Получает `Range` объект, представляющий основную историю документа.
contentControls	Получает коллекцию `ContentControl` объектов в документе. Сюда входят элементы управления содержимым в основном тексте документа, верхних и нижних колонтитулах, текстовых полях и т. д.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
currentRsid	Получает случайное число, которое Word назначает изменениям в документе.
customDocumentProperties	Получает `DocumentProperties` коллекцию, представляющую все свойства настраиваемого документа для этого документа.
customXmlParts	Получает пользовательские части XML в документе.
defaultTabStop	Интервал (в пунктах) между остановками табуляции по умолчанию в документе.
defaultTargetFrame	Указывает фрейм браузера для отображения веб-страницы через гиперссылку.
documentLibraryVersions	Возвращает объект, `DocumentLibraryVersionCollection` представляющий коллекцию версий общего документа с включенным управлением версиями и хранящийся в библиотеке документов на сервере.
doNotEmbedSystemFonts	Указывает, не следует ли Word внедрять распространенные системные шрифты.
encryptionProvider	Указывает имя поставщика алгоритма шифрования, используемого Microsoft Word при шифровании документов.
farEastLineBreakLanguage	Указывает восточноазиатский язык, используемый для разрыва строки.
farEastLineBreakLevel	Уровень управления разрывом строки.
fields	Получает `FieldCollection` объект, представляющий все поля в документе.
formattingIsNextLevelShown	Указывает, отображается ли в Word следующий уровень заголовка при использовании предыдущего.
formattingIsUserStyleNameShown	Указывает, должны ли отображаться пользовательские стили.
frames	Возвращает объект, `FrameCollection` представляющий все кадры в документе.
fullName	Получает имя документа, включая путь.
grammaticalErrors	Получает объект, `RangeCollection` представляющий предложения, не прошедшие проверку грамматики в документе.
gridDistanceHorizontal	Определяет горизонтальное пространство между невидимыми линиями сетки, которое Microsoft Word использует при рисовании, перемещении и изменении размеров автофигур или восточноазиатских символов в документе.
gridDistanceVertical	Определяет вертикальное расстояние между невидимыми линиями сетки, которое Microsoft Word использует при рисовании, перемещении и изменении размера автофигур или восточноазиатских символов в документе.
gridIsOriginFromMargin	Определяет, начинается ли сетка символов с левого верхнего угла страницы.
gridOriginHorizontal	Указывает горизонтальную точку начала координат для невидимой сетки.
gridOriginVertical	Задает вертикальную точку начала координат для невидимой сетки.
gridSpaceBetweenHorizontalLines	Интервал для горизонтальных линий сетки в режиме разметки.
gridSpaceBetweenVerticalLines	Интервал для вертикальных линий сетки символов в режиме разметки.
hasPassword	Получает сведения о том, требуется ли пароль для открытия документа.
hasVbProject	Получает сведения о том, есть ли в документе вложенный проект Microsoft Visual Basic для приложений.
hyperlinks	Возвращает объект, `HyperlinkCollection` представляющий все гиперссылки в документе.
hyphenateCaps	Указывает, можно ли писать дефисы со словами, написанными всеми прописными буквами.
hyphenationZone	Задает ширину зоны переносов в точках.
indexes	Возвращает объект, `IndexCollection` представляющий все индексы в документе.
isAutoFormatOverrideOn	Определяет, переопределяют ли параметры автоматического форматирования ограничения форматирования.
isChartDataPointTracked	Указывает, используется ли для диаграмм в активном документе отслеживание точек данных по ссылкам на ячейки.
isCompatible	Указывает, включен ли параметр совместимости, указанный свойством `type` .
isFinal	Указывает, является ли документ окончательным.
isFontsSubsetSaved	Указывает, сохраняет ли Microsoft Word подмножество внедренных шрифтов TrueType вместе с документом.
isFormsDataPrinted	Указывает, будет ли Microsoft Word печатать на предварительно напечатанной форме только данные, введенные в соответствующую веб-форму.
isFormsDataSaved	Указывает, сохраняет ли Microsoft Word данные, введенные в форму, в виде записи с разделителями табуляции для использования в базе данных.
isGrammarChecked	Указывает, была ли выполнена проверка грамматики в документе.
isInAutoSave	Получает сведения о том, было ли последнее срабатывание `Application.DocumentBeforeSave` события результатом автоматического сохранения документом или сохранения вручную пользователем.
isInFormsDesign	Получает сведения о том, находится ли документ в режиме конструктора форм.
isKerningByAlgorithm	Указывает, используются ли в Word полуширинные латинские символы и знаки препинания.
isLinguisticDataEmbedded	Указывает, следует ли внедрять голосовые функции и данные рукописного ввода.
isMasterDocument	Определяет, является ли документ документом master.
isOptimizedForWord97	Указывает, оптимизирует ли Word документ для Word 97.
isPostScriptPrintedOverText	Указывает, следует ли печатать инструкции поля PRINT (например, команды PostScript) в документе поверх текста и рисунков при использовании принтера PostScript.
isQuickStyleSetLocked	Определяет, могут ли пользователи изменять набор экспресс-стилей.
isReadOnly	Указывает, нельзя ли сохранить изменения в документе в исходном документе.
isReadOnlyRecommended	Указывает, отображает ли Microsoft Word окно сообщения, когда пользователь открывает документ, предлагая открыть его только для чтения.
isSnappedToGrid	Указывает, выравниваются ли автофигуры или восточноазиатские символы по невидимой сетке.
isSnappedToShapes	Выравнивание автофигур или восточноазиатских знаков невидимыми линиями сетки через другие фигуры.
isSpellingChecked	Указывает, проверялась ли орфография во всем документе.
isStyleEnforced	Указывает, применяются ли ограничения форматирования к защищенному документу.
isSubdocument	Определяет, является ли документ вложенным документом master документа.
isThemeLocked	Определяет, могут ли пользователи изменять тему документа.
isUserControl	Указывает, был ли документ создан или открыт пользователем.
isVbaSigned	Получает сведения о том, имеет ли проект VBA цифровую подпись.
isWriteReserved	Получает сведения о том, защищен ли документ паролем записи.
justificationMode	Настройка межзнакового интервала.
kind	Тип формата, используемый Microsoft Word при автоматическом форматировании документа.
languageDetected	Указывает, определил ли Microsoft Word язык текста документа.
listParagraphs	Получает `ParagraphCollection` объект, представляющий все пронумерованные абзацы в документе.
lists	Получает объект, `ListCollection` который содержит все отформатированные списки в документе.
listTemplates	Возвращает объект, `ListTemplateCollection` представляющий все шаблоны списков в документе.
noLineBreakAfter	Задает символы кинсоку, после которых Word не разрывает строку.
noLineBreakBefore	Задает символы кинсоку, перед которыми Word не разрывает строку.
openEncoding	Получает кодировку, используемую для открытия документа.
originalDocumentTitle	Получает название исходного документа после сравнения с юридической черной линией.
pageSetup	Возвращает объект, `PageSetup` связанный с документом.
paragraphs	Получает объект, `ParagraphCollection` представляющий все абзацы в документе.
password	Устанавливает пароль, который необходимо указать, чтобы открыть документ.
passwordEncryptionAlgorithm	Получает алгоритм, используемый для шифрования пароля.
passwordEncryptionKeyLength	Получает длину ключа, используемого для шифрования пароля.
passwordEncryptionProvider	Получает имя поставщика шифрования паролей.
path	Получает диск или веб-путь к документу (за исключением имени документа).
printRevisions	Указывает, печатаются ли метки редакций на документе.
properties	Получает свойства документа.
protectionType	Получает тип защиты для документа.
readabilityStatistics	Получает `ReadabilityStatisticCollection` объект, представляющий статистику удобочитаемости для документа.
readingLayoutSizeX	Определяет ширину страниц в режиме разметки для чтения при закреплении.
readingLayoutSizeY	Указывает высоту страниц в режиме разметки для чтения при закреплении.
readingModeIsLayoutFrozen	Указывает, закрепляются ли страницы в режиме разметки для рукописного ввода.
removePersonalInformationOnSave	Указывает, удаляет ли Word сведения о пользователе при сохранении.
revisedDocumentTitle	Получает название исправленного документа после сравнения с юридической черной линией.
revisions	Получает коллекцию исправлений, которые представляют отслеживаемые изменения в документе.
saved	Указывает, сохранены ли изменения, внесенные в документ. Значение "of" `true` означает, что документ не изменился с момента сохранения.
saveEncoding	Указывает кодировку, используемую при сохранении документа.
saveFormat	Получает формат файла документа.
sections	Получает коллекцию `Section` объектов в документе.
selection	Возвращает объект, `Selection` представляющий текущий выделенный фрагмент в документе.
sensitivityLabel	Возвращает метку конфиденциальности документа.
sentences	Получает объект, `RangeScopedCollection` который представляет все предложения в документе.
settings	Получает параметры надстройки в документе.
spellingErrors	Получает объект, `RangeCollection` представляющий слова, определенные как орфографические ошибки в документе.
storyRanges	Получает объект, `RangeCollection` представляющий все истории в документе.
styles	Получает a `StyleCollection` за документ.
tableOfAuthoritiesCategories	Возвращает `TableOfAuthoritiesCategoryCollection` объект, представляющий доступную таблицу категорий центров распространения в документе.
tables	Получает объект, `TableCollection` представляющий все таблицы в документе.
tablesOfAuthorities	Возвращает объект, `TableOfAuthoritiesCollection` представляющий все таблицы центров распространения информации в документе.
tablesOfContents	Возвращает объект, `TableOfContentsCollection` представляющий все оглавления в документе.
tablesOfFigures	Возвращает объект, представляющий `TableOfFiguresCollection` все списки иллюстраций в документе.
textEncoding	Задает кодировку для сохранения в виде закодированного текста.
textLineEnding	Указывает, как Word помечает разрывы строк и абзацев в текстовых файлах.
trackedChangesAreDateAndTimeRemoved	Указывает, следует ли удалять или сохранять метаданные даты и времени для отслеживаемых изменений.
trackFormatting	Указывает, нужно ли отслеживать изменения форматирования, если отслеживание изменений включено.
trackMoves	Указывает, следует ли помечать перемещенный текст, если режим исправлений включен.
trackRevisions	Указывает, отслеживаются ли изменения в документе.
type	Получает тип документа (шаблон или документ).
webSettings	Получает `WebSettings` объект для атрибутов, связанных с веб-страницей.
windows	Получает коллекцию `Word.Window` объектов для документа.
words	Получает объект, `RangeScopedCollection` который представляет каждое слово в документе.
writePassword	Устанавливает пароль для сохранения изменений в документе.
xmlAreAdvancedErrorsShown	Указывает, создаются ли сообщения об ошибках на основе встроенных сообщений Word или MSXML (Microsoft XML).
xmlIsXsltUsedWhenSaving	Указывает, следует ли сохранять документ с помощью расширяемого языкового преобразования таблицы стилей (XSLT).
xmlSaveThroughXslt	Указывает путь и имя файла XSLT, применяемого при сохранении документа.

Методы

acceptAllRevisions()	Принимает все исправления в документе.
acceptAllRevisionsShown()	Принимает все исправления в документе, отображаемые на экране.
activate()	Активирует документ, чтобы он стал активным.
addStyle(name, type)	Добавляет стиль в документ по имени и типу.
addStyle(name, type)	Добавляет стиль в документ по имени и типу.
addToFavorites()	Создает ярлык для документа или гиперссылки и добавляет ее в папку "Избранное ".
applyQuickStyleSet(style)	Применяет указанный экспресс-стиль к документу.
applyQuickStyleSet(style)	Применяет указанный экспресс-стиль к документу.
applyTheme(name)	Применяет заданную тему к данному документу.
autoFormat()	Автоматическое форматирование документа.
canCheckin()	Возвращает`true`, если Microsoft Word может выполнить проверку документа на сервере.
checkConsistencyJapanese()	Осуществляет поиск по всему тексту в документе на японском языке и показывает случаи, когда символы используются непоследовательно для одних и тех же слов.
checkGrammar()	Начало проверки орфографии и грамматики документа.
checkIn(options)	Возвращает документ с локального компьютера на сервер и устанавливает локальный документ только для чтения, чтобы его нельзя было редактировать локально.
checkInWithVersion(options)	Сохраняет документ на сервере с локального компьютера и устанавливает для него режим только для чтения, чтобы его нельзя было редактировать локально.
checkSpelling(options)	Начало проверки орфографии документа.
close(closeBehavior)	Закрывает текущий документ. Примечание. Этот API не поддерживается в Word в Интернете.
close(closeBehavior)	Закрывает текущий документ. Примечание. Этот API не поддерживается в Word в Интернете.
closePrintPreview()	Переключает документ из предварительного просмотра в предыдущий вид.
compare(filePath, documentCompareOptions)	Отображает метки рецензирования, которые показывают, чем указанный документ отличается от другого.
compareFromBase64(base64File, documentCompareOptions)	Отображает метки рецензирования, которые показывают, чем указанный документ отличается от другого.
computeStatistics(statistic, includeFootnotesAndEndnotes)	Возвращает статистику на основе содержимого документа.
computeStatistics(statistic, includeFootnotesAndEndnotes)	Возвращает статистику на основе содержимого документа.
convert()	Преобразует файл в новейший формат и активирует все функции.
convertAutoHyphens()	Преобразует автоматические дефисы в ручные.
convertNumbersToText(numberType)	Заменяет номера списков и поля LISTNUM в документе текстом.
convertNumbersToText(numberType)	Заменяет номера списков и поля LISTNUM в документе текстом.
convertVietnameseDocument(codePageOrigin)	Преобразует вьетнамский документ в Юникод с помощью кодовой страницы, отличной от заданной по умолчанию.
copyStylesFromTemplate(StyleTemplate)	Копирует стили из указанного шаблона в документ.
countNumberedItems(options)	Возвращает количество маркированных или нумерованных элементов и полей LISTNUM в документе.
deleteAllComments()	Удаляет все примечания из документа.
deleteAllCommentsShown()	Удаляются все исправления в документе, отображаемые на экране.
deleteAllInkAnnotations()	Удаляются все рукописные заметки в документе.
deleteBookmark(name)	Удаляет закладку (если она есть) из документа.
detectLanguage()	Анализирует текст документа для определения языка.
endReview(options)	Завершение проверки файла, отправленного на проверку.
exportAsFixedFormat(outputFileName, exportFormat, options)	Сохранение документа в формате PDF или XPS.
exportAsFixedFormat(outputFileName, exportFormat, options)	Сохранение документа в формате PDF или XPS.
exportAsFixedFormat2(outputFileName, exportFormat, options)	Сохранение документа в формате PDF или XPS.
exportAsFixedFormat2(outputFileName, exportFormat, options)	Сохранение документа в формате PDF или XPS.
exportAsFixedFormat3(outputFileName, exportFormat, options)	Сохранение документа в формате PDF или XPS с улучшенными тегами.
exportAsFixedFormat3(outputFileName, exportFormat, options)	Сохранение документа в формате PDF или XPS с улучшенными тегами.
fitToPages()	Уменьшает размер шрифта текста настолько, чтобы количество страниц в документе сократилось на единицу.
followHyperlink(options)	Отображает кэшированный документ, если он уже был скачан. В противном случае этот метод разрешает гиперссылку, загружает целевой документ и отображает документ в соответствующем приложении.
freezeLayout()	Исправление макета документа в веб-представлении.
getAnnotationById(id)	Получает заметку по идентификатору. Выдает ошибку, `ItemNotFound` если заметки не найдены.
getBookmarkRange(name)	Получает диапазон закладки. Выдает ошибку, `ItemNotFound` если закладки нет.
getBookmarkRangeOrNullObject(name)	Получает диапазон закладки. Если закладки не существует, этот метод вернет объект со свойством `isNullObject` , установленным в `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getContentControls(options)	Получает поддерживаемые в настоящее время элементы управления содержимым в документе.
getCrossReferenceItems(referenceType)	Возвращает массив элементов, на которые можно ссылаться на основе указанного типа перекрестных ссылок.
getCrossReferenceItems(referenceType)	Возвращает массив элементов, на которые можно ссылаться на основе указанного типа перекрестных ссылок.
getEndnoteBody()	Получает концевые сноски документа в одном тексте.
getFootnoteBody()	Получает сноски документа в одном тексте.
getParagraphByUniqueLocalId(id)	Получает абзац по его уникальному локальному идентификатору. Если коллекция пустая, возникает `ItemNotFound` ошибка.
getRange(options)	Возвращает объект, `Range` используя указанные начальную и конечную позиции знака.
getSelection()	Возвращает текущий выбранный фрагмент документа. Выбор нескольких параметров не поддерживается.
getStyles()	Получает объект, `StyleCollection` представляющий весь набор стилей документа.
goTo(options)	Возвращает `Range` объект, представляющий начальную позицию указанного элемента, например страницу, закладку или поле.
importStylesFromJson(stylesJson, importedStylesConflictBehavior)	Импортируйте стили из строки в формате JSON.
importStylesFromJson(stylesJson, importedStylesConflictBehavior)	Импортируйте стили из строки в формате JSON.
insertFileFromBase64(base64File, insertLocation, insertFileOptions)	Вставляет документ в целевой документ в определенном месте с дополнительными свойствами. Верхние, нижние колонтитулы, подложки и другие свойства разделов копируются по умолчанию.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
lockServerFile()	Блокирует файл на сервере, не позволяя другим пользователям изменять его.
makeCompatibilityDefault()	Задает параметры совместимости.
manualHyphenation()	Инициирует ручное расстановку переносов по одной строке в документе.
merge(fileName, options)	Объединяет изменения, помеченные метками редакций, из одного документа в другой.
post()	Публикация документа в общедоступной папке Microsoft Exchange.
presentIt()	Открывает PowerPoint с загруженным документом Word.
printOut(options)	Печатает весь документ или его часть.
printPreview()	Переключение представления в режим предварительного просмотра.
protect(type, options)	Защищает документ от несанкционированных изменений.
protect(type, options)	Защищает документ от несанкционированных изменений.
redo(times)	Возвращает последнее отмененное действие (меняет метод на противоположное `undo` ).
rejectAllRevisions()	Отклоняет все исправления в документе.
rejectAllRevisionsShown()	Отклоняет все исправления в документе, отображаемые на экране.
reload()	Перезагружает кэшированный документ, разрешая гиперссылку на документ и загружая его.
reloadAs(encoding)	Перезагружает документ на основе HTML-документа, используя кодировку документа.
reloadAs(encoding)	Перезагружает документ на основе HTML-документа, используя кодировку документа.
removeDocumentInformation(removeDocInfoType)	Удаляет из документа конфиденциальные сведения, свойства, комментарии и другие метаданные.
removeDocumentInformation(removeDocInfoType)	Удаляет из документа конфиденциальные сведения, свойства, комментарии и другие метаданные.
removeLockedStyles()	Очищает документ от заблокированных стилей, если к документу были применены ограничения форматирования.
removeNumbers(numberType)	Удаляет из документа номера или маркеры.
removeNumbers(numberType)	Удаляет из документа номера или маркеры.
removeTheme()	Удаляет активную тему из текущего документа.
repaginate()	Перенастраивает весь документ.
replyWithChanges(options)	Отправляет сообщение электронной почты автору документа, отправленного на проверку, уведомляя его о том, что рецензент завершил проверку документа.
resetFormFields()	Очищает все поля формы в документе, тем самым подготавливая форму к повторному заполнению.
returnToLastReadPosition()	Возвращает документ в последнюю сохраненную позицию чтения.
runAutoMacro(autoMacro)	Запускает автоматический макрос, сохраненный в документе. Если указанного автомакроса не существует, ничего не происходит.
runAutoMacro(autoMacro)	Запускает автоматический макрос, сохраненный в документе. Если указанного автомакроса не существует, ничего не происходит.
save(saveBehavior, fileName)	Сохраняет документ.
save(saveBehavior, fileName)	Сохраняет документ.
saveAsQuickStyleSet(fileName)	Сохраняет группу экспресс-стилей, используемых в данный момент.
search(searchText, searchOptions)	Выполняет поиск с указанными параметрами поиска в областях всего документа. Результаты поиска представляют собой набор `Range` объектов.
select()	Выделение содержимого документа.
selectContentControlsByTag(tag)	Возвращает все элементы управления содержимым с указанным тегом.
selectContentControlsByTitle(title)	Возвращает `ContentControlCollection` объект, представляющий все элементы управления содержимым в документе с указанным названием.
selectLinkedControls(node)	Возвращает объект, `ContentControlCollection` представляющий все элементы управления содержимым в документе, связанные с определенным настраиваемым узлом XML.
selectNodes(xPath, options)	Возвращает объект, `XmlNodeCollection` представляющий все узлы, соответствующие параметру XPath, в порядке их появления в документе.
selectSingleNode(xPath, options)	Возвращает объект, `XmlNode` представляющий первый узел, соответствующий параметру XPath в документе.
selectUnlinkedControls(stream)	Возвращает объект, `ContentControlCollection` представляющий все элементы управления содержимым в документе, не связанные с узлом XML.
sendFax(address, subject)	Отправляет документ по факсу без вмешательства пользователя.
sendFaxOverInternet(options)	Отправляет документ поставщику услуг факсимильной связи, который отправляет его по факсу одному или нескольким указанным получателям.
sendForReview(options)	Отправляет документ в сообщении электронной почты на проверку указанными получателями.
sendMail()	Открывает окно сообщения для отправки документа через Microsoft Exchange.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
setDefaultTableStyle(style, setInTemplate)	Стиль таблицы, используемый для создаваемых таблиц в документе.
setPasswordEncryptionOptions(passwordEncryptionProvider, passwordEncryptionAlgorithm, passwordEncryptionKeyLength, passwordEncryptFileProperties)	Задание параметров, используемых Microsoft Word для шифрования документов с помощью паролей.
toggleFormsDesign()	Включает или выключает режим оформления формы.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.Document` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Word.Interfaces.DocumentData`), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех `.sync` вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
transformDocument(path, dataOnly)	Применяет указанный файл XSLT к документу и заменяет документ результатами.
undo(times)	Отмена последнего действия или последовательности действий, отображаемых в списке отмены.
undoClear()	Очищает список действий, которые можно отменить в документе.
unprotect(password)	Снимает защиту с документа.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить `context.sync()` , прежде чем освобождение памяти вступит в силу.
updateStyles()	Копирует все стили из вложенного шаблона в документ, перезаписывая все существующие стили в документе с такими же именами.
viewCode()	Отображение окна кода для выбранного элемента управления Microsoft ActiveX в документе.
viewPropertyBrowser()	Отображение окна свойств для выбранного элемента управления Microsoft ActiveX в документе.
webPagePreview()	Показывает предварительный просмотр текущего документа, как он выглядел бы при сохранении в виде веб-страницы.

События

onAnnotationClicked	Возникают, когда пользователь щелкает заметку (или выбирает ее с помощью клавиш ALT+ВНИЗ).
onAnnotationHovered	Возникают, когда пользователь наводит курсор на примечание.
onAnnotationInserted	Возникают, когда пользователь добавляет одну или несколько заметок.
onAnnotationPopupAction	Возникают, когда пользователь выполняет действие во всплывающем меню заметки.
onAnnotationRemoved	Возникают, когда пользователь удаляет одну или несколько заметок.
onContentControlAdded	Возникает при добавлении элемента управления содержимым. Выполните context.sync() в обработчике, чтобы получить свойства нового элемента управления содержимым.
onParagraphAdded	Возникает, когда пользователь добавляет новые абзацы.
onParagraphChanged	Возникает, когда пользователь изменяет абзацы.
onParagraphDeleted	Возникают, когда пользователь удаляет абзацы.

activeTheme

Получает имя активной темы и параметры форматирования.

readonly activeTheme: string;

Значение свойства

string

activeThemeDisplayName

Получает отображаемое имя активной темы.

readonly activeThemeDisplayName: string;

Значение свойства

string

activeWindow

Получает активное окно документа.

readonly activeWindow: Word.Window;

Значение свойства

Word.Window

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the first paragraph of each page.
  console.log("Getting first paragraph of each page...");

  // Get the active window.
  const activeWindow: Word.Window = context.document.activeWindow;
  activeWindow.load();

  // Get the active pane.
  const activePane: Word.Pane = activeWindow.activePane;
  activePane.load();

  // Get all pages.
  const pages: Word.PageCollection = activePane.pages;
  pages.load();

  await context.sync();

  // Get page index and paragraphs of each page.
  const pagesIndexes = [];
  const pagesNumberOfParagraphs = [];
  const pagesFirstParagraphText = [];
  for (let i = 0; i < pages.items.length; i++) {
    const page = pages.items[i];
    page.load("index");
    pagesIndexes.push(page);

    const paragraphs = page.getRange().paragraphs;
    paragraphs.load("items/length");
    pagesNumberOfParagraphs.push(paragraphs);

    const firstParagraph = paragraphs.getFirst();
    firstParagraph.load("text");
    pagesFirstParagraphText.push(firstParagraph);
  }

  await context.sync();

  for (let i = 0; i < pagesIndexes.length; i++) {
    console.log(`Page index: ${pagesIndexes[i].index}`);
    console.log(`Number of paragraphs: ${pagesNumberOfParagraphs[i].items.length}`);
    console.log("First paragraph's text:", pagesFirstParagraphText[i].text);
  }
});

areFilePropertiesPasswordEncrypted

Сообщает, шифрует ли Word свойства файлов для документов, защищенных паролем.

readonly areFilePropertiesPasswordEncrypted: boolean;

Значение свойства

boolean

areGrammaticalErrorsShown

Указывает, помечаются ли грамматические ошибки в документе волнистой зеленой линией.

areGrammaticalErrorsShown: boolean;

Значение свойства

boolean

areMathDefaultsUsed

Указывает, следует ли использовать математические параметры по умолчанию при создании новых уравнений.

areMathDefaultsUsed: boolean;

Значение свойства

boolean

areNewerFeaturesDisabled

Указывает, следует ли отключать функции, появившиеся после указанной версии.

areNewerFeaturesDisabled: boolean;

Значение свойства

boolean

areSpellingErrorsShown

Указывает, подчеркивает ли Microsoft Word орфографические ошибки в документе.

areSpellingErrorsShown: boolean;

Значение свойства

boolean

areStylesUpdatedOnOpen

Указывает, будут ли стили в этом документе обновляться в соответствии со стилями во вложенном шаблоне при каждом открытии документа.

areStylesUpdatedOnOpen: boolean;

Значение свойства

boolean

areTrueTypeFontsEmbedded

Указывает, внедряет ли Microsoft Word шрифты TrueType в документ при его сохранении.

areTrueTypeFontsEmbedded: boolean;

Значение свойства

boolean

attachedTemplate

Указывает объект, Template представляющий шаблон, прикрепленный к документу.

attachedTemplate: Word.Template;

Значение свойства

Word.Template

autoHyphenation

Указывает, включено ли автоматическое расстановка переносов для документа.

autoHyphenation: boolean;

Значение свойства

boolean

autoSaveOn

Указывает, сохраняются ли изменения в документе автоматически.

autoSaveOn: boolean;

Значение свойства

boolean

background

Получает Shape объект, который представляет фоновое изображение для документа.

readonly background: Word.Shape;

Значение свойства

Word.Shape

bibliography

Возвращает объект, Bibliography представляющий библиографические ссылки, содержащиеся в документе.

readonly bibliography: Word.Bibliography;

Значение свойства

Word.Bibliography

body

Получает Body объект основного документа. Основной текст — это текст, который исключает верхние, нижние колонтитулы, сноски, текстовые поля и т. д.

readonly body: Word.Body;

Значение свойства

Word.Body

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-body.yaml

// Inserts the body from the external document at the beginning of this document.
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
  // Create a proxy object for the document body.
  const body: Word.Body = context.document.body;

  // Queue a command to insert the Base64-encoded string representation of the body of the selected .docx file at the beginning of the current document.
  body.insertFileFromBase64(externalDocument, Word.InsertLocation.start);

  // Synchronize the document state by executing the queued commands, and return a promise to indicate task completion.
  await context.sync();

  console.log("Added Base64-encoded text to the beginning of the document body.");
});

bookmarks

Возвращает объект, BookmarkCollection представляющий все закладки в документе.

readonly bookmarks: Word.BookmarkCollection;

Значение свойства

Word.BookmarkCollection

builtInDocumentProperties

Получает объект, DocumentProperties представляющий все встроенные свойства документа.

readonly builtInDocumentProperties: Word.DocumentProperties;

Значение свойства

Word.DocumentProperties

changeTrackingMode

Определяет режим ChangeTracking.

changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";

Значение свойства

Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-change-tracking.yaml

// Gets the current change tracking mode.
await Word.run(async (context) => {
  const document: Word.Document = context.document;
  document.load("changeTrackingMode");
  await context.sync();

  if (document.changeTrackingMode === Word.ChangeTrackingMode.trackMineOnly) {
    console.log("Only my changes are being tracked.");
  } else if (document.changeTrackingMode === Word.ChangeTrackingMode.trackAll) {
    console.log("Everyone's changes are being tracked.");
  } else {
    console.log("No changes are being tracked.");
  }
});

characters

Получает объект, RangeScopedCollection который представляет все символы в документе.

readonly characters: Word.RangeScopedCollection;

Значение свойства

Word.RangeScopedCollection

coauthoring

Получает Coauthoring объект для управления совместным редактированием документа.

readonly coauthoring: Word.Coauthoring;

Значение свойства

Word.Coauthoring

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthors.yaml

// Gets the coauthoring capabilities and pending-update status of the document.
await Word.run(async (context) => {
  const coauthoring: Word.Coauthoring = context.document.coauthoring;
  coauthoring.load("canCoauthor,canMerge,pendingUpdates");
  await context.sync();

  console.log("Can coauthor:", coauthoring.canCoauthor);
  console.log("Can merge:", coauthoring.canMerge);
  console.log("Pending updates:", coauthoring.pendingUpdates);
});

codeName

Получает кодовое имя документа.

readonly codeName: string;

Значение свойства

string

comments

Получает объект, CommentCollection представляющий все примечания в документе.

readonly comments: Word.CommentCollection;

Значение свойства

Word.CommentCollection

compatibilityMode

Получает режим совместимости, который Word использует при открытии документа.

readonly compatibilityMode: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current";

Значение свойства

consecutiveHyphensLimit

Определяет максимальное количество последовательных строк, которые могут заканчиваться дефисами.

consecutiveHyphensLimit: number;

Значение свойства

number

content

Получает Range объект, представляющий основную историю документа.

readonly content: Word.Range;

Значение свойства

Word.Range

contentControls

Получает коллекцию ContentControl объектов в документе. Сюда входят элементы управления содержимым в основном тексте документа, верхних и нижних колонтитулах, текстовых полях и т. д.

readonly contentControls: Word.ContentControlCollection;

Значение свойства

Word.ContentControlCollection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-content-controls.yaml

// Adds title and colors to odd and even content controls and changes their appearance.
await Word.run(async (context) => {
  // Get the complete sentence (as range) associated with the insertion point.
  let evenContentControls = context.document.contentControls.getByTag("even");
  let oddContentControls = context.document.contentControls.getByTag("odd");
  evenContentControls.load("length");
  oddContentControls.load("length");

  await context.sync();

  for (let i = 0; i < evenContentControls.items.length; i++) {
    // Change a few properties and append a paragraph.
    evenContentControls.items[i].set({
      color: "red",
      title: "Odd ContentControl #" + (i + 1),
      appearance: Word.ContentControlAppearance.tags
    });
    evenContentControls.items[i].insertParagraph("This is an odd content control", "End");
  }

  for (let j = 0; j < oddContentControls.items.length; j++) {
    // Change a few properties and append a paragraph.
    oddContentControls.items[j].set({
      color: "green",
      title: "Even ContentControl #" + (j + 1),
      appearance: "Tags"
    });
    oddContentControls.items[j].insertHtml("This is an <b>even</b> content control", "End");
  }

  await context.sync();
});

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

currentRsid

Получает случайное число, которое Word назначает изменениям в документе.

readonly currentRsid: number;

Значение свойства

number

customDocumentProperties

Получает DocumentProperties коллекцию, представляющую все свойства настраиваемого документа для этого документа.

readonly customDocumentProperties: Word.DocumentProperties;

Значение свойства

Word.DocumentProperties

customXmlParts

Получает пользовательские части XML в документе.

readonly customXmlParts: Word.CustomXmlPartCollection;

Значение свойства

Word.CustomXmlPartCollection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-custom-xml-part.yaml

// Adds a custom XML part.
await Word.run(async (context) => {
  const originalXml =
    "<Reviewers><Reviewer>Juan</Reviewer><Reviewer>Hong</Reviewer><Reviewer>Sally</Reviewer></Reviewers>";
  const customXmlPart: Word.CustomXmlPart = context.document.customXmlParts.add(originalXml);
  customXmlPart.load("id");
  const xmlBlob = customXmlPart.getXml();

  await context.sync();

  const readableXml = addLineBreaksToXML(xmlBlob.value);
  console.log("Added custom XML part:", readableXml);

  // Store the XML part's ID in a setting so the ID is available to other functions.
  const settings: Word.SettingCollection = context.document.settings;
  settings.add("ContosoReviewXmlPartId", customXmlPart.id);

  await context.sync();
});

defaultTabStop

Интервал (в пунктах) между остановками табуляции по умолчанию в документе.

defaultTabStop: number;

Значение свойства

number

defaultTargetFrame

Указывает фрейм браузера для отображения веб-страницы через гиперссылку.

defaultTargetFrame: string;

Значение свойства

string

documentLibraryVersions

Возвращает объект, DocumentLibraryVersionCollection представляющий коллекцию версий общего документа с включенным управлением версиями и хранящийся в библиотеке документов на сервере.

readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection;

Значение свойства

Word.DocumentLibraryVersionCollection

doNotEmbedSystemFonts

Указывает, не следует ли Word внедрять распространенные системные шрифты.

doNotEmbedSystemFonts: boolean;

Значение свойства

boolean

encryptionProvider

Указывает имя поставщика алгоритма шифрования, используемого Microsoft Word при шифровании документов.

encryptionProvider: string;

Значение свойства

string

farEastLineBreakLanguage

Указывает восточноазиатский язык, используемый для разрыва строки.

farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese";

Значение свойства

Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"

farEastLineBreakLevel

Уровень управления разрывом строки.

farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom";

Значение свойства

Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"

fields

Получает FieldCollection объект, представляющий все поля в документе.

readonly fields: Word.FieldCollection;

Значение свойства

Word.FieldCollection

formattingIsNextLevelShown

Указывает, отображается ли в Word следующий уровень заголовка при использовании предыдущего.

formattingIsNextLevelShown: boolean;

Значение свойства

boolean

formattingIsUserStyleNameShown

Указывает, должны ли отображаться пользовательские стили.

formattingIsUserStyleNameShown: boolean;

Значение свойства

boolean

frames

Возвращает объект, FrameCollection представляющий все кадры в документе.

readonly frames: Word.FrameCollection;

Значение свойства

Word.FrameCollection

fullName

Получает имя документа, включая путь.

readonly fullName: string;

Значение свойства

string

grammaticalErrors

Получает объект, RangeCollection представляющий предложения, не прошедшие проверку грамматики в документе.

readonly grammaticalErrors: Word.RangeCollection;

Значение свойства

Word.RangeCollection

gridDistanceHorizontal

Определяет горизонтальное пространство между невидимыми линиями сетки, которое Microsoft Word использует при рисовании, перемещении и изменении размеров автофигур или восточноазиатских символов в документе.

gridDistanceHorizontal: number;

Значение свойства

number

gridDistanceVertical

Определяет вертикальное расстояние между невидимыми линиями сетки, которое Microsoft Word использует при рисовании, перемещении и изменении размера автофигур или восточноазиатских символов в документе.

gridDistanceVertical: number;

Значение свойства

number

gridIsOriginFromMargin

Определяет, начинается ли сетка символов с левого верхнего угла страницы.

gridIsOriginFromMargin: boolean;

Значение свойства

boolean

gridOriginHorizontal

Указывает горизонтальную точку начала координат для невидимой сетки.

gridOriginHorizontal: number;

Значение свойства

number

gridOriginVertical

Задает вертикальную точку начала координат для невидимой сетки.

gridOriginVertical: number;

Значение свойства

number

gridSpaceBetweenHorizontalLines

Интервал для горизонтальных линий сетки в режиме разметки.

gridSpaceBetweenHorizontalLines: number;

Значение свойства

number

gridSpaceBetweenVerticalLines

Интервал для вертикальных линий сетки символов в режиме разметки.

gridSpaceBetweenVerticalLines: number;

Значение свойства

number

hasPassword

Получает сведения о том, требуется ли пароль для открытия документа.

readonly hasPassword: boolean;

Значение свойства

boolean

hasVbProject

Получает сведения о том, есть ли в документе вложенный проект Microsoft Visual Basic для приложений.

readonly hasVbProject: boolean;

Значение свойства

boolean

hyperlinks

Возвращает объект, HyperlinkCollection представляющий все гиперссылки в документе.

readonly hyperlinks: Word.HyperlinkCollection;

Значение свойства

Word.HyperlinkCollection

hyphenateCaps

Указывает, можно ли писать дефисы со словами, написанными всеми прописными буквами.

hyphenateCaps: boolean;

Значение свойства

boolean

hyphenationZone

Задает ширину зоны переносов в точках.

hyphenationZone: number;

Значение свойства

number

indexes

Возвращает объект, IndexCollection представляющий все индексы в документе.

readonly indexes: Word.IndexCollection;

Значение свойства

Word.IndexCollection

isAutoFormatOverrideOn

Определяет, переопределяют ли параметры автоматического форматирования ограничения форматирования.

isAutoFormatOverrideOn: boolean;

Значение свойства

boolean

isChartDataPointTracked

Указывает, используется ли для диаграмм в активном документе отслеживание точек данных по ссылкам на ячейки.

isChartDataPointTracked: boolean;

Значение свойства

boolean

isCompatible

Указывает, включен ли параметр совместимости, указанный свойством type .

isCompatible: boolean;

Значение свойства

boolean

isFinal

Указывает, является ли документ окончательным.

isFinal: boolean;

Значение свойства

boolean

isFontsSubsetSaved

Указывает, сохраняет ли Microsoft Word подмножество внедренных шрифтов TrueType вместе с документом.

isFontsSubsetSaved: boolean;

Значение свойства

boolean

isFormsDataPrinted

Указывает, будет ли Microsoft Word печатать на предварительно напечатанной форме только данные, введенные в соответствующую веб-форму.

isFormsDataPrinted: boolean;

Значение свойства

boolean

isFormsDataSaved

Указывает, сохраняет ли Microsoft Word данные, введенные в форму, в виде записи с разделителями табуляции для использования в базе данных.

isFormsDataSaved: boolean;

Значение свойства

boolean

isGrammarChecked

Указывает, была ли выполнена проверка грамматики в документе.

isGrammarChecked: boolean;

Значение свойства

boolean

isInAutoSave

Получает сведения о том, было ли последнее срабатывание Application.DocumentBeforeSave события результатом автоматического сохранения документом или сохранения вручную пользователем.

readonly isInAutoSave: boolean;

Значение свойства

boolean

isInFormsDesign

Получает сведения о том, находится ли документ в режиме конструктора форм.

readonly isInFormsDesign: boolean;

Значение свойства

boolean

isKerningByAlgorithm

Указывает, используются ли в Word полуширинные латинские символы и знаки препинания.

isKerningByAlgorithm: boolean;

Значение свойства

boolean

isLinguisticDataEmbedded

Указывает, следует ли внедрять голосовые функции и данные рукописного ввода.

isLinguisticDataEmbedded: boolean;

Значение свойства

boolean

isMasterDocument

Определяет, является ли документ документом master.

readonly isMasterDocument: boolean;

Значение свойства

boolean

isOptimizedForWord97

Указывает, оптимизирует ли Word документ для Word 97.

isOptimizedForWord97: boolean;

Значение свойства

boolean

isPostScriptPrintedOverText

Указывает, следует ли печатать инструкции поля PRINT (например, команды PostScript) в документе поверх текста и рисунков при использовании принтера PostScript.

isPostScriptPrintedOverText: boolean;

Значение свойства

boolean

isQuickStyleSetLocked

Определяет, могут ли пользователи изменять набор экспресс-стилей.

isQuickStyleSetLocked: boolean;

Значение свойства

boolean

isReadOnly

Указывает, нельзя ли сохранить изменения в документе в исходном документе.

readonly isReadOnly: boolean;

Значение свойства

boolean

isReadOnlyRecommended

Указывает, отображает ли Microsoft Word окно сообщения, когда пользователь открывает документ, предлагая открыть его только для чтения.

isReadOnlyRecommended: boolean;

Значение свойства

boolean

isSnappedToGrid

Указывает, выравниваются ли автофигуры или восточноазиатские символы по невидимой сетке.

isSnappedToGrid: boolean;

Значение свойства

boolean

isSnappedToShapes

Выравнивание автофигур или восточноазиатских знаков невидимыми линиями сетки через другие фигуры.

isSnappedToShapes: boolean;

Значение свойства

boolean

isSpellingChecked

Указывает, проверялась ли орфография во всем документе.

isSpellingChecked: boolean;

Значение свойства

boolean

isStyleEnforced

Указывает, применяются ли ограничения форматирования к защищенному документу.

isStyleEnforced: boolean;

Значение свойства

boolean

isSubdocument

Определяет, является ли документ вложенным документом master документа.

readonly isSubdocument: boolean;

Значение свойства

boolean

isThemeLocked

Определяет, могут ли пользователи изменять тему документа.

isThemeLocked: boolean;

Значение свойства

boolean

isUserControl

Указывает, был ли документ создан или открыт пользователем.

isUserControl: boolean;

Значение свойства

boolean

isVbaSigned

Получает сведения о том, имеет ли проект VBA цифровую подпись.

readonly isVbaSigned: boolean;

Значение свойства

boolean

isWriteReserved

Получает сведения о том, защищен ли документ паролем записи.

readonly isWriteReserved: boolean;

Значение свойства

boolean

justificationMode

Настройка межзнакового интервала.

justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana";

Значение свойства

Word.JustificationMode | "Expand" | "Compress" | "CompressKana"

kind

Тип формата, используемый Microsoft Word при автоматическом форматировании документа.

kind: Word.DocumentKind | "NotSpecified" | "Letter" | "Email";

Значение свойства

Word.DocumentKind | "NotSpecified" | "Letter" | "Email"

languageDetected

Указывает, определил ли Microsoft Word язык текста документа.

languageDetected: boolean;

Значение свойства

boolean

listParagraphs

Получает ParagraphCollection объект, представляющий все пронумерованные абзацы в документе.

readonly listParagraphs: Word.ParagraphCollection;

Значение свойства

Word.ParagraphCollection

lists

Получает объект, ListCollection который содержит все отформатированные списки в документе.

readonly lists: Word.ListCollection;

Значение свойства

Word.ListCollection

listTemplates

Возвращает объект, ListTemplateCollection представляющий все шаблоны списков в документе.

readonly listTemplates: Word.ListTemplateCollection;

Значение свойства

Word.ListTemplateCollection

noLineBreakAfter

Задает символы кинсоку, после которых Word не разрывает строку.

noLineBreakAfter: string;

Значение свойства

string

noLineBreakBefore

Задает символы кинсоку, перед которыми Word не разрывает строку.

noLineBreakBefore: string;

Значение свойства

string

openEncoding

Получает кодировку, используемую для открытия документа.

readonly openEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

Значение свойства

originalDocumentTitle

Получает название исходного документа после сравнения с юридической черной линией.

readonly originalDocumentTitle: string;

Значение свойства

string

pageSetup

Возвращает объект, PageSetup связанный с документом.

readonly pageSetup: Word.PageSetup;

Значение свойства

Word.PageSetup

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-section-starts.yaml

await Word.run(async (context) => {

  // Configure document-wide page settings for a report that will be printed and bound.
  const pageSetup: Word.PageSetup = context.document.pageSetup;
  pageSetup.set({
    paperSize: Word.PaperSize.letter,
    orientation: Word.PageOrientation.portrait,
    topMargin: 72,
    bottomMargin: 72,
    leftMargin: 90,
    rightMargin: 72,
    gutter: 18,
    gutterPosition: Word.GutterPosition.left,
    mirrorMargins: true,
    oddAndEvenPagesHeaderFooter: true
  });

  const sections: Word.SectionCollection = context.document.sections;
  sections.load("items");
  await context.sync();

  // Start the main chapter on an odd-numbered page so it appears on the right in a bound document.
  const chapterPageSetup: Word.PageSetup = sections.items[1].pageSetup;
  chapterPageSetup.sectionStart = Word.SectionStart.oddPage;
  chapterPageSetup.differentFirstPageHeaderFooter = true;

  // Keep the appendix in a separate section, but let it begin on the current page.
  sections.items[2].pageSetup.sectionStart = Word.SectionStart.continuous;

  await context.sync();
  console.log("Applied print and binding settings to the report.");
});

paragraphs

Получает объект, ParagraphCollection представляющий все абзацы в документе.

readonly paragraphs: Word.ParagraphCollection;

Значение свойства

Word.ParagraphCollection

password

Устанавливает пароль, который необходимо указать, чтобы открыть документ.

password: string;

Значение свойства

string

passwordEncryptionAlgorithm

Получает алгоритм, используемый для шифрования пароля.

readonly passwordEncryptionAlgorithm: string;

Значение свойства

string

passwordEncryptionKeyLength

Получает длину ключа, используемого для шифрования пароля.

readonly passwordEncryptionKeyLength: number;

Значение свойства

number

passwordEncryptionProvider

Получает имя поставщика шифрования паролей.

readonly passwordEncryptionProvider: string;

Значение свойства

string

path

Получает диск или веб-путь к документу (за исключением имени документа).

readonly path: string;

Значение свойства

string

printRevisions

Указывает, печатаются ли метки редакций на документе.

printRevisions: boolean;

Значение свойства

boolean

properties

Получает свойства документа.

readonly properties: Word.DocumentProperties;

Значение свойства

Word.DocumentProperties

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml

await Word.run(async (context) => {
    const builtInProperties: Word.DocumentProperties = context.document.properties;
    builtInProperties.load("*"); // Let's get all!

    await context.sync();
    console.log(JSON.stringify(builtInProperties, null, 4));
});

protectionType

Получает тип защиты для документа.

readonly protectionType: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading";

Значение свойства

readabilityStatistics

Получает ReadabilityStatisticCollection объект, представляющий статистику удобочитаемости для документа.

readonly readabilityStatistics: Word.ReadabilityStatisticCollection;

Значение свойства

Word.ReadabilityStatisticCollection

readingLayoutSizeX

Определяет ширину страниц в режиме разметки для чтения при закреплении.

readingLayoutSizeX: number;

Значение свойства

number

readingLayoutSizeY

Указывает высоту страниц в режиме разметки для чтения при закреплении.

readingLayoutSizeY: number;

Значение свойства

number

readingModeIsLayoutFrozen

Указывает, закрепляются ли страницы в режиме разметки для рукописного ввода.

readingModeIsLayoutFrozen: boolean;

Значение свойства

boolean

removePersonalInformationOnSave

Указывает, удаляет ли Word сведения о пользователе при сохранении.

removePersonalInformationOnSave: boolean;

Значение свойства

boolean

revisedDocumentTitle

Получает название исправленного документа после сравнения с юридической черной линией.

readonly revisedDocumentTitle: string;

Значение свойства

string

revisions

Получает коллекцию исправлений, которые представляют отслеживаемые изменения в документе.

readonly revisions: Word.RevisionCollection;

Значение свойства

Word.RevisionCollection

saved

Указывает, сохранены ли изменения, внесенные в документ. Значение "of" true означает, что документ не изменился с момента сохранения.

readonly saved: boolean;

Значение свойства

boolean

saveEncoding

Указывает кодировку, используемую при сохранении документа.

saveEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

Значение свойства

saveFormat

Получает формат файла документа.

readonly saveFormat: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument";

Значение свойства

sections

Получает коллекцию Section объектов в документе.

readonly sections: Word.SectionCollection;

Значение свойства

Word.SectionCollection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-header-and-footer.yaml

await Word.run(async (context) => {
  context.document.sections
    .getFirst()
    .getFooter("EvenPages")
    .insertParagraph("This is an even-pages footer.", "End");

  await context.sync();
});

selection

Возвращает объект, Selection представляющий текущий выделенный фрагмент в документе.

readonly selection: Word.Selection;

Значение свойства

Word.Selection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/55-selection/insert-formula.yaml

// Inserts a formula field without specifying the formula expression.
// Word determines the formula automatically based on adjacent cell values:
// if there are values above the cell, it inserts =SUM(ABOVE);
// if there are values to the left, it inserts =SUM(LEFT).
// The selection must be in a table cell with at least one adjacent cell that contains a value.
await Word.run(async (context) => {
  const options: Word.SelectionInsertFormulaOptions = {
    numberFormat: "#,##0.00",
  };
  context.document.selection.insertFormula(options);
  await context.sync();

  console.log("Inserted formula (auto-determined by Word) with number format.");
});

sensitivityLabel

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает метку конфиденциальности документа.

readonly sensitivityLabel: Word.SensitivityLabel;

Значение свойства

Word.SensitivityLabel

sentences

Получает объект, RangeScopedCollection который представляет все предложения в документе.

readonly sentences: Word.RangeScopedCollection;

Значение свойства

Word.RangeScopedCollection

settings

Получает параметры надстройки в документе.

readonly settings: Word.SettingCollection;

Значение свойства

Word.SettingCollection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-settings.yaml

// Gets all custom settings this add-in set on this document.
await Word.run(async (context) => {
  const settings: Word.SettingCollection = context.document.settings;
  settings.load("items");
  await context.sync();

  if (settings.items.length == 0) {
    console.log("There are no settings.");
  } else {
    console.log("All settings:");
    for (let i = 0; i < settings.items.length; i++) {
      console.log(settings.items[i]);
    }
  }
});

spellingErrors

Получает объект, RangeCollection представляющий слова, определенные как орфографические ошибки в документе.

readonly spellingErrors: Word.RangeCollection;

Значение свойства

Word.RangeCollection

storyRanges

Получает объект, RangeCollection представляющий все истории в документе.

readonly storyRanges: Word.RangeCollection;

Значение свойства

Word.RangeCollection

styles

Получает a StyleCollection за документ.

readonly styles: Word.StyleCollection;

Значение свойства

Word.StyleCollection

tableOfAuthoritiesCategories

Возвращает TableOfAuthoritiesCategoryCollection объект, представляющий доступную таблицу категорий центров распространения в документе.

readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection;

Значение свойства

Word.TableOfAuthoritiesCategoryCollection

tables

Получает объект, TableCollection представляющий все таблицы в документе.

readonly tables: Word.TableCollection;

Значение свойства

Word.TableCollection

tablesOfAuthorities

Возвращает объект, TableOfAuthoritiesCollection представляющий все таблицы центров распространения информации в документе.

readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection;

Значение свойства

Word.TableOfAuthoritiesCollection

tablesOfContents

Возвращает объект, TableOfContentsCollection представляющий все оглавления в документе.

readonly tablesOfContents: Word.TableOfContentsCollection;

Значение свойства

Word.TableOfContentsCollection

tablesOfFigures

Возвращает объект, представляющий TableOfFiguresCollection все списки иллюстраций в документе.

readonly tablesOfFigures: Word.TableOfFiguresCollection;

Значение свойства

Word.TableOfFiguresCollection

textEncoding

Задает кодировку для сохранения в виде закодированного текста.

textEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

Значение свойства

textLineEnding

Указывает, как Word помечает разрывы строк и абзацев в текстовых файлах.

textLineEnding: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps";

Значение свойства

trackedChangesAreDateAndTimeRemoved

Указывает, следует ли удалять или сохранять метаданные даты и времени для отслеживаемых изменений.

trackedChangesAreDateAndTimeRemoved: boolean;

Значение свойства

boolean

trackFormatting

Указывает, нужно ли отслеживать изменения форматирования, если отслеживание изменений включено.

trackFormatting: boolean;

Значение свойства

boolean

trackMoves

Указывает, следует ли помечать перемещенный текст, если режим исправлений включен.

trackMoves: boolean;

Значение свойства

boolean

trackRevisions

Указывает, отслеживаются ли изменения в документе.

trackRevisions: boolean;

Значение свойства

boolean

type

Получает тип документа (шаблон или документ).

readonly type: Word.DocumentType | "Document" | "Template" | "Frameset";

Значение свойства

Word.DocumentType | "Document" | "Template" | "Frameset"

webSettings

Получает WebSettings объект для атрибутов, связанных с веб-страницей.

readonly webSettings: Word.WebSettings;

Значение свойства

Word.WebSettings

windows

Получает коллекцию Word.Window объектов для документа.

readonly windows: Word.WindowCollection;

Значение свойства

Word.WindowCollection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the document windows.
  const windows: Word.WindowCollection = context.document.windows;
  windows.load("windows/items/length");

  await context.sync();

  console.log(`Number of windows for this document: ${windows.items.length}`);
});

words

Получает объект, RangeScopedCollection который представляет каждое слово в документе.

readonly words: Word.RangeScopedCollection;

Значение свойства

Word.RangeScopedCollection

writePassword

Устанавливает пароль для сохранения изменений в документе.

writePassword: string;

Значение свойства

string

xmlAreAdvancedErrorsShown

Указывает, создаются ли сообщения об ошибках на основе встроенных сообщений Word или MSXML (Microsoft XML).

xmlAreAdvancedErrorsShown: boolean;

Значение свойства

boolean

xmlIsXsltUsedWhenSaving

Указывает, следует ли сохранять документ с помощью расширяемого языкового преобразования таблицы стилей (XSLT).

xmlIsXsltUsedWhenSaving: boolean;

Значение свойства

boolean

xmlSaveThroughXslt

Указывает путь и имя файла XSLT, применяемого при сохранении документа.

xmlSaveThroughXslt: string;

Значение свойства

string

acceptAllRevisions()

Принимает все исправления в документе.

acceptAllRevisions(): void;

Возвращаемое значение

void

acceptAllRevisionsShown()

Принимает все исправления в документе, отображаемые на экране.

acceptAllRevisionsShown(): void;

Возвращаемое значение

void

activate()

Активирует документ, чтобы он стал активным.

activate(): void;

Возвращаемое значение

void

addStyle(name, type)

Добавляет стиль в документ по имени и типу.

addStyle(name: string, type: Word.StyleType): Word.Style;

Параметры

name: string

Строка, представляющая имя стиля.

type: Word.StyleType

Тип стиля, включая символ, список, абзац или таблицу.

Возвращаемое значение

Word.Style

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/manage-styles.yaml

// Adds a new style.
await Word.run(async (context) => {
  const newStyleName = (document.getElementById("new-style-name") as HTMLInputElement).value;
  if (newStyleName == "") {
    console.warn("Enter a style name to add.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(newStyleName);
  style.load();
  await context.sync();

  if (!style.isNullObject) {
    console.warn(
      `There's an existing style with the same name '${newStyleName}'! Please provide another style name.`
    );
    return;
  }

  const newStyleType = ((document.getElementById("new-style-type") as HTMLSelectElement).value as unknown) as Word.StyleType;
  context.document.addStyle(newStyleName, newStyleType);
  await context.sync();

  console.log(newStyleName + " has been added to the style list.");
});

addStyle(name, type)

Добавляет стиль в документ по имени и типу.

addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style;

Параметры

name: string

Строка, представляющая имя стиля.

type: "Character" | "List" | "Paragraph" | "Table"

Тип стиля, включая символ, список, абзац или таблицу.

Возвращаемое значение

Word.Style

addToFavorites()

Создает ярлык для документа или гиперссылки и добавляет ее в папку "Избранное ".

addToFavorites(): void;

Возвращаемое значение

void

applyQuickStyleSet(style)

Применяет указанный экспресс-стиль к документу.

applyQuickStyleSet(style: Word.ApplyQuickStyleSet): void;

Параметры

style: Word.ApplyQuickStyleSet

Стиль, который нужно применить.

Возвращаемое значение

void

applyQuickStyleSet(style)

Применяет указанный экспресс-стиль к документу.

applyQuickStyleSet(style: "SessionStart" | "Template"): void;

Параметры

style: "SessionStart" | "Template"

Стиль, который нужно применить.

Возвращаемое значение

void

applyTheme(name)

Применяет заданную тему к данному документу.

applyTheme(name: string): void;

Параметры

name: string

Имя темы.

Возвращаемое значение

void

autoFormat()

Автоматическое форматирование документа.

autoFormat(): void;

Возвращаемое значение

void

canCheckin()

Возвращаетtrue, если Microsoft Word может выполнить проверку документа на сервере.

canCheckin(): OfficeExtension.ClientResult<boolean>;

Возвращаемое значение

OfficeExtension.ClientResult<boolean>

true можно ли вернуть документ; в противном случае, false.

checkConsistencyJapanese()

Осуществляет поиск по всему тексту в документе на японском языке и показывает случаи, когда символы используются непоследовательно для одних и тех же слов.

checkConsistencyJapanese(): void;

Возвращаемое значение

void

checkGrammar()

Начало проверки орфографии и грамматики документа.

checkGrammar(): void;

Возвращаемое значение

void

checkIn(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает документ с локального компьютера на сервер и устанавливает локальный документ только для чтения, чтобы его нельзя было редактировать локально.

checkIn(options?: Word.DocumentCheckInOptions): void;

Параметры

options: Word.DocumentCheckInOptions

Необязательный параметр. Параметры конфигурации для возврата документа.

Возвращаемое значение

void

checkInWithVersion(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Сохраняет документ на сервере с локального компьютера и устанавливает для него режим только для чтения, чтобы его нельзя было редактировать локально.

checkInWithVersion(options?: Word.DocumentCheckInWithVersionOptions): void;

Параметры

options: Word.DocumentCheckInWithVersionOptions

Необязательный параметр. Параметры конфигурации для возврата документа с контролем версий.

Возвращаемое значение

void

checkSpelling(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Начало проверки орфографии документа.

checkSpelling(options?: Word.DocumentCheckSpellingOptions): void;

Параметры

options: Word.DocumentCheckSpellingOptions

Необязательный параметр. Параметры конфигурации для проверки орфографии.

Возвращаемое значение

void

close(closeBehavior)

Закрывает текущий документ.

Примечание. Этот API не поддерживается в Word в Интернете.

close(closeBehavior?: Word.CloseBehavior): void;

Параметры

closeBehavior: Word.CloseBehavior

Необязательный параметр. Поведение закрытия должно быть save или skipSave. Значение по умолчанию: save.

Возвращаемое значение

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml

// Closes the document with default behavior
// for current state of the document.
await Word.run(async (context) => {
  context.document.close();
});

close(closeBehavior)

Закрывает текущий документ.

Примечание. Этот API не поддерживается в Word в Интернете.

close(closeBehavior?: "Save" | "SkipSave"): void;

Параметры

closeBehavior: "Save" | "SkipSave"

Необязательный параметр. Поведение закрытия должно быть save или skipSave. Значение по умолчанию: save.

Возвращаемое значение

void

closePrintPreview()

Переключает документ из предварительного просмотра в предыдущий вид.

closePrintPreview(): void;

Возвращаемое значение

void

compare(filePath, documentCompareOptions)

Отображает метки рецензирования, которые показывают, чем указанный документ отличается от другого.

compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void;

Параметры

filePath: string

Путь к документу, с которым сравнивается указанный документ.

documentCompareOptions: Word.DocumentCompareOptions

Необязательный параметр. Дополнительные параметры, определяющие поведение сравнения документов.

Возвращаемое значение

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/compare-documents.yaml

// Compares the current document with a specified external document.
await Word.run(async (context) => {
  // Absolute path of an online or local document.
  const filePath = (document.getElementById("filePath") as HTMLInputElement).value;
  // Options that configure the compare operation.
  const options: Word.DocumentCompareOptions = {
    compareTarget: Word.CompareTarget.compareTargetCurrent,
    detectFormatChanges: false
    // Other options you choose...
    };
  context.document.compare(filePath, options);

  await context.sync();

  console.log("Differences shown in the current document.");
});

compareFromBase64(base64File, documentCompareOptions)

Отображает метки рецензирования, которые показывают, чем указанный документ отличается от другого.

compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void;

Параметры

base64File: string

Содержимое документа в кодировке Base64, с которым сравнивается указанный документ.

documentCompareOptions: Word.DocumentCompareOptions

Необязательный параметр. Дополнительные параметры, определяющие поведение для сравнения документов. Обратите внимание, что этот compareTarget параметр не должен быть compareTargetSelected в этом API.

Возвращаемое значение

void

computeStatistics(statistic, includeFootnotesAndEndnotes)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает статистику на основе содержимого документа.

computeStatistics(statistic: Word.StatisticType, includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult<number>;

Параметры

statistic: Word.StatisticType

Тип возвращаемой статистики.

includeFootnotesAndEndnotes: boolean

Необязательный параметр. Следует ли включать обычные и концевые сноски. Значение по умолчанию: false.

Возвращаемое значение

OfficeExtension.ClientResult<number>

computeStatistics(statistic, includeFootnotesAndEndnotes)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает статистику на основе содержимого документа.

computeStatistics(statistic: "Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters", includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult<number>;

Параметры

statistic: "Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters"

Тип возвращаемой статистики.

includeFootnotesAndEndnotes: boolean

convertNumbersToText(numberType?: Word.NumberType): void;

Параметры

numberType: Word.NumberType

Необязательный параметр. Тип преобразуемой нумерации.

Возвращаемое значение

void

convertNumbersToText(numberType)

Заменяет номера списков и поля LISTNUM в документе текстом.

convertNumbersToText(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void;

Параметры

numberType: "Paragraph" | "ListNum" | "AllNumbers"

Необязательный параметр. Тип преобразуемой нумерации.

Возвращаемое значение

void

convertVietnameseDocument(codePageOrigin)

Преобразует вьетнамский документ в Юникод с помощью кодовой страницы, отличной от заданной по умолчанию.

convertVietnameseDocument(codePageOrigin: number): void;

Параметры

codePageOrigin: number

Кодовая страница, которую нужно использовать.

Возвращаемое значение

void

copyStylesFromTemplate(StyleTemplate)

Копирует стили из указанного шаблона в документ.

copyStylesFromTemplate(StyleTemplate: string): void;

Параметры

StyleTemplate: string

Шаблон, из которого нужно скопировать стили.

Возвращаемое значение

void

countNumberedItems(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает количество маркированных или нумерованных элементов и полей LISTNUM в документе.

countNumberedItems(options?: Word.DocumentCountNumberedItemsOptions): OfficeExtension.ClientResult<number>;

Параметры

options: Word.DocumentCountNumberedItemsOptions

Необязательный параметр. Параметры конфигурации для подсчета нумерованных элементов.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество нумерованных элементов.

deleteAllComments()

Удаляет все примечания из документа.

deleteAllComments(): void;

Возвращаемое значение

void

deleteAllCommentsShown()

Удаляются все исправления в документе, отображаемые на экране.

deleteAllCommentsShown(): void;

Возвращаемое значение

void

deleteAllInkAnnotations()

Удаляются все рукописные заметки в документе.

deleteAllInkAnnotations(): void;

Возвращаемое значение

void

deleteBookmark(name)

Удаляет закладку (если она есть) из документа.

deleteBookmark(name: string): void;

Параметры

name: string

Имя закладки без учета регистра.

Возвращаемое значение

void

detectLanguage()

Анализирует текст документа для определения языка.

detectLanguage(): void;

Возвращаемое значение

void

endReview(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Завершение проверки файла, отправленного на проверку.

endReview(options?: Word.DocumentEndReviewOptions): void;

Параметры

options: Word.DocumentEndReviewOptions

Необязательный параметр. Параметры конфигурации для завершения процесса проверки.

Возвращаемое значение

void

exportAsFixedFormat(outputFileName, exportFormat, options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Сохранение документа в формате PDF или XPS.

exportAsFixedFormat(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormatOptions): void;

Параметры

outputFileName: string

Имя выходного файла.

exportFormat: Word.ExportFormat

Формат экспорта.

options: Word.DocumentExportAsFixedFormatOptions

Необязательный параметр. Параметры конфигурации для операции экспорта.

Возвращаемое значение

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/export.yaml

await Word.run(async (context) => {
  // Choose whether the exported PDF uses Word headings, named bookmarks, or neither.
  const bookmarkMode = (document.getElementById("bookmark-mode") as HTMLSelectElement).value;
  let createBookmarks: Word.ExportCreateBookmarks;

  switch (bookmarkMode) {
    case "Headings":
      createBookmarks = Word.ExportCreateBookmarks.headings;
      break;
    case "WordBookmarks":
      createBookmarks = Word.ExportCreateBookmarks.wordBookmarks;
      break;
    default:
      createBookmarks = Word.ExportCreateBookmarks.none;
      break;
  }

  // Export the current document as a PDF saved in your default location, usually Documents.
  const filename = `exported-doc-${bookmarkMode}-${getCurrentDate()}.pdf`;
  console.log(`File name: ${filename}`);
  const options: Word.DocumentExportAsFixedFormatOptions = {
    item: Word.ExportItem.documentContent,
    openAfterExport: true,
    optimizeFor: Word.ExportOptimizeFor.onScreen,
    createBookmarks: createBookmarks,
  };

  // If a file with the same name already exists at the default location, it's silently overwritten.
  context.document.exportAsFixedFormat(filename, Word.ExportFormat.pdf, options);

  await context.sync();
});

exportAsFixedFormat(outputFileName, exportFormat, options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Сохранение документа в формате PDF или XPS.

exportAsFixedFormat(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormatOptions): void;

Параметры

outputFileName: string

Имя выходного файла.

exportFormat: "Pdf" | "Xps"

Формат экспорта.

options: Word.DocumentExportAsFixedFormatOptions

Необязательный параметр. Параметры конфигурации для операции экспорта.

Возвращаемое значение

void

exportAsFixedFormat2(outputFileName, exportFormat, options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Сохранение документа в формате PDF или XPS.

exportAsFixedFormat2(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat2Options): void;

Параметры

outputFileName: string

Имя выходного файла.

exportFormat: Word.ExportFormat

Формат для экспорта (PDF/XPS).

options: Word.DocumentExportAsFixedFormat2Options

Необязательный параметр. Параметры конфигурации для операции экспорта.

Возвращаемое значение

void

exportAsFixedFormat2(outputFileName, exportFormat, options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Сохранение документа в формате PDF или XPS.

exportAsFixedFormat2(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat2Options): void;

Параметры

outputFileName: string

Имя выходного файла.

exportFormat: "Pdf" | "Xps"

Формат для экспорта (PDF/XPS).

options: Word.DocumentExportAsFixedFormat2Options

Необязательный параметр. Параметры конфигурации для операции экспорта.

Возвращаемое значение

void

exportAsFixedFormat3(outputFileName, exportFormat, options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Сохранение документа в формате PDF или XPS с улучшенными тегами.

exportAsFixedFormat3(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat3Options): void;

Параметры

outputFileName: string

Имя выходного файла.

exportFormat: Word.ExportFormat

Формат для экспорта (PDF/XPS).

options: Word.DocumentExportAsFixedFormat3Options

Необязательный параметр. Параметры конфигурации для операции экспорта.

Возвращаемое значение

void

exportAsFixedFormat3(outputFileName, exportFormat, options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Сохранение документа в формате PDF или XPS с улучшенными тегами.

exportAsFixedFormat3(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat3Options): void;

Параметры

outputFileName: string

Имя выходного файла.

exportFormat: "Pdf" | "Xps"

Формат для экспорта (PDF/XPS).

options: Word.DocumentExportAsFixedFormat3Options

Необязательный параметр. Параметры конфигурации для операции экспорта.

Возвращаемое значение

void

fitToPages()

Уменьшает размер шрифта текста настолько, чтобы количество страниц в документе сократилось на единицу.

fitToPages(): void;

Возвращаемое значение

void

followHyperlink(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Отображает кэшированный документ, если он уже был скачан. В противном случае этот метод разрешает гиперссылку, загружает целевой документ и отображает документ в соответствующем приложении.

followHyperlink(options?: Word.DocumentFollowHyperlinkOptions): void;

Параметры

options: Word.DocumentFollowHyperlinkOptions

Необязательный параметр. Параметры конфигурации для перехода по гиперссылке.

Возвращаемое значение

void

freezeLayout()

Исправление макета документа в веб-представлении.

freezeLayout(): void;

Возвращаемое значение

void

getAnnotationById(id)

Получает заметку по идентификатору. Выдает ошибку, ItemNotFound если заметки не найдены.

getAnnotationById(id: string): Word.Annotation;

Параметры

id: string

Идентификатор заметки, которую нужно получить.

Возвращаемое значение

Word.Annotation

getBookmarkRange(name)

Получает диапазон закладки. Выдает ошибку, ItemNotFound если закладки нет.

getBookmarkRange(name: string): Word.Range;

Параметры

name: string

Имя закладки без учета регистра.

Возвращаемое значение

Word.Range

getBookmarkRangeOrNullObject(name)

Получает диапазон закладки. Если закладки не существует, этот метод вернет объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getBookmarkRangeOrNullObject(name: string): Word.Range;

Параметры

name: string

Имя закладки без учета регистра.

Возвращаемое значение

Word.Range

getContentControls(options)

Получает поддерживаемые в настоящее время элементы управления содержимым в документе.

getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;

Параметры

options: Word.ContentControlOptions

Необязательный параметр. Параметры, определяющие, какие элементы управления содержимым возвращаются.

Возвращаемое значение

Word.ContentControlCollection

Важно: Если в параметре options указаны определенные типы, возвращаются только элементы управления содержимым поддерживаемых типов. Имейте в виду, что будет создано исключение при использовании методов общего Word. ContentControl, не относящиеся к определенному типу. Со временем могут поддерживаться дополнительные типы управления содержимым. Поэтому надстройка должна запрашивать и обрабатывать определенные типы элементов управления содержимым.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-checkbox-content-control.yaml

// Toggles the isChecked property on all checkbox content controls.
await Word.run(async (context) => {
  let contentControls = context.document.getContentControls({
    types: [Word.ContentControlType.checkBox]
  });
  contentControls.load("items");

  await context.sync();

  const length = contentControls.items.length;
  console.log(`Number of checkbox content controls: ${length}`);

  if (length <= 0) {
    return;
  }

  const checkboxContentControls = [];
  for (let i = 0; i < length; i++) {
    let contentControl = contentControls.items[i];
    contentControl.load("id,checkboxContentControl/isChecked");
    checkboxContentControls.push(contentControl);
  }

  await context.sync();

  console.log("isChecked state before:");
  const updatedCheckboxContentControls = [];
  for (let i = 0; i < checkboxContentControls.length; i++) {
    const currentCheckboxContentControl = checkboxContentControls[i];
    const isCheckedBefore = currentCheckboxContentControl.checkboxContentControl.isChecked;
    console.log(`id: ${currentCheckboxContentControl.id} ... isChecked: ${isCheckedBefore}`);

    currentCheckboxContentControl.checkboxContentControl.isChecked = !isCheckedBefore;
    currentCheckboxContentControl.load("id,checkboxContentControl/isChecked");
    updatedCheckboxContentControls.push(currentCheckboxContentControl);
  }

  await context.sync();

  console.log("isChecked state after:");
  for (let i = 0; i < updatedCheckboxContentControls.length; i++) {
    const currentCheckboxContentControl = updatedCheckboxContentControls[i];
    console.log(
      `id: ${currentCheckboxContentControl.id} ... isChecked: ${currentCheckboxContentControl.checkboxContentControl.isChecked}`
    );
  }
});

getCrossReferenceItems(referenceType)

Возвращает массив элементов, на которые можно ссылаться на основе указанного типа перекрестных ссылок.

getCrossReferenceItems(referenceType: Word.ReferenceType): OfficeExtension.ClientResult<string[]>;

Параметры

referenceType: Word.ReferenceType

Тип ссылки.

Возвращаемое значение

OfficeExtension.ClientResult<string[]>

getCrossReferenceItems(referenceType)

Возвращает массив элементов, на которые можно ссылаться на основе указанного типа перекрестных ссылок.

getCrossReferenceItems(referenceType: "NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"): OfficeExtension.ClientResult<string[]>;

Параметры

referenceType: "NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"

getParagraphByUniqueLocalId(id: string): Word.Paragraph;

Параметры

id: string

Уникальный локальный идентификатор в стандартном формате GUID 8-4-4-4-12 без фигурных скобок. Обратите внимание, что идентификатор отличается в зависимости от сеанса и соавтора.

Возвращаемое значение

Word.Paragraph

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onadded-event.yaml

await Word.run(async (context) => {
  const paragraphId = (document.getElementById("paragraph-id") as HTMLInputElement).value;
  const paragraph: Word.Paragraph = context.document.getParagraphByUniqueLocalId(paragraphId);
  paragraph.load();
  await paragraph.context.sync();

  console.log(paragraph);
});

getRange(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает объект, Range используя указанные начальную и конечную позиции знака.

getRange(options?: Word.DocumentRangeOptions): Word.Range;

Параметры

options: Word.DocumentRangeOptions

Необязательный параметр. Параметры конфигурации для указания параметров диапазона.

Возвращаемое значение

Word.Range

getSelection()

Возвращает текущий выбранный фрагмент документа. Выбор нескольких параметров не поддерживается.

getSelection(): Word.Range;

Возвращаемое значение

Word.Range

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    const textSample = 'This is an example of the insert text method. This is a method ' + 
        'which allows users to insert text into a selection. It can insert text into a ' +
        'relative location or it can overwrite the current selection. Since the ' +
        'getSelection method returns a range object, look up the range object documentation ' +
        'for everything you can do with a selection.';
    
    // Create a range proxy object for the current selection.
    const range = context.document.getSelection();
    
    // Queue a command to insert text at the end of the selection.
    range.insertText(textSample, Word.InsertLocation.end);
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Inserted the text at the end of the selection.');
});

getStyles()

Получает объект, StyleCollection представляющий весь набор стилей документа.

getStyles(): Word.StyleCollection;

Возвращаемое значение

Word.StyleCollection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/manage-styles.yaml

// Gets the number of available styles stored with the document.
await Word.run(async (context) => {
  const styles: Word.StyleCollection = context.document.getStyles();
  const count = styles.getCount();
  await context.sync();

  console.log(`Number of styles: ${count.value}`);
});

goTo(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает Range объект, представляющий начальную позицию указанного элемента, например страницу, закладку или поле.

goTo(options?: Word.GoToOptions): Word.Range;

Параметры

options: Word.GoToOptions

Необязательный параметр. Параметры конфигурации для указания goTo параметров.

Возвращаемое значение

Word.Range

importStylesFromJson(stylesJson, importedStylesConflictBehavior)

Импортируйте стили из строки в формате JSON.

importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;

Параметры

stylesJson: string

Строка в формате JSON, представляющая стили.

importedStylesConflictBehavior: Word.ImportedStylesConflictBehavior

Необязательный параметр. Указывает, как обрабатывать импортируемые стили с тем же именем, что и существующие стили в текущем документе. Значение по умолчанию: ignore.

Возвращаемое значение

OfficeExtension.ClientResult<string[]>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-custom-style.yaml

// Imports styles from JSON.
await Word.run(async (context) => {
  const str =
    '{"styles":[{"baseStyle":"Default Paragraph Font","builtIn":false,"inUse":true,"linked":false,"nameLocal":"NewCharStyle","priority":2,"quickStyle":true,"type":"Character","unhideWhenUsed":false,"visibility":false,"paragraphFormat":null,"font":{"name":"DengXian Light","size":16.0,"bold":true,"italic":false,"color":"#F1A983","underline":"None","subscript":false,"superscript":true,"strikeThrough":true,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#FF0000"}},{"baseStyle":"Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewParaStyle","nameLocal":"NewParaStyle","priority":1,"quickStyle":true,"type":"Paragraph","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Centered","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":72.0,"lineSpacing":18.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":72.0,"spaceAfter":30.0,"spaceBefore":30.0,"widowControl":true},"font":{"name":"DengXian","size":14.0,"bold":true,"italic":true,"color":"#8DD873","underline":"Single","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":true,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#00FF00"}},{"baseStyle":"Table Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewTableStyle","nameLocal":"NewTableStyle","priority":100,"type":"Table","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Left","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":0.0,"lineSpacing":12.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":0.0,"spaceAfter":0.0,"spaceBefore":0.0,"widowControl":true},"font":{"name":"DengXian","size":20.0,"bold":false,"italic":true,"color":"#D86DCB","underline":"None","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"tableStyle":{"allowBreakAcrossPage":true,"alignment":"Left","bottomCellMargin":0.0,"leftCellMargin":0.08,"rightCellMargin":0.08,"topCellMargin":0.0,"cellSpacing":0.0},"shading":{"backgroundPatternColor":"#60CAF3"}}]}';
  const styles = context.document.importStylesFromJson(str);

  // If you'd like to set how conflicting styles are handled, use the importedStylesConflictBehavior parameter that was introduced in the Desktop 1.1 requirement set. "Ignore" is the default.
  ////const styles = context.document.importStylesFromJson(str, Word.ImportedStylesConflictBehavior.Ignore);

  await context.sync();
  console.log("Styles imported from JSON:", styles);
});

importStylesFromJson(stylesJson, importedStylesConflictBehavior)

Импортируйте стили из строки в формате JSON.

importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult<string[]>;

Параметры

stylesJson: string

Строка в формате JSON, представляющая стили.

importedStylesConflictBehavior: "Ignore" | "Overwrite" | "CreateNew"

Необязательный параметр. Указывает, как обрабатывать импортируемые стили с тем же именем, что и существующие стили в текущем документе. Значение по умолчанию: ignore.

Возвращаемое значение

OfficeExtension.ClientResult<string[]>

insertFileFromBase64(base64File, insertLocation, insertFileOptions)

Вставляет документ в целевой документ в определенном месте с дополнительными свойствами. Верхние, нижние колонтитулы, подложки и другие свойства разделов копируются по умолчанию.

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection;

Параметры

base64File: string

Содержимое файла .docx в кодировке Base64.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Значение должно быть : replace, startили end.

insertFileOptions: Word.InsertFileOptions

Необязательный параметр. Дополнительные свойства, которые следует импортировать в целевой документ.

Возвращаемое значение

Word.SectionCollection

Вставка не поддерживается, если вставляемый документ содержит элемент ActiveX (скорее всего, в поле формы). Рассмотрите возможность замены такого поля формы элементом управления содержимым или другим подходящим для вашего сценария параметром.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/insert-external-document.yaml

// Inserts content (applying selected settings) from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
  // Use the Base64-encoded string representation of the selected .docx file.
  context.document.insertFileFromBase64(externalDocument, "Replace", {
    importTheme: true,
    importStyles: true,
    importParagraphSpacing: true,
    importPageColor: true,
    importChangeTrackingMode: true,
    importCustomProperties: true,
    importCustomXmlParts: true,
    importDifferentOddEvenPages: true
  });
  await context.sync();
});

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document;

Параметры

options: Word.Interfaces.DocumentLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

Word.Document

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the document.
    const thisDocument = context.document;
    
    // Queue a command to load content control properties.
    thisDocument.load('contentControls/id, contentControls/text, contentControls/tag');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (thisDocument.contentControls.items.length !== 0) {
        for (let i = 0; i < thisDocument.contentControls.items.length; i++) {
            console.log(thisDocument.contentControls.items[i].id);
            console.log(thisDocument.contentControls.items[i].text);
            console.log(thisDocument.contentControls.items[i].tag);
        }
    } else {
        console.log('No content controls in this document.');
    }
});

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Word.Document;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

Возвращаемое значение

Word.Document

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Document;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Объединяет изменения, помеченные метками редакций, из одного документа в другой.

merge(fileName: string, options?: Word.DocumentMergeOptions): void;

Параметры

fileName: string

Имя объединяемого файла.

options: Word.DocumentMergeOptions

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Печатает весь документ или его часть.

printOut(options?: Word.DocumentPrintOutOptions): void;

Параметры

options: Word.DocumentPrintOutOptions

Необязательный параметр. Параметры конфигурации операции печати.

Возвращаемое значение

void

printPreview()

Переключение представления в режим предварительного просмотра.

printPreview(): void;

Возвращаемое значение

void

protect(type, options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Защищает документ от несанкционированных изменений.

protect(type: Word.ProtectionType, options?: Word.DocumentProtectOptions): void;

Параметры

type: Word.ProtectionType

Тип защиты.

options: Word.DocumentProtectOptions

Необязательный параметр. Параметры конфигурации для защиты документов.

Возвращаемое значение

void

protect(type, options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Защищает документ от несанкционированных изменений.

protect(type: "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading", options?: Word.DocumentProtectOptions): void;

Параметры

type: "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"

Тип защиты.

options: Word.DocumentProtectOptions

Необязательный параметр. Параметры конфигурации для защиты документов.

Возвращаемое значение

void

redo(times)

Возвращает последнее отмененное действие (меняет метод на противоположное undo ).

redo(times?: number): OfficeExtension.ClientResult<boolean>;

Параметры

times: number

Необязательный параметр. Количество повторяемых действий.

Возвращаемое значение

OfficeExtension.ClientResult<boolean>

true если действия были успешно повторены; в противном случае, false.

rejectAllRevisions()

Отклоняет все исправления в документе.

rejectAllRevisions(): void;

Возвращаемое значение

void

rejectAllRevisionsShown()

Отклоняет все исправления в документе, отображаемые на экране.

rejectAllRevisionsShown(): void;

Возвращаемое значение

void

reload()

Перезагружает кэшированный документ, разрешая гиперссылку на документ и загружая его.

reload(): void;

Возвращаемое значение

void

reloadAs(encoding)

Перезагружает документ на основе HTML-документа, используя кодировку документа.

reloadAs(encoding: Word.DocumentEncoding): void;

Параметры

encoding: Word.DocumentEncoding

Используемая кодировка.

Возвращаемое значение

void

reloadAs(encoding)

Перезагружает документ на основе HTML-документа, используя кодировку документа.

reloadAs(encoding: "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"): void;

Параметры

encoding: "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"

Используемая кодировка.

Возвращаемое значение

void

removeDocumentInformation(removeDocInfoType)

Удаляет из документа конфиденциальные сведения, свойства, комментарии и другие метаданные.

removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType): void;

Параметры

removeDocInfoType: Word.RemoveDocInfoType

Тип сведений о документе, которые нужно удалить.

Возвращаемое значение

void

removeDocumentInformation(removeDocInfoType)

Удаляет из документа конфиденциальные сведения, свойства, комментарии и другие метаданные.

removeDocumentInformation(removeDocInfoType: "Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" | "SendForReview" | "DocumentProperties" | "Template" | "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | "CommentReactions" | "All"): void;

Параметры

removeDocInfoType: "Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" | "SendForReview" | "DocumentProperties" | "Template" | "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | "CommentReactions" | "All"

Тип сведений о документе, которые нужно удалить.

Возвращаемое значение

void

removeLockedStyles()

Очищает документ от заблокированных стилей, если к документу были применены ограничения форматирования.

removeLockedStyles(): void;

Возвращаемое значение

void

removeNumbers(numberType)

Удаляет из документа номера или маркеры.

removeNumbers(numberType?: Word.NumberType): void;

Параметры

numberType: Word.NumberType

Необязательный параметр. Тип нумерации, которую нужно удалить.

Возвращаемое значение

void

removeNumbers(numberType)

Удаляет из документа номера или маркеры.

removeNumbers(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void;

Параметры

numberType: "Paragraph" | "ListNum" | "AllNumbers"

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Отправляет сообщение электронной почты автору документа, отправленного на проверку, уведомляя его о том, что рецензент завершил проверку документа.

replyWithChanges(options?: Word.DocumentReplyWithChangesOptions): void;

Параметры

options: Word.DocumentReplyWithChangesOptions

runAutoMacro(autoMacro: Word.AutoMacro): void;

Параметры

autoMacro: Word.AutoMacro

Автоматический макрос для запуска.

Возвращаемое значение

void

runAutoMacro(autoMacro)

Запускает автоматический макрос, сохраненный в документе. Если указанного автомакроса не существует, ничего не происходит.

runAutoMacro(autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"): void;

Параметры

autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"

Автоматический макрос для запуска.

Возвращаемое значение

void

save(saveBehavior, fileName)

Сохраняет документ.

save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;

Параметры

saveBehavior: Word.SaveBehavior

Необязательный параметр. Поведение сохранения должно быть или saveprompt. Значение по умолчанию: save.

fileName: string

Необязательный параметр. Имя файла (исключить расширение файла). Вступает в силу только для нового документа.

Возвращаемое значение

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml

// Saves the document with default behavior
// for current state of the document.
await Word.run(async (context) => {
  context.document.save();
  await context.sync();
});

save(saveBehavior, fileName)

Сохраняет документ.

save(saveBehavior?: "Save" | "Prompt", fileName?: string): void;

Параметры

saveBehavior: "Save" | "Prompt"

Необязательный параметр. Поведение сохранения должно быть или saveprompt. Значение по умолчанию: save.

fileName: string

Необязательный параметр. Имя файла (исключить расширение файла). Вступает в силу только для нового документа.

Возвращаемое значение

void

saveAsQuickStyleSet(fileName)

Сохраняет группу экспресс-стилей, используемых в данный момент.

saveAsQuickStyleSet(fileName: string): void;

Параметры

fileName: string

Имя сохраняемого файла.

Возвращаемое значение

void

search(searchText, searchOptions)

Выполняет поиск с указанными параметрами поиска в областях всего документа. Результаты поиска представляют собой набор Range объектов.

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

Параметры

searchText: string

Текст для поиска.

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

Необязательный параметр. Параметры, определяющие порядок поиска.

Возвращаемое значение

Word.RangeCollection

select()

Выделение содержимого документа.

select(): void;

Возвращаемое значение

void

selectContentControlsByTag(tag)

Возвращает все элементы управления содержимым с указанным тегом.

selectContentControlsByTag(tag: string): Word.ContentControlCollection;

Параметры

tag: string

Значение тега для фильтрации элементов управления содержимым.

Возвращаемое значение

Word.ContentControlCollection

selectContentControlsByTitle(title)

Возвращает ContentControlCollection объект, представляющий все элементы управления содержимым в документе с указанным названием.

selectContentControlsByTitle(title: string): Word.ContentControlCollection;

Параметры

title: string

Название элементов управления содержимым.

Возвращаемое значение

Word.ContentControlCollection

selectLinkedControls(node)

Возвращает объект, ContentControlCollection представляющий все элементы управления содержимым в документе, связанные с определенным настраиваемым узлом XML.

selectLinkedControls(node: Word.CustomXmlNode): Word.ContentControlCollection;

Параметры

node: Word.CustomXmlNode

Пользовательский узел XML.

Возвращаемое значение

Word.ContentControlCollection

selectNodes(xPath, options)

Возвращает объект, XmlNodeCollection представляющий все узлы, соответствующие параметру XPath, в порядке их появления в документе.

selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection;

Параметры

xPath: string

Выражение XPath.

options: Word.SelectNodesOptions

Необязательный параметр. Параметры конфигурации для выбора узлов.

Возвращаемое значение

Word.XmlNodeCollection

selectSingleNode(xPath, options)

Возвращает объект, XmlNode представляющий первый узел, соответствующий параметру XPath в документе.

selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode;

Параметры

xPath: string

Выражение XPath.

options: Word.SelectSingleNodeOptions

Необязательный параметр. Параметры конфигурации для выбора узла.

Возвращаемое значение

Word.XmlNode

selectUnlinkedControls(stream)

Возвращает объект, ContentControlCollection представляющий все элементы управления содержимым в документе, не связанные с узлом XML.

selectUnlinkedControls(stream?: Word.CustomXmlPart): Word.ContentControlCollection;

Параметры

stream: Word.CustomXmlPart

Необязательный параметр. Пользовательская часть XML.

Возвращаемое значение

Word.ContentControlCollection

sendFax(address, subject)

Отправляет документ по факсу без вмешательства пользователя.

sendFax(address: string, subject?: string): void;

Параметры

address: string

Адрес факса.

subject: string

Необязательный параметр. Тема факса.

Возвращаемое значение

void

sendFaxOverInternet(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Отправляет документ поставщику услуг факсимильной связи, который отправляет его по факсу одному или нескольким указанным получателям.

sendFaxOverInternet(options?: Word.DocumentSendFaxOverInternetOptions): void;

Параметры

options: Word.DocumentSendFaxOverInternetOptions

Необязательный параметр. Параметры конфигурации для отправки факса через Интернет.

Возвращаемое значение

void

sendForReview(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Отправляет документ в сообщении электронной почты на проверку указанными получателями.

sendForReview(options?: Word.DocumentSendForReviewOptions): void;

Параметры

options: Word.DocumentSendForReviewOptions

Необязательный параметр. Параметры конфигурации для отправки документа на рассмотрение.

Возвращаемое значение

void

sendMail()

Открывает окно сообщения для отправки документа через Microsoft Exchange.

sendMail(): void;

Возвращаемое значение

void

set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.

set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Word.Interfaces.DocumentUpdateData

Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.

Возвращаемое значение

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Word.Document): void;

Параметры

properties: Word.Document

Возвращаемое значение

void

setDefaultTableStyle(style, setInTemplate)

Стиль таблицы, используемый для создаваемых таблиц в документе.

setDefaultTableStyle(style: string, setInTemplate: boolean): void;

Параметры

style: string

Стиль, который нужно применить.

setInTemplate: boolean

Следует ли задавать стиль в шаблоне.

Возвращаемое значение

void

setPasswordEncryptionOptions(passwordEncryptionProvider, passwordEncryptionAlgorithm, passwordEncryptionKeyLength, passwordEncryptFileProperties)

Задание параметров, используемых Microsoft Word для шифрования документов с помощью паролей.

setPasswordEncryptionOptions(passwordEncryptionProvider: string, passwordEncryptionAlgorithm: string, passwordEncryptionKeyLength: number, passwordEncryptFileProperties?: boolean): void;

Параметры

passwordEncryptionProvider: string

Поставщик шифрования.

passwordEncryptionAlgorithm: string

Алгоритм шифрования.

passwordEncryptionKeyLength: number

Длина ключа.

passwordEncryptFileProperties: boolean

transformDocument(path: string, dataOnly?: boolean): void;

Параметры

path: string

Путь к файлу XSLT.

dataOnly: boolean

Необязательный параметр. Следует ли использовать только данные.

Возвращаемое значение

void

undo(times)

Отмена последнего действия или последовательности действий, отображаемых в списке отмены.

undo(times?: number): OfficeExtension.ClientResult<boolean>;

Параметры

times: number

Необязательный параметр. Количество действий для отмены.

Возвращаемое значение

OfficeExtension.ClientResult<boolean>

true если действия были успешно отменены; в противном случае, false.

undoClear()

Очищает список действий, которые можно отменить в документе.

undoClear(): void;

Возвращаемое значение

void

unprotect(password)

Снимает защиту с документа.

unprotect(password?: string): void;

Параметры

password: string

readonly onAnnotationClicked: OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onClickedHandler(args: Word.AnnotationClickedEventArgs) {
  await Word.run(async (context) => {
    const annotation: Word.Annotation = context.document.getAnnotationById(args.id);
    annotation.load("critiqueAnnotation");

    await context.sync();

    console.log(`AnnotationClicked: ID ${args.id}:`, annotation.critiqueAnnotation.critique);
  });
}

onAnnotationHovered

Возникают, когда пользователь наводит курсор на примечание.

readonly onAnnotationHovered: OfficeExtension.EventHandlers<Word.AnnotationHoveredEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.AnnotationHoveredEventArgs>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onHoveredHandler(args: Word.AnnotationHoveredEventArgs) {
  await Word.run(async (context) => {
    const annotation: Word.Annotation = context.document.getAnnotationById(args.id);
    annotation.load("critiqueAnnotation");

    await context.sync();

    console.log(`AnnotationHovered: ID ${args.id}:`, annotation.critiqueAnnotation.critique);
  });
}

onAnnotationInserted

Возникают, когда пользователь добавляет одну или несколько заметок.

readonly onAnnotationInserted: OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onInsertedHandler(args: Word.AnnotationInsertedEventArgs) {
  await Word.run(async (context) => {
    const annotations = [];
    for (let i = 0; i < args.ids.length; i++) {
      let annotation: Word.Annotation = context.document.getAnnotationById(args.ids[i]);
      annotation.load("id,critiqueAnnotation");

      annotations.push(annotation);
    }

    await context.sync();

    for (let annotation of annotations) {
      console.log(`AnnotationInserted: ID ${annotation.id}:`, annotation.critiqueAnnotation.critique);
    }
  });
}

onAnnotationPopupAction

Возникают, когда пользователь выполняет действие во всплывающем меню заметки.

readonly onAnnotationPopupAction: OfficeExtension.EventHandlers<Word.AnnotationPopupActionEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.AnnotationPopupActionEventArgs>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onPopupActionHandler(args: Word.AnnotationPopupActionEventArgs) {
  await Word.run(async (context) => {
    let message = `AnnotationPopupAction: ID ${args.id} = `;
    if (args.action === "Accept") {
      message += `Accepted: ${args.critiqueSuggestion}`;
    } else {
      message += "Rejected";
    }

    console.log(message);
  });
}

onAnnotationRemoved

Возникают, когда пользователь удаляет одну или несколько заметок.

readonly onAnnotationRemoved: OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onRemovedHandler(args: Word.AnnotationRemovedEventArgs) {
  await Word.run(async (context) => {
    for (let id of args.ids) {
      console.log(`AnnotationRemoved: ID ${id}`);
    }
  });
}

onContentControlAdded

Возникает при добавлении элемента управления содержимым. Выполните context.sync() в обработчике, чтобы получить свойства нового элемента управления содержимым.

readonly onContentControlAdded: OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/content-control-onadded-event.yaml

// Registers the onAdded event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onContentControlAdded.add(contentControlAdded);
  await context.sync();

  console.log("Added event handler for when content controls are added.");
});

...

async function contentControlAdded(event: Word.ContentControlAddedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. IDs of content controls that were added:`, event.ids);
  });
}

onParagraphAdded

Возникает, когда пользователь добавляет новые абзацы.

readonly onParagraphAdded: OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onadded-event.yaml

// Registers the onParagraphAdded event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphAdded.add(paragraphAdded);
  await context.sync();

  console.log("Added event handler for when paragraphs are added.");
});

...

async function paragraphAdded(event: Word.ParagraphAddedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs that were added:`, event.uniqueLocalIds);
  });
}

onParagraphChanged

Возникает, когда пользователь изменяет абзацы.

readonly onParagraphChanged: OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onchanged-event.yaml

// Registers the onParagraphChanged event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphChanged.add(paragraphChanged);
  await context.sync();

  console.log("Added event handler for when content is changed in paragraphs.");
});

...

async function paragraphChanged(event: Word.ParagraphChangedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs where content was changed:`, event.uniqueLocalIds);
  });
}

onParagraphDeleted

Возникают, когда пользователь удаляет абзацы.

readonly onParagraphDeleted: OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/ondeleted-event.yaml

// Registers the onParagraphDeleted event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphDeleted.add(paragraphDeleted);
  await context.sync();

  console.log("Added event handlers for when paragraphs are deleted.");
});

...

async function paragraphDeleted(event: Word.ParagraphDeletedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs that were deleted:`, event.uniqueLocalIds);
  });
}

Комментарии

Используется

Примеры

Свойства

Методы

События

Сведения о свойстве

activeTheme

Значение свойства

Комментарии

activeThemeDisplayName

Значение свойства

Комментарии

activeWindow

Значение свойства

Комментарии

Примеры

areFilePropertiesPasswordEncrypted

Значение свойства

Комментарии

areGrammaticalErrorsShown

Значение свойства

Комментарии

areMathDefaultsUsed

Значение свойства

Комментарии

areNewerFeaturesDisabled

Значение свойства

Комментарии

areSpellingErrorsShown

Значение свойства

Комментарии

areStylesUpdatedOnOpen

Значение свойства

Комментарии

areTrueTypeFontsEmbedded

Значение свойства

Комментарии

attachedTemplate

Значение свойства

Комментарии

autoHyphenation

Значение свойства

Комментарии

autoSaveOn

Значение свойства

Комментарии

background

Значение свойства

Комментарии

bibliography

Значение свойства

Комментарии

body

Значение свойства

Комментарии

Примеры

bookmarks

Значение свойства

Комментарии

builtInDocumentProperties

Значение свойства

Комментарии

changeTrackingMode

Значение свойства

Комментарии

Примеры

characters

Значение свойства

Комментарии

coauthoring

Значение свойства

Комментарии

Примеры

codeName

Значение свойства

Комментарии

comments

Значение свойства