Word.ContentControlEnteredEventArgs interface

Paket:

word

Stellt Informationen zum Inhaltssteuerelement bereit, das das contentControlEntered-Ereignis ausgelöst hat.

Hinweise

[ API-Satz: WordApi 1.5 ]

Beispiele

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

Eigenschaften

eventType	Der Ereignistyp. Weitere Informationen finden Sie unter Word. EventType für Details.
ids	Ruft die Inhaltssteuerelement-IDs ab.
source	Die Quelle des Ereignisses. Sie kann lokal oder remote sein (durch gemeinsame Dokumenterstellung).

Details zur Eigenschaft

eventType

Der Ereignistyp. Weitere Informationen finden Sie unter Word. EventType für Details.

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

Eigenschaftswert

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

Hinweise

[ API-Satz: WordApi 1.5 ]

ids

Ruft die Inhaltssteuerelement-IDs ab.

ids: number[];

Eigenschaftswert

number[]

Hinweise

[ API-Satz: WordApi 1.5 ]

source

Die Quelle des Ereignisses. Sie kann lokal oder remote sein (durch gemeinsame Dokumenterstellung).

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

Eigenschaftswert

Word.EventSource | "Local" | "Remote"

Hinweise

[ API-Satz: WordApi 1.5 ]