PowerPoint.TagCollection class

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: PowerPoint.Tag[];

Eigenschaftswert

Fügt am Ende der Sammlung ein neues Tag hinzu. Wenn der key bereits in der Sammlung vorhanden ist, wird der Wert des vorhandenen Tags durch den angegebenen valueersetzt.

add(key: string, value: string): void;

Parameter

Gibt zurück

Hinweise

API-Satz: PowerPointApi 1.3

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/tags/tags.yaml

await PowerPoint.run(async function (context) {
  const slide: PowerPoint.Slide = context.presentation.slides.getItemAt(0);
  slide.tags.add("OCEAN", "Indian");
  slide.tags.add("PLANET", "Jupiter");
  slide.tags.add("CONTINENT", "Antarctica");

  await context.sync();

  slide.tags.load("key, value");

  await context.sync();

  for (let i = 0; i < slide.tags.items.length; i++) {
    console.log(
      "Added key " +
        JSON.stringify(slide.tags.items[i].key) +
        " with value " +
        JSON.stringify(slide.tags.items[i].value),
    );
  }
});

Löscht das Tag mit dem angegebenen key in dieser Sammlung. Tut nichts, wenn es key nicht existiert.

delete(key: string): void;

Parameter

Gibt zurück

Hinweise

API-Satz: PowerPointApi 1.3

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/tags/tags.yaml

await PowerPoint.run(async function (context) {
  let presentationTags: PowerPoint.TagCollection = context.presentation.tags;

  presentationTags.delete("COLOR");

  await context.sync();

  console.log(JSON.stringify(presentationTags));
});

Ruft die Anzahl der Tags in der Sammlung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

Die Anzahl der Tags in der Sammlung.

Hinweise

API-Satz: PowerPointApi 1.3

Ruft ein Tag mithilfe seiner eindeutigen ID ab. Wenn das Tag nicht vorhanden ist, wird ein Fehler ausgelöst.

getItem(key: string): PowerPoint.Tag;

Parameter

Gibt zurück

Das Tag mit der eindeutigen ID. Wenn ein solches Tag nicht vorhanden ist, wird ein Fehler ausgelöst.

Hinweise

API-Satz: PowerPointApi 1.3

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/tags/tags.yaml

await PowerPoint.run(async function (context) {
  let selectedSlideIndex = await getSelectedSlideIndex();

  // Decrement because the getSelectedSlideByIndex method is 1-based,
  // but the getItemAt method is 0-based.
  selectedSlideIndex = selectedSlideIndex - 1;
  const slide: PowerPoint.Slide = context.presentation.slides.getItemAt(selectedSlideIndex);
  slide.tags.add("CUSTOMER_TYPE", "Premium");

  await context.sync();

  const audienceTag: PowerPoint.Tag = slide.tags.getItem("CUSTOMER_TYPE");
  audienceTag.load("key, value");

  await context.sync();

  console.log("Added key " + JSON.stringify(audienceTag.key) + " with value " + JSON.stringify(audienceTag.value));
});

Ruft ein Tag mithilfe seines nullbasierten Index in der Auflistung ab. Ein Fehler wird ausgelöst, wenn der Index außerhalb des zulässigen Bereichs liegt.

getItemAt(index: number): PowerPoint.Tag;

Parameter

Gibt zurück

Das Tag am angegebenen Index. Ein Fehler wird ausgelöst, wenn der Index außerhalb des zulässigen Bereichs liegt.

Hinweise

API-Satz: PowerPointApi 1.3

Ruft ein Tag mithilfe seiner eindeutigen ID ab. Wenn ein solches Tag nicht vorhanden ist, wird ein Objekt mit einer isNullObject Eigenschaft zurückgegeben, die auf true festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getItemOrNullObject(key: string): PowerPoint.Tag;

Parameter

Gibt zurück

Das Tag mit der eindeutigen ID. Wenn ein solches Tag nicht vorhanden ist, wird ein Objekt mit einer isNullObject Eigenschaft zurückgegeben, die auf true festgelegt ist.

Hinweise

API-Satz: PowerPointApi 1.3

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TagCollection;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): PowerPoint.TagCollection;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TagCollection;

Parameter

Gibt zurück

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche PowerPoint.TagCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.TagCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.

toJSON(): PowerPoint.Interfaces.TagCollectionData;

Gibt zurück