Word.ContentControlSelectionChangedEventArgs interface

Paket:

word

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

Hinweise

[ API-Satz: WordApi 1.5 ]

Beispiele

TypeScript

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

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.

TypeScript

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.

TypeScript

ids: number[];

Eigenschaftswert

number[]

Hinweise

[ API-Satz: WordApi 1.5 ]

source

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

TypeScript

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

Eigenschaftswert

Word.EventSource | "Local" | "Remote"

Hinweise

[ API-Satz: WordApi 1.5 ]