Word.ContentControlEnteredEventArgs interface

Пакет:

word

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

Комментарии

[ Набор API: WordApi 1.5 ]

Примеры

// 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]}`);
  });
}

Свойства

eventType	Тип события. См. Word. EventType для получения дополнительных сведений.
ids	Возвращает идентификаторы элементов управления содержимым.
source	Источник события. Он может быть локальным или удаленным (с помощью совместного редактирования).

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

eventType

Тип события. См. Word. EventType для получения дополнительных сведений.

eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";

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

Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"

Комментарии

[ Набор API: WordApi 1.5 ]

ids

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

ids: number[];

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

number[]

Комментарии

[ Набор API: WordApi 1.5 ]

source

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

source: Word.EventSource | "Local" | "Remote";

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

Word.EventSource | "Local" | "Remote"

Комментарии

[ Набор API: WordApi 1.5 ]