Word.Document class

Пакет:: word

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

Extends: OfficeExtension.ClientObject

// 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	Указывает имя поставщика шифрования алгоритмов, который корпорация Майкрософт 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 ли 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	Указывает тип формата, используемый корпорацией Майкрософт Word при автоматическом форматировании документа.
languageDetected	Указывает, обнаружила ли microsoft Word язык текста документа.
listParagraphs	`ParagraphCollection` Возвращает объект , представляющий все нумерованные абзацы в документе.
lists	`ListCollection` Возвращает объект , содержащий все отформатированные списки в документе.
listTemplates	`ListTemplateCollection` Возвращает объект , представляющий все шаблоны списков в документе.
noLineBreakAfter	Указывает символы kinsoku, после которых Word не будет разрывать строку.
noLineBreakBefore	Указывает символы kinsoku, перед которыми 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	Указывает, сохранены ли изменения, внесенные в документ. Значение `true` указывает, что документ не изменился с момента сохранения.
saveEncoding	Указывает кодировку, используемую при сохранении документа.
saveFormat	Возвращает формат файла документа.
sections	Возвращает коллекцию `Section` объектов в документе.
selection	`Selection` Возвращает объект , представляющий текущий выделенный фрагмент в документе.
sentences	`RangeScopedCollection` Возвращает объект , представляющий все предложения в документе.
settings	Возвращает параметры надстройки в документе.
spellingErrors	`RangeCollection` Возвращает объект , представляющий слова, определенные как орфографические ошибки в документе.
storyRanges	`RangeCollection` Возвращает объект , представляющий все истории в документе.
styles	`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

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

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

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

defaultTabStop

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

defaultTabStop: number;

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

number

defaultTargetFrame

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

defaultTargetFrame: string;

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

string

documentLibraryVersions

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

readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection;

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

Word.DocumentLibraryVersionCollection

doNotEmbedSystemFonts

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

doNotEmbedSystemFonts: boolean;

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

boolean

encryptionProvider

Указывает имя поставщика шифрования алгоритмов, который корпорация Майкрософт 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 ли 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

Указывает тип формата, используемый корпорацией Майкрософт 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

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

noLineBreakAfter: string;

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

string

noLineBreakBefore

Указывает символы kinsoku, перед которыми 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

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

Указывает, сохранены ли изменения, внесенные в документ. Значение 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

selection

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

readonly selection: Word.Selection;

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

Word.Selection

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

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/50-document/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)

Примечание

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

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

Параметры

options: Word.DocumentCheckInWithVersionOptions

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

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

void

checkSpelling(options)

Примечание

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

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"

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

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)

Примечание

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

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

Параметры

statistic: Word.StatisticType

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

includeFootnotesAndEndnotes: boolean

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

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

OfficeExtension.ClientResult<number>

computeStatistics(statistic, includeFootnotesAndEndnotes)

Примечание

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

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)

Примечание

Возвращает количество маркированных или нумерованных элементов и полей 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)

Примечание

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

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

Параметры

options: Word.DocumentEndReviewOptions

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

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

void

exportAsFixedFormat(outputFileName, exportFormat, options)

Примечание

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

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

Параметры

outputFileName: string

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

exportFormat: Word.ExportFormat

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

options: Word.DocumentExportAsFixedFormatOptions

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

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

void

exportAsFixedFormat(outputFileName, exportFormat, options)

Примечание

Сохраняет документ в формате 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)

Примечание

Сохраняет документ в формате 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)

Примечание

Сохраняет документ в формате 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)

Примечание

Сохраняет документ в формате 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)

Примечание

Сохраняет документ в формате 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)

Примечание

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

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-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)

Примечание

Возвращает объект с 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/50-document/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)

Примечание

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"

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

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)

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

Параметры

propertyNames: string | string[]

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

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

Word.Document

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Параметры

fileName: string

Имя файла для слияния.

options: Word.DocumentMergeOptions

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

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

Параметры

options: Word.DocumentPrintOutOptions

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

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

void

printPreview()

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

printPreview(): void;

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

void

protect(type, options)

Примечание

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

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

Параметры

type: Word.ProtectionType

Тип защиты.

options: Word.DocumentProtectOptions

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

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

void

protect(type, options)

Примечание

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

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"

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

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

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

fileName: string

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

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

void

Примеры

// 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 the document save state (on the saved property).
    thisDocument.load('saved');    
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
        
    if (thisDocument.saved === false) {
        // Queue a command to save this document.
        thisDocument.save();
        
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Saved the document');
    } else {
        console.log('The document has not changed since the last save.');
    }
});

// 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"

fileName: string

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

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

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)

Примечание

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

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

Параметры

options: Word.DocumentSendFaxOverInternetOptions

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

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

void

sendForReview(options)

Примечание

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

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

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

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

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

webPagePreview(): void;

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

void

Сведения о событии

onAnnotationClicked

Происходит, когда пользователь щелкает заметку (или выбирает ее с помощью клавиш ALT+ВНИЗ).

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);
  });
}

Обратная связь

Были ли сведения на этой странице полезными?

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

Word.Document class

Комментарии

Примеры

Свойства

Методы

События

Сведения о свойстве

activeTheme

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

Комментарии

activeThemeDisplayName

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

Комментарии

activeWindow

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

Комментарии

Примеры

areFilePropertiesPasswordEncrypted

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

Комментарии

areGrammaticalErrorsShown

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

Комментарии

areMathDefaultsUsed

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

Комментарии

areNewerFeaturesDisabled

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

Комментарии

areSpellingErrorsShown

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

Комментарии

areStylesUpdatedOnOpen

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

Комментарии

areTrueTypeFontsEmbedded

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

Комментарии

attachedTemplate

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

Комментарии

autoHyphenation

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

Комментарии

autoSaveOn

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

Комментарии

background

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

Комментарии

bibliography

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

Комментарии

body

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

Комментарии

bookmarks

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

Комментарии

builtInDocumentProperties

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

Комментарии

changeTrackingMode

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

Комментарии

Примеры

characters

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

Комментарии

coauthoring

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

Комментарии

codeName

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

Комментарии

comments

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

Комментарии

compatibilityMode