Word.ContentControlEnteredEventArgs interface

Pacote:

word

Fornece informações sobre o controle de conteúdo que gerou o evento ContentControlEntered.

Comentários

[ Conjunto de API: WordApi 1.5 ]

Exemplos

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

Propriedades

eventType	O tipo de evento. Consulte Word. EventType para obter detalhes.
ids	Obtém as IDs de controle de conteúdo.
source	A origem do evento. Ele pode ser local ou remoto (por meio de coautoria).

Detalhes da propriedade

eventType

O tipo de evento. Consulte Word. EventType para obter detalhes.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: WordApi 1.5 ]

ids

Obtém as IDs de controle de conteúdo.

ids: number[];

Valor da propriedade

number[]

Comentários

[ Conjunto de API: WordApi 1.5 ]

source

A origem do evento. Ele pode ser local ou remoto (por meio de coautoria).

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

Valor da propriedade

Word.EventSource | "Local" | "Remote"

Comentários

[ Conjunto de API: WordApi 1.5 ]