Word.ContentControl class

Представляет элемент управления содержимым. Элементы управления содержимым — это связанные и, возможно, помеченные фрагменты документа, выполняющие роль контейнеров для определенных типов содержимого. Отдельные элементы управления контентом могут содержать изображения, таблицы или абзацы форматированного текста. В настоящее время поддерживаются только элементы управления форматированным текстом, обычным текстом, флажками, раскрывающимися списками и полями со списком.

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;

    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to load the properties on the first content control.
        contentControls.items[0].load(  'appearance,' +
                                        'cannotDelete,' +
                                        'cannotEdit,' +
                                        'color,' +
                                        'id,' +
                                        'placeHolderText,' +
                                        'removeWhenEdited,' +
                                        'title,' +
                                        'text,' +
                                        'type,' +
                                        'style,' +
                                        'tag,' +
                                        'font/size,' +
                                        'font/name,' +
                                        'font/color');

        // Synchronize the document state by executing the queued commands,
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Property values of the first content control:' +
            '   ----- appearance: ' + contentControls.items[0].appearance +
            '   ----- cannotDelete: ' + contentControls.items[0].cannotDelete +
            '   ----- cannotEdit: ' + contentControls.items[0].cannotEdit +
            '   ----- color: ' + contentControls.items[0].color +
            '   ----- id: ' + contentControls.items[0].id +
            '   ----- placeHolderText: ' + contentControls.items[0].placeholderText +
            '   ----- removeWhenEdited: ' + contentControls.items[0].removeWhenEdited +
            '   ----- title: ' + contentControls.items[0].title +
            '   ----- text: ' + contentControls.items[0].text +
            '   ----- type: ' + contentControls.items[0].type +
            '   ----- style: ' + contentControls.items[0].style +
            '   ----- tag: ' + contentControls.items[0].tag +
            '   ----- font size: ' + contentControls.items[0].font.size +
            '   ----- font name: ' + contentControls.items[0].font.name +
            '   ----- font color: ' + contentControls.items[0].font.color);
    }
});

Свойства

appearance	Определяет внешний вид элемента управления содержимым. Это значение может быть следующим — `boundingBox`, `tags`или `hidden`.
buildingBlockGalleryContentControl	Получает данные, связанные с коллекцией стандартных блоков, если элемент управления содержимым использует Word. ContentControlType — `buildingBlockGallery`. Это `null` не так.
cannotDelete	Определяет, может ли пользователь удалить элемент управления содержимым. Взаимоисключающие с `removeWhenEdited`.
cannotEdit	Определяет, может ли пользователь изменять содержимое элемента управления содержимым.
checkboxContentControl	Получает данные элемента управления содержимым, если его типом является `checkBox`. Это `null` не так.
color	Цвет элемента управления содержимым. Цвет указывается в формате "#RRGGBB" или с помощью имени цвета.
comboBoxContentControl	Получает данные элемента управления содержимым, если его типом является `comboBox`. Это `null` не так.
contentControls	Получает коллекцию `ContentControl` объектов в элементе управления содержимым.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
datePickerContentControl	Получает данные, связанные с выбором даты, если Word элемента управления содержимым. ContentControlType — `datePicker`. Это `null` не так.
dropDownListContentControl	Получает данные элемента управления содержимым, если его типом является `dropDownList`. Это `null` не так.
endnotes	Получает коллекцию концевых сносок в элементе управления содержимым.
fields	Получает коллекцию `Field` объектов в элементе управления содержимым.
font	Получает текстовый формат элемента управления содержимым. Используйте это свойство для получения и установки имени, размера, цвета и других свойств шрифта.
footnotes	Получает коллекцию сносок в элементе управления содержимым.
groupContentControl	Получает данные, связанные с группой, если элемент управления содержимым использует Word. ContentControlType — `group`. Это `null` не так.
id	Возвращает целое число, представляющее собой идентификатор элемента управления контентом.
inlinePictures	Получает коллекцию `InlinePicture` объектов в элементе управления содержимым. Коллекция не включает плавающие изображения.
lists	Получает коллекцию `List` объектов в элементе управления содержимым.
paragraphs	Получает коллекцию `Paragraph` объектов в элементе управления содержимым.
parentBody	Возвращает родительский текст элемента управления содержимым.
parentContentControl	Получает элемент управления содержимым, содержащий элемент управления содержимым. Выдает ошибку, `ItemNotFound` если родительский элемент управления содержимым отсутствует.
parentContentControlOrNullObject	Получает элемент управления содержимым, содержащий элемент управления содержимым. Если родительский элемент управления содержимым отсутствует, этот метод возвращает объект со `isNullObject` свойством `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
parentTable	Возвращает таблицу, содержащую элемент управления содержимым. Выдает `ItemNotFound` ошибку, если она не содержится в таблице.
parentTableCell	Возвращает ячейку таблицы, содержащую элемент управления содержимым. Выдает ошибку, `ItemNotFound` если она не содержится в ячейке таблицы.
parentTableCellOrNullObject	Возвращает ячейку таблицы, содержащую элемент управления содержимым. Если он не содержится в ячейке таблицы, этот метод вернет объект со свойством `isNullObject` , установленным в `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
parentTableOrNullObject	Возвращает таблицу, содержащую элемент управления содержимым. Если его нет в таблице, этот метод вернет объект со свойством `isNullObject` , установленным в `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
pictureContentControl	Получает данные, связанные с изображением, если Word элемента управления содержимым. ContentControlType — `picture`. Это `null` не так.
placeholderText	Задает замещающий текст элемента управления содержимым. Если элемент управления содержимым пуст, отображается затемненный текст.
removeWhenEdited	Указывает, удаляется ли элемент управления содержимым после редактирования. Взаимоисключающие с `cannotDelete`.
repeatingSectionContentControl	Получает повторяющиеся данные, связанные с разделом, если Word элемента управления содержимым. ContentControlType — `repeatingSection`. Это `null` не так.
style	Указывает имя стиля для элемента управления содержимым. Используйте это свойство для пользовательских стилей и локализованных имен стилей. Сведения об использовании встроенных стилей, переносимых между языковыми стандартами, см. в свойстве `styleBuiltIn` .
styleBuiltIn	Указывает встроенное имя стиля для элемента управления содержимым. Используйте это свойство для встроенных стилей, поддерживающих несколько языковых стандартов. Чтобы использовать пользовательские стили или локализованные имена стилей, см. свойство `style` .
subtype	Возвращает подтип элемента управления содержимым. Подтип может быть следующим — `richTextInline`, `richTextParagraphs`,`richTextTableCell` и `richTextTablerichTextTableRow` для элементов управления содержимым в форматированном тексте, `plainTextInline` для `plainTextParagraph` элементов управления содержимым в формате обычного текста, `checkBox` для элементов управления содержимым флажков, для элементов управления содержимым раскрывающихся списков, `dropDownListcomboBox` для элементов управления содержимым поля со списком, `buildingBlockGallery` для элементов управления содержимым галереи стандартных блоков, `datePicker` для элементов управления средствами выбора даты, `repeatingSection` для элементов управления содержимым повторяющихся разделов, `picture` для элементов управления содержимым изображений и `group` для элементов управления содержимым групп.
tables	Получает коллекцию `Table` объектов в элементе управления содержимым.
tag	Указывает тег для идентификации элемента управления содержимым.
text	Возвращает текст элемента управления содержимым.
title	Указывает название элемента управления содержимым.
type	Получает тип элемента управления содержимым. В настоящее время поддерживаются только форматированный текст, обычный текст, поле проверки, раскрывающийся список, поле со списком, коллекция стандартных блоков, элемент выбора даты, повторяющийся раздел, изображение и элементы управления содержимым группы.
xmlMapping	Возвращает `XmlMapping` объект, представляющий сопоставление элемента управления содержимым с данными XML в хранилище данных документа.

Методы

clear()	Очищает содержимое элемента управления содержимым. Пользователь может отменить операцию для очищенного содержимого.
delete(keepContent)	Удаляет элемент управления содержимым и его содержимое. Если `keepContent` установлено значение `true`, содержимое не удаляется.
getComments()	Получает комментарии, связанные с элементом управления содержимым.
getContentControls(options)	Получает поддерживаемые в настоящее время элементы управления содержимым для детей в этом элементе управления содержимым.
getHtml()	Получает HTML-представление `ContentControl` объекта. При визуализации на веб-странице или в средстве просмотра HTML форматирование будет близко, но не точно соответствовать форматированию документа. Этот метод не возвращает один и тот же HTML-код для одного и того же документа на разных платформах (Windows, Mac, Word в Интернете и т. д.). Если вам требуется точная точность или согласованность платформ, используйте `ContentControl.getOoxml()` и преобразуйте возвращенный XML-файл в HTML.
getOoxml()	Получает представление `ContentControl` объекта Office Open XML (OOXML).
getRange(rangeLocation)	Возвращает весь элемент управления содержимым (либо его начальную или конечную точку) в виде диапазона.
getReviewedText(changeTrackingVersion)	Получает проверенный текст на основе выбора ChangeTrackingVersion.
getReviewedText(changeTrackingVersion)	Получает проверенный текст на основе выбора ChangeTrackingVersion.
getTextRanges(endingMarks, trimSpacing)	Получает текстовые диапазоны в элементе управления содержимым с помощью знаков препинания и других конечных знаков.
getTrackedChanges()	Получает коллекцию `TrackedChange` объектов в элементе управления содержимым.
insertBreak(breakType, insertLocation)	Вставляет разрыв в указанном расположении в основном документе. Этот метод нельзя использовать с `richTextTable`, `richTextTableRow`, и `richTextTableCell` элементами управления содержимым.
insertFileFromBase64(base64File, insertLocation)	Вставляет документ в элемент управления содержимым в указанном расположении.
insertHtml(html, insertLocation)	Вставляет HTML-код в элемент управления содержимым в указанном расположении.
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)	Вставляет встроенный рисунок в элемент управления содержимым в указанном расположении.
insertOoxml(ooxml, insertLocation)	Вставляет OOXML в элемент управления содержимым в указанном расположении.
insertParagraph(paragraphText, insertLocation)	Вставляет абзац в указанном расположении.
insertTable(rowCount, columnCount, insertLocation, values)	Вставляет таблицу с указанным количеством строк и столбцов в элемент управления содержимым или рядом с ним.
insertText(text, insertLocation)	Вставляет текст в элемент управления содержимым в указанном расположении.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
resetState()	Сбрасывает состояние элемента управления содержимым.
search(searchText, searchOptions)	Выполняет поиск с заданными параметрами `ContentControl` поиска в области объекта. Результаты поиска представляют собой набор `Range` объектов.
select(selectionMode)	Выбирает элемент управления контентом. При этом Word переходит к выделенному фрагменту.
select(selectionMode)	Выбирает элемент управления контентом. При этом Word переходит к выделенному фрагменту.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
setState(contentControlState)	Задает состояние элемента управления содержимым.
setState(contentControlState)	Задает состояние элемента управления содержимым.
split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)	Разделяет элемент управления содержимым на дочерние диапазоны с помощью разделителей.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.ContentControl` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Word.Interfaces.ContentControlData`), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех `.sync` вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить `context.sync()` , прежде чем освобождение памяти вступит в силу.

События

onCommentAdded	Возникает при добавлении новых комментариев.
onCommentChanged	Возникает при изменении комментария или ответа.
onCommentDeselected	Возникает при отмене выделения комментария.
onCommentSelected	Возникает при выборе комментария.
onDataChanged	Возникает при изменении данных в элементе управления содержимым. Чтобы получить новый текст, загрузите этот элемент управления содержимым в обработчике. Чтобы получить старый текст, не загружайте его.
onDeleted	Возникает при удалении элемента управления содержимым. Не загружайте этот элемент управления содержимым в обработчике, иначе вы не сможете получить его исходные свойства.
onEntered	Возникает при входе в элемент управления содержимым.
onExited	Возникает при выходе из элемента управления содержимым, например при выходе курсора за пределы элемента управления содержимым.
onSelectionChanged	Возникает при изменении выделения в элементе управления содержимым.

appearance

Определяет внешний вид элемента управления содержимым. Это значение может быть следующим — boundingBox, tagsили hidden.

appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";

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

Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/90-scenarios/manage-watermark.yaml

// Adds a watermark to the document using OOXML.
await Word.run(async (context) => {
  const sections: Word.SectionCollection = context.document.sections;
  context.load(sections);
  await context.sync();

  const watermarkText: string = (document.getElementById("watermark-text") as HTMLInputElement).value;
  const myWatermark: string = getOoxmlWatermark(watermarkText);
  const myHeader: Word.Body = sections.items[0].getHeader("Primary");
  const myRange: Word.Range = myHeader.insertOoxml(myWatermark, "Replace");
  const myCC: Word.ContentControl = myRange.insertContentControl();
  myCC.title = "myTempCC";
  myCC.appearance = "Hidden";
  await context.sync();

  console.log("Watermark added successfully using OOXML.");
});

buildingBlockGalleryContentControl

Получает данные, связанные с коллекцией стандартных блоков, если элемент управления содержимым использует Word. ContentControlType — buildingBlockGallery. Это null не так.

readonly buildingBlockGalleryContentControl: Word.BuildingBlockGalleryContentControl;

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

Word.BuildingBlockGalleryContentControl

cannotDelete

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

cannotDelete: boolean;

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

boolean

cannotEdit

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

cannotEdit: boolean;

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

boolean

checkboxContentControl

Получает данные элемента управления содержимым, если его типом является checkBox. Это null не так.

readonly checkboxContentControl: Word.CheckboxContentControl;

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

Word.CheckboxContentControl

Примеры

// 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 of the first checkbox content control found in the selection.
await Word.run(async (context) => {
  const selectedRange: Word.Range = context.document.getSelection();
  let selectedContentControl = selectedRange
    .getContentControls({
      types: [Word.ContentControlType.checkBox]
    })
    .getFirstOrNullObject();
  selectedContentControl.load("id,checkboxContentControl/isChecked");

  await context.sync();

  if (selectedContentControl.isNullObject) {
    const parentContentControl: Word.ContentControl = selectedRange.parentContentControl;
    parentContentControl.load("id,type,checkboxContentControl/isChecked");
    await context.sync();

    if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.checkBox) {
      console.warn("No checkbox content control is currently selected.");
      return;
    } else {
      selectedContentControl = parentContentControl;
    }
  }

  const isCheckedBefore = selectedContentControl.checkboxContentControl.isChecked;
  console.log("isChecked state before:", `id: ${selectedContentControl.id} ... isChecked: ${isCheckedBefore}`);
  selectedContentControl.checkboxContentControl.isChecked = !isCheckedBefore;
  selectedContentControl.load("id,checkboxContentControl/isChecked");
  await context.sync();

  console.log(
    "isChecked state after:",
    `id: ${selectedContentControl.id} ... isChecked: ${selectedContentControl.checkboxContentControl.isChecked}`
  );
});

color

Цвет элемента управления содержимым. Цвет указывается в формате "#RRGGBB" или с помощью имени цвета.

color: string;

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

string

comboBoxContentControl

Получает данные элемента управления содержимым, если его типом является comboBox. Это null не так.

readonly comboBoxContentControl: Word.ComboBoxContentControl;

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

Word.ComboBoxContentControl

Примеры

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

// Adds the provided list item to the first combo box content control in the selection.
await Word.run(async (context) => {
  const listItemText = (document.getElementById("item-to-add") as HTMLInputElement).value.trim();
  const selectedRange: Word.Range = context.document.getSelection();
  let selectedContentControl = selectedRange
    .getContentControls({
      types: [Word.ContentControlType.comboBox]
    })
    .getFirstOrNullObject();
  selectedContentControl.load("id,comboBoxContentControl");
  await context.sync();

  if (selectedContentControl.isNullObject) {
    const parentContentControl: Word.ContentControl = selectedRange.parentContentControl;
    parentContentControl.load("id,type,comboBoxContentControl");
    await context.sync();

    if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.comboBox) {
      console.warn("No combo box content control is currently selected.");
      return;
    } else {
      selectedContentControl = parentContentControl;
    }
  }

  selectedContentControl.comboBoxContentControl.addListItem(listItemText);
  await context.sync();

  console.log(`List item added to control with ID ${selectedContentControl.id}: ${listItemText}`);
});

contentControls

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

readonly contentControls: Word.ContentControlCollection;

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

Word.ContentControlCollection

context

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

context: RequestContext;

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

Word.RequestContext

datePickerContentControl

Получает данные, связанные с выбором даты, если Word элемента управления содержимым. ContentControlType — datePicker. Это null не так.

readonly datePickerContentControl: Word.DatePickerContentControl;

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

Word.DatePickerContentControl

Примеры

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

// Gets and logs the properties of the first date picker content control.
await Word.run(async (context) => {
  let contentControls = context.document.getContentControls({
    types: [Word.ContentControlType.datePicker]
  });
  contentControls.load("items");

  await context.sync();

  if (contentControls.items.length === 0) {
    console.warn("No date picker content controls found in the document.");
    return;
  }

  const firstControl = contentControls.items[0];
  firstControl.load("datePickerContentControl");

  await context.sync();

  const datePicker: Word.DatePickerContentControl = firstControl.datePickerContentControl;
  datePicker.load("dateCalendarType, dateDisplayFormat, dateDisplayLocale, dateStorageFormat");

  await context.sync();

  console.log("Date picker content control properties:");
  console.log("  Calendar type: " + datePicker.dateCalendarType);
  console.log("  Display format: " + datePicker.dateDisplayFormat);
  console.log("  Display locale: " + datePicker.dateDisplayLocale);
  console.log("  Storage format: " + datePicker.dateStorageFormat);
});

dropDownListContentControl

Получает данные элемента управления содержимым, если его типом является dropDownList. Это null не так.

readonly dropDownListContentControl: Word.DropDownListContentControl;

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

Word.DropDownListContentControl

Примеры

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

// Adds the provided list item to the first dropdown list content control in the selection.
await Word.run(async (context) => {
  const listItemText = (document.getElementById("item-to-add") as HTMLInputElement).value.trim();
  const selectedRange: Word.Range = context.document.getSelection();
  let selectedContentControl = selectedRange
    .getContentControls({
      types: [Word.ContentControlType.dropDownList]
    })
    .getFirstOrNullObject();
  selectedContentControl.load("id,dropDownListContentControl");
  await context.sync();

  if (selectedContentControl.isNullObject) {
    const parentContentControl: Word.ContentControl = selectedRange.parentContentControl;
    parentContentControl.load("id,type,dropDownListContentControl");
    await context.sync();

    if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.dropDownList) {
      console.warn("No dropdown list content control is currently selected.");
      return;
    } else {
      selectedContentControl = parentContentControl;
    }
  }

  selectedContentControl.dropDownListContentControl.addListItem(listItemText);
  await context.sync();

  console.log(`List item added to control with ID ${selectedContentControl.id}: ${listItemText}`);
});

endnotes

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

readonly endnotes: Word.NoteItemCollection;

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

Word.NoteItemCollection

fields

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

readonly fields: Word.FieldCollection;

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

Word.FieldCollection

font

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

readonly font: Word.Font;

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

Word.Font

footnotes

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

readonly footnotes: Word.NoteItemCollection;

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

Word.NoteItemCollection

groupContentControl

Получает данные, связанные с группой, если элемент управления содержимым использует Word. ContentControlType — group. Это null не так.

readonly groupContentControl: Word.GroupContentControl;

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

Word.GroupContentControl

id

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

readonly id: number;

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

number

inlinePictures

Получает коллекцию InlinePicture объектов в элементе управления содержимым. Коллекция не включает плавающие изображения.

readonly inlinePictures: Word.InlinePictureCollection;

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

Word.InlinePictureCollection

lists

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

readonly lists: Word.ListCollection;

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

Word.ListCollection

paragraphs

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

readonly paragraphs: Word.ParagraphCollection;

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

Word.ParagraphCollection

Важно. Для наборов требований 1.1 и 1.2 абзацы в таблицах, полностью содержащихся в этом элементе управления содержимым, не возвращаются. Из набора требований 1.3 также возвращаются абзацы в таких таблицах.

parentBody

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

readonly parentBody: Word.Body;

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

Word.Body

parentContentControl

Получает элемент управления содержимым, содержащий элемент управления содержимым. Выдает ошибку, ItemNotFound если родительский элемент управления содержимым отсутствует.

readonly parentContentControl: Word.ContentControl;

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

Word.ContentControl

parentContentControlOrNullObject

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

readonly parentContentControlOrNullObject: Word.ContentControl;

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

Word.ContentControl

parentTable

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

readonly parentTable: Word.Table;

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

Word.Table

parentTableCell

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

readonly parentTableCell: Word.TableCell;

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

Word.TableCell

parentTableCellOrNullObject

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

readonly parentTableCellOrNullObject: Word.TableCell;

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

Word.TableCell

parentTableOrNullObject

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

readonly parentTableOrNullObject: Word.Table;

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

Word.Table

pictureContentControl

Получает данные, связанные с изображением, если Word элемента управления содержимым. ContentControlType — picture. Это null не так.

readonly pictureContentControl: Word.PictureContentControl;

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

Word.PictureContentControl

placeholderText

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

placeholderText: string;

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

string

removeWhenEdited

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

removeWhenEdited: boolean;

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

boolean

repeatingSectionContentControl

Получает повторяющиеся данные, связанные с разделом, если Word элемента управления содержимым. ContentControlType — repeatingSection. Это null не так.

readonly repeatingSectionContentControl: Word.RepeatingSectionContentControl;

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

Word.RepeatingSectionContentControl

style

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

style: string;

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

string

styleBuiltIn

Указывает встроенное имя стиля для элемента управления содержимым. Используйте это свойство для встроенных стилей, поддерживающих несколько языковых стандартов. Чтобы использовать пользовательские стили или локализованные имена стилей, см. свойство style .

styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

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

subtype

Возвращает подтип элемента управления содержимым. Подтип может быть следующим — richTextInline, richTextParagraphs,richTextTableCell и richTextTablerichTextTableRow для элементов управления содержимым в форматированном тексте, plainTextInline для plainTextParagraph элементов управления содержимым в формате обычного текста, checkBox для элементов управления содержимым флажков, для элементов управления содержимым раскрывающихся списков, dropDownListcomboBox для элементов управления содержимым поля со списком, buildingBlockGallery для элементов управления содержимым галереи стандартных блоков, datePicker для элементов управления средствами выбора даты, repeatingSection для элементов управления содержимым повторяющихся разделов, picture для элементов управления содержимым изображений и group для элементов управления содержимым групп.

readonly subtype: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group";

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

tables

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

readonly tables: Word.TableCollection;

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

Word.TableCollection

tag

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

tag: string;

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

string

Примеры

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

// Traverses each paragraph of the document and wraps a content control on each with either a even or odd tags.
await Word.run(async (context) => {
  let paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none"); // Don't need any properties; just wrap each paragraph with a content control.

  await context.sync();

  for (let i = 0; i < paragraphs.items.length; i++) {
    let contentControl = paragraphs.items[i].insertContentControl();
    // For even, tag "even".
    if (i % 2 === 0) {
      contentControl.tag = "even";
    } else {
      contentControl.tag = "odd";
    }
  }
  console.log("Content controls inserted: " + paragraphs.items.length);

  await context.sync();
});

text

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

readonly text: string;

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

string

title

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

title: string;

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

string

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/90-scenarios/doc-assembly.yaml

// Simulates creation of a template. First searches the document for instances of the string "Contractor",
// then changes the format  of each search result,
// then wraps each search result within a content control,
// finally sets a tag and title property on each content control.
await Word.run(async (context) => {
    const results: Word.RangeCollection = context.document.body.search("Contractor");
    results.load("font/bold");

    // Check to make sure these content controls haven't been added yet.
    const customerContentControls: Word.ContentControlCollection = context.document.contentControls.getByTag("customer");
    customerContentControls.load("text");
    await context.sync();

  if (customerContentControls.items.length === 0) {
    for (let i = 0; i < results.items.length; i++) {
        results.items[i].font.bold = true;
        let cc: Word.ContentControl = results.items[i].insertContentControl();
        cc.tag = "customer";  // This value is used in the next step of this sample.
        cc.title = "Customer Name " + i;
    }
  }
    await context.sync();
});

type

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

readonly type: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group";

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

xmlMapping

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

readonly xmlMapping: Word.XmlMapping;

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

Word.XmlMapping

clear()

Очищает содержимое элемента управления содержимым. Пользователь может отменить операцию для очищенного содержимого.

clear(): void;

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

void

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the content controls collection.
    contentControls.load('text');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
        
    if (contentControls.items.length === 0) {
        console.log("There isn't a content control in this document.");
    } else {
        // Queue a command to clear the contents of the first content control.
        contentControls.items[0].clear();

        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Content control cleared of contents.');
    }
});

delete(keepContent)

Удаляет элемент управления содержимым и его содержимое. Если keepContent установлено значение true, содержимое не удаляется.

delete(keepContent: boolean): void;

Параметры

keepContent: boolean

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

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

void

Примеры

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

await Word.run(async (context) => {
  const contentControls: Word.ContentControlCollection = context.document.contentControls.getByTag("forTesting");
  contentControls.load("items");
  await context.sync();

  if (contentControls.items.length === 0) {
    console.log("There are no content controls in this document.");
  } else {
    console.log("Control to be deleted:", contentControls.items[0]);
    contentControls.items[0].delete(false);
    await context.sync();
  }
});

getComments()

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

getComments(): Word.CommentCollection;

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

Word.CommentCollection

getContentControls(options)

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

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

Параметры

options: Word.ContentControlOptions

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

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

Word.ContentControlCollection

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

getHtml()

Получает HTML-представление ContentControl объекта. При визуализации на веб-странице или в средстве просмотра HTML форматирование будет близко, но не точно соответствовать форматированию документа. Этот метод не возвращает один и тот же HTML-код для одного и того же документа на разных платформах (Windows, Mac, Word в Интернете и т. д.). Если вам требуется точная точность или согласованность платформ, используйте ContentControl.getOoxml() и преобразуйте возвращенный XML-файл в HTML.

getHtml(): OfficeExtension.ClientResult<string>;

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

OfficeExtension.ClientResult<string>

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection that contains a specific tag.
    const contentControlsWithTag = context.document.contentControls.getByTag('Customer-Address');
    
    // Queue a command to load the tag property for all of content controls.
    contentControlsWithTag.load('tag');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControlsWithTag.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to get the HTML contents of the first content control.
        const html = contentControlsWithTag.items[0].getHtml();
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Content control HTML: ' + html.value);
    }
});

getOoxml()

Получает представление ContentControl объекта Office Open XML (OOXML).

getOoxml(): OfficeExtension.ClientResult<string>;

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

OfficeExtension.ClientResult<string>

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to get the OOXML contents of the first content control.
        const ooxml = contentControls.items[0].getOoxml();
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Content control OOXML: ' + ooxml.value);
    }
});

getRange(rangeLocation)

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

getRange(rangeLocation?: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;

Параметры

rangeLocation: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"

Необязательный параметр. Диапазон должен располагаться следующим образом: whole,start , afterbeforeendили .content

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

Word.Range

getReviewedText(changeTrackingVersion)

Получает проверенный текст на основе выбора ChangeTrackingVersion.

getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;

Параметры

changeTrackingVersion: Word.ChangeTrackingVersion

Необязательный параметр. Значение должно быть или originalcurrent. Значение по умолчанию — current.

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

OfficeExtension.ClientResult<string>

getReviewedText(changeTrackingVersion)

Получает проверенный текст на основе выбора ChangeTrackingVersion.

getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;

Параметры

changeTrackingVersion: "Original" | "Current"

Необязательный параметр. Значение должно быть или originalcurrent. Значение по умолчанию — current.

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

OfficeExtension.ClientResult<string>

getTextRanges(endingMarks, trimSpacing)

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

getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;

Параметры

endingMarks: string[]

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

trimSpacing: boolean

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

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

Word.RangeCollection

getTrackedChanges()

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

getTrackedChanges(): Word.TrackedChangeCollection;

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

Word.TrackedChangeCollection

insertBreak(breakType, insertLocation)

Вставляет разрыв в указанном расположении в основном документе. Этот метод нельзя использовать с richTextTable, richTextTableRow, и richTextTableCell элементами управления содержимым.

insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): void;

Параметры

breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"

Тип перерыва.

insertLocation: start | end | before | after | "Start" | "End" | "Before" | "After"

Значение должно быть следующим : start, beforeend, или .after

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

void

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of content controls.
    contentControls.load('id');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    // We now will have access to the content control collection.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to insert a page break after the first content control.
        contentControls.items[0].insertBreak(Word.BreakType.page, Word.InsertLocation.after);
        
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Inserted a page break after the first content control.');    
    }
});

insertFileFromBase64(base64File, insertLocation)

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

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

Параметры

base64File: string

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

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

Значение должно быть : replace, startили end. replace Нельзя использовать с richTextTablerichTextTableRow элементами управления содержимым.

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

Word.Range

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

insertHtml(html, insertLocation)

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

insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Параметры

html: string

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

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

Значение должно быть : replace, startили end. replace Нельзя использовать с richTextTablerichTextTableRow элементами управления содержимым.

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

Word.Range

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to put HTML into the contents of the first content control.
        contentControls.items[0].insertHtml(
            '<strong>HTML content inserted into the content control.</strong>',
            'Start');
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Inserted HTML in the first content control.');
    }
});

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

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

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;

Параметры

base64EncodedImage: string

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

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

Значение должно быть : replace, startили end. replace Нельзя использовать с richTextTablerichTextTableRow элементами управления содержимым.

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

Word.InlinePicture

insertOoxml(ooxml, insertLocation)

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

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Параметры

ooxml: string

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

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

Значение должно быть : replace, startили end. replace Нельзя использовать с richTextTablerichTextTableRow элементами управления содержимым.

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

Word.Range

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to put OOXML into the contents of the first content control.
        contentControls.items[0].insertOoxml("<pkg:package xmlns:pkg='http://schemas.microsoft.com/office/2006/xmlPackage'><pkg:part pkg:name='/_rels/.rels' pkg:contentType='application/vnd.openxmlformats-package.relationships+xml' pkg:padding='512'><pkg:xmlData><Relationships xmlns='http://schemas.openxmlformats.org/package/2006/relationships'><Relationship Id='rId1' Type='http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument' Target='word/document.xml'/></Relationships></pkg:xmlData></pkg:part><pkg:part pkg:name='/word/document.xml' pkg:contentType='application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml'><pkg:xmlData><w:document xmlns:w='http://schemas.openxmlformats.org/wordprocessingml/2006/main' ><w:body><w:p><w:pPr><w:spacing w:before='360' w:after='0' w:line='480' w:lineRule='auto'/><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr></w:pPr><w:r><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr><w:t>This text has formatting directly applied to achieve its font size, color, line spacing, and paragraph spacing.</w:t></w:r></w:p></w:body></w:document></pkg:xmlData></pkg:part></pkg:package>", "End");
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Inserted OOXML in the first content control.');
    }
});  

// Read "Create better add-ins for Word with Office Open XML" for guidance on working with OOXML.
// https://learn.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml

insertParagraph(paragraphText, insertLocation)

Вставляет абзац в указанном расположении.

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;

Параметры

paragraphText: string

Текст абзаца, который необходимо вставить.

insertLocation: start | end | before | after | "Start" | "End" | "Before" | "After"

Значение должно быть следующим : start, beforeend, или .after before и after не может использоваться вместе с richTextTable, richTextTableRow, и richTextTableCell элементами управления содержимым.

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

Word.Paragraph

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to insert a paragraph after the first content control.
        contentControls.items[0].insertParagraph('Text of the inserted paragraph.', 'After');
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Inserted a paragraph after the first content control.');
    }
});

insertTable(rowCount, columnCount, insertLocation, values)

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

insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After", values?: string[][]): Word.Table;

Параметры

rowCount: number

Количество строк в таблице.

columnCount: number

Количество столбцов в таблице.

insertLocation: start | end | before | after | "Start" | "End" | "Before" | "After"

Значение должно быть следующим : start, beforeend, или .after before и after не может использоваться вместе с richTextTable, richTextTableRow, и richTextTableCell элементами управления содержимым.

values: string[][]

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

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

Word.Table

insertText(text, insertLocation)

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

insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Параметры

text: string

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

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

Значение должно быть : replace, startили end. replace Нельзя использовать с richTextTablerichTextTableRow элементами управления содержимым.

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

Word.Range

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to replace text in the first content control.
        contentControls.items[0].insertText('Replaced text in the first content control.', 'Replace');
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Replaced text in the first content control.');
    }
});

load(options)

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

load(options?: Word.Interfaces.ContentControlLoadOptions): Word.ContentControl;

Параметры

options: Word.Interfaces.ContentControlLoadOptions

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

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

Word.ContentControl

Примеры

// Load all of the content control properties
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    } else {
        // Queue a command to load the properties on the first content control.
        contentControls.items[0].load(  'appearance,' +
                                        'cannotDelete,' +
                                        'cannotEdit,' +
                                        'id,' +
                                        'placeHolderText,' +
                                        'removeWhenEdited,' +
                                        'title,' +
                                        'text,' +
                                        'type,' +
                                        'style,' +
                                        'tag,' +
                                        'font/size,' +
                                        'font/name,' +
                                        'font/color');             
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Property values of the first content control:' + 
            '   ----- appearance: ' + contentControls.items[0].appearance + 
            '   ----- cannotDelete: ' + contentControls.items[0].cannotDelete +
            '   ----- cannotEdit: ' + contentControls.items[0].cannotEdit +
            '   ----- color: ' + contentControls.items[0].color +
            '   ----- id: ' + contentControls.items[0].id +
            '   ----- placeHolderText: ' + contentControls.items[0].placeholderText +
            '   ----- removeWhenEdited: ' + contentControls.items[0].removeWhenEdited +
            '   ----- title: ' + contentControls.items[0].title +
            '   ----- text: ' + contentControls.items[0].text +
            '   ----- type: ' + contentControls.items[0].type +
            '   ----- style: ' + contentControls.items[0].style +
            '   ----- tag: ' + contentControls.items[0].tag +
            '   ----- font size: ' + contentControls.items[0].font.size +
            '   ----- font name: ' + contentControls.items[0].font.name +
            '   ----- font color: ' + contentControls.items[0].font.color);
    }
});

load(propertyNames)

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

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

Параметры

propertyNames: string | string[]

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

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

Word.ContentControl

load(propertyNamesAndPaths)

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

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

Параметры

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

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

Word.ContentControl

resetState()

Примечание

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

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

resetState(): void;

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

void

Примеры

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

// Resets the state of the first content control.
await Word.run(async (context) => {
  let firstContentControl = context.document.contentControls.getFirstOrNullObject();
  await context.sync();

  if (firstContentControl.isNullObject) {
    console.warn("There are no content controls in this document.");
    return;
  }

  firstContentControl.resetState();
  firstContentControl.load("id");
  await context.sync();

  console.log(`Reset state of first content control with ID: ${firstContentControl.id}`);
});

search(searchText, searchOptions)

Выполняет поиск с заданными параметрами ContentControl поиска в области объекта. Результаты поиска представляют собой набор 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

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the content controls collection.
    const contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls.
    contentControls.load('id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (contentControls.items.length === 0) {
        console.log('No content control found.');
    }
    else {
        // Queue a command to select the first content control.
        contentControls.items[0].select();
    
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Selected the first content control.');
    }
});

select(selectionMode)

Выбирает элемент управления контентом. При этом Word переходит к выделенному фрагменту.

select(selectionMode?: Word.SelectionMode): void;

Параметры

selectionMode: Word.SelectionMode

Необязательный параметр. Режим выделения должен быть , selectstartили .end select используется по умолчанию.

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

void

select(selectionMode)

Выбирает элемент управления контентом. При этом Word переходит к выделенному фрагменту.

select(selectionMode?: "Select" | "Start" | "End"): void;

Параметры

selectionMode: "Select" | "Start" | "End"

Необязательный параметр. Режим выделения должен быть , selectstartили .end select используется по умолчанию.

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

void

set(properties, options)

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

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

Параметры

properties: Word.Interfaces.ContentControlUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

Примеры

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

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

  await context.sync();

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

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

  await context.sync();
});

set(properties)

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

set(properties: Word.ContentControl): void;

Параметры

properties: Word.ContentControl

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

void

setState(contentControlState)

Примечание

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

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

setState(contentControlState: Word.ContentControlState): void;

Параметры

contentControlState: Word.ContentControlState

Состояние, которое необходимо установить.

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

void

Примеры

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

// Sets the state of the first content control.
await Word.run(async (context) => {
  const state = ((document.getElementById("state-to-set") as HTMLSelectElement)
    .value as unknown) as Word.ContentControlState;
  let firstContentControl = context.document.contentControls.getFirstOrNullObject();
  await context.sync();

  if (firstContentControl.isNullObject) {
    console.warn("There are no content controls in this document.");
    return;
  }

  firstContentControl.setState(state);
  firstContentControl.load("id");
  await context.sync();

  console.log(`Set state of first content control with ID ${firstContentControl.id} to ${state}.`);
});

setState(contentControlState)

Примечание

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

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

setState(contentControlState: "Error" | "Warning"): void;

Параметры

contentControlState: "Error" | "Warning"

Состояние, которое необходимо установить.

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

void

split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)

Разделяет элемент управления содержимым на дочерние диапазоны с помощью разделителей.

split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection;

Параметры

delimiters: string[]

Разделители в виде массива строк.

multiParagraphs: boolean

Необязательный параметр. Указывает, может ли возвращенный дочерний диапазон охватить несколько абзацев. Значение "Default" false указывает, что границы абзаца также используются в качестве разделителей.

trimDelimiters: boolean

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

trimSpacing: boolean

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

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

Word.RangeCollection

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.ContentControl объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.ContentControlData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Word.Interfaces.ContentControlData;

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

Word.Interfaces.ContentControlData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.

track(): Word.ContentControl;

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

Word.ContentControl

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

untrack(): Word.ContentControl;

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

Word.ContentControl

onCommentAdded

Примечание

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

Возникает при добавлении новых комментариев.

readonly onCommentAdded: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentChanged

Примечание

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

Возникает при изменении комментария или ответа.

readonly onCommentChanged: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentDeselected

Примечание

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

Возникает при отмене выделения комментария.

readonly onCommentDeselected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentSelected

Примечание

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

Возникает при выборе комментария.

readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onDataChanged

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

readonly onDataChanged: OfficeExtension.EventHandlers<Word.ContentControlDataChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.ContentControlDataChangedEventArgs>

Примеры

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

await Word.run(async (context) => {
  const contentControls: Word.ContentControlCollection = context.document.contentControls;
  contentControls.load("items");
  await context.sync();

  // Register the onDataChanged event handler on each content control.
  if (contentControls.items.length === 0) {
    console.log("There aren't any content controls in this document so can't register event handlers.");
  } else {
    for (let i = 0; i < contentControls.items.length; i++) {
      eventContexts[i] = contentControls.items[i].onDataChanged.add(contentControlDataChanged);
      contentControls.items[i].track();
    }

    await context.sync();

    console.log("Added event handlers for when data is changed in content controls.");
  }
});

...

async function contentControlDataChanged(event: Word.ContentControlDataChangedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. IDs of content controls where data was changed:`, event.ids);
  });
}

onDeleted

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

readonly onDeleted: OfficeExtension.EventHandlers<Word.ContentControlDeletedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.ContentControlDeletedEventArgs>

Примеры

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

await Word.run(async (context) => {
  const contentControls: Word.ContentControlCollection = context.document.contentControls;
  contentControls.load("items");
  await context.sync();

  // Register the onDeleted event handler on each content control.
  if (contentControls.items.length === 0) {
    console.log("There aren't any content controls in this document so can't register event handlers.");
  } else {
    for (let i = 0; i < contentControls.items.length; i++) {
      eventContexts[i] = contentControls.items[i].onDeleted.add(contentControlDeleted);
      contentControls.items[i].track();
    }

    await context.sync();

    console.log("Added event handlers for when content controls are deleted.");
  }
});

...

async function contentControlDeleted(event: Word.ContentControlDeletedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. IDs of content controls that were deleted:`, event.ids);
  });
}

onEntered

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

readonly onEntered: OfficeExtension.EventHandlers<Word.ContentControlEnteredEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.ContentControlEnteredEventArgs>

Примеры

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

await Word.run(async (context) => {
  const contentControls: Word.ContentControlCollection = context.document.contentControls;
  contentControls.load("items");
  await context.sync();

  // Register the onEntered event handler on each content control.
  if (contentControls.items.length === 0) {
    console.log("There aren't any content controls in this document so can't register event handlers.");
  } else {
    for (let i = 0; i < contentControls.items.length; i++) {
      eventContexts[i] = contentControls.items[i].onEntered.add(contentControlEntered);
      contentControls.items[i].track();
    }

    await context.sync();

    console.log("Added event handlers for when the cursor is placed in content controls.");
  }
});

...

async function contentControlEntered(event: Word.ContentControlEnteredEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. ID of content control that was entered: ${event.ids[0]}`);
  });
}

onExited

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

readonly onExited: OfficeExtension.EventHandlers<Word.ContentControlExitedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.ContentControlExitedEventArgs>

Примеры

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

await Word.run(async (context) => {
  const contentControls: Word.ContentControlCollection = context.document.contentControls;
  contentControls.load("items");
  await context.sync();

  // Register the onExited event handler on each content control.
  if (contentControls.items.length === 0) {
    console.log("There aren't any content controls in this document so can't register event handlers.");
  } else {
    for (let i = 0; i < contentControls.items.length; i++) {
      eventContexts[i] = contentControls.items[i].onExited.add(contentControlExited);
      contentControls.items[i].track();
    }

    await context.sync();

    console.log("Added event handlers for when the cursor is removed from within content controls.");
  }
});

...

async function contentControlExited(event: Word.ContentControlExitedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. ID of content control that was exited: ${event.ids[0]}`);
  });
}

onSelectionChanged

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

readonly onSelectionChanged: OfficeExtension.EventHandlers<Word.ContentControlSelectionChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.ContentControlSelectionChangedEventArgs>

Примеры

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

await Word.run(async (context) => {
  const contentControls: Word.ContentControlCollection = context.document.contentControls;
  contentControls.load("items");
  await context.sync();

  if (contentControls.items.length === 0) {
    console.log("There aren't any content controls in this document so can't register event handlers.");
  } else {
    for (let i = 0; i < contentControls.items.length; i++) {
      eventContexts[i] = contentControls.items[i].onSelectionChanged.add(contentControlSelectionChanged);
      contentControls.items[i].track();
    }

    await context.sync();

    console.log("Added event handlers for when selections are changed in content controls.");
  }
});

...

async function contentControlSelectionChanged(event: Word.ContentControlSelectionChangedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. IDs of content controls where selection was changed:`, event.ids);
  });
}

Комментарии

Используется

Примеры

Свойства

Методы

События

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

appearance

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

Комментарии

Примеры

buildingBlockGalleryContentControl

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

Комментарии

cannotDelete

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

Комментарии

cannotEdit

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

Комментарии

checkboxContentControl

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

Комментарии

Примеры

color

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

Комментарии

comboBoxContentControl

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

Комментарии

Примеры

contentControls

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

Комментарии

context

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

datePickerContentControl

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

Комментарии

Примеры

dropDownListContentControl

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

Комментарии

Примеры

endnotes

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

Комментарии

fields

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

Комментарии

font

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

Комментарии

footnotes

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

Комментарии

groupContentControl

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

Комментарии

id

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

Комментарии

inlinePictures

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

Комментарии

lists

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

Комментарии

paragraphs

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

Комментарии

parentBody

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

Комментарии

parentContentControl

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

Комментарии

parentContentControlOrNullObject

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