PowerPoint.TagCollection class

Referenz

Paket:: powerpoint

Stellt die Auflistung von Tags dar.

Extends: OfficeExtension.ClientObject

Hinweise

Eigenschaften

context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
items	Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Methoden

add(key, value)	Fügt am Ende der Auflistung ein neues Tag hinzu. Wenn der Schlüssel bereits in der Auflistung vorhanden ist, wird der Wert des vorhandenen Tags durch das angegebene `value`ersetzt.
delete(key)	Löscht das Tag mit dem angegebenen Schlüssel in dieser Auflistung. Führt nichts aus, wenn der Schlüssel nicht vorhanden ist.
getCount()	Ruft die Anzahl der Tags in der Auflistung ab.
getItem(key)	Ruft ein Tag unter Verwendung seiner eindeutigen ID ab. Wenn das Tag nicht vorhanden ist, wird ein Fehler ausgelöst.
getItemAt(index)	Ruft ein Tag mit seinem nullbasierten Index in der Auflistung ab. Wenn sich der Index außerhalb des zulässigen Bereichs befindet, wird ein Fehler ausgelöst.
getItemOrNullObject(key)	Ruft ein Tag unter Verwendung seiner eindeutigen ID ab. Wenn ein solches Tag nicht vorhanden ist, wird ein Objekt zurückgegeben, bei dem eine `isNullObject` Eigenschaft auf true festgelegt ist.
load(options)	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)	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)	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.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` -Methode des Objekts auf, das an das Objekt ü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 Auflistung enthält.

Details zur Eigenschaft

context

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

context: RequestContext;

Eigenschaftswert

PowerPoint.RequestContext

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: PowerPoint.Tag[];

Eigenschaftswert

PowerPoint.Tag[]

Details zur Methode

add(key, value)

Fügt am Ende der Auflistung ein neues Tag hinzu. Wenn der Schlüssel bereits in der Auflistung vorhanden ist, wird der Wert des vorhandenen Tags durch das angegebene valueersetzt.

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

Parameter

key: string

Die eindeutige ID eines Tags, die innerhalb dieses TagCollectioneindeutig ist. Die Schlüsselzeichenfolge wird groß geschrieben, wenn sie im Dokument gespeichert wird.

value: string

Wert des Tags.

Gibt zurück

void

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

delete(key)

Löscht das Tag mit dem angegebenen Schlüssel in dieser Auflistung. Führt nichts aus, wenn der Schlüssel nicht vorhanden ist.

delete(key: string): void;

Parameter

key: string

Die eindeutige ID eines Tags, die innerhalb dieses TagCollectioneindeutig ist. Bei diesem Parameter wird die Groß-/Kleinschreibung nicht beachtet.

Gibt zurück

void

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 = context.presentation.tags;

  presentationTags.delete("COLOR");

  await context.sync();

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

getCount()

Ruft die Anzahl der Tags in der Auflistung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

OfficeExtension.ClientResult<number>

Die Anzahl der Tags in der Auflistung.

Hinweise

[ API-Satz: PowerPointApi 1.3 ]

getItem(key)

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

getItem(key: string): PowerPoint.Tag;

Parameter

key: string

Die ID des Tags. Bei der ID muss die Groß-/Kleinschreibung beachtet werden.

Gibt zurück

PowerPoint.Tag

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 = context.presentation.slides.getItemAt(selectedSlideIndex);
  slide.tags.add("CUSTOMER_TYPE", "Premium");

  await context.sync();

  const audienceTag = 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));
});

getItemAt(index)

Ruft ein Tag mit seinem nullbasierten Index in der Auflistung ab. Wenn sich der Index außerhalb des zulässigen Bereichs befindet, wird ein Fehler ausgelöst.

getItemAt(index: number): PowerPoint.Tag;

Parameter

index: number

Der Index des Tags in der Auflistung.

Gibt zurück

PowerPoint.Tag

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

Hinweise

[ API-Satz: PowerPointApi 1.3 ]

getItemOrNullObject(key)

Ruft ein Tag unter Verwendung seiner eindeutigen ID ab. Wenn ein solches Tag nicht vorhanden ist, wird ein Objekt zurückgegeben, bei dem eine isNullObject Eigenschaft auf true festgelegt ist.

getItemOrNullObject(key: string): PowerPoint.Tag;

Parameter

key: string

Die ID des Tags. Bei der ID muss die Groß-/Kleinschreibung beachtet werden.

Gibt zurück

PowerPoint.Tag

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

Hinweise

[ API-Satz: PowerPointApi 1.3 ]

load(options)

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

options: PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

PowerPoint.TagCollection

load(propertyNames)

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

propertyNames: string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

PowerPoint.TagCollection

load(propertyNamesAndPaths)

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

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

PowerPoint.TagCollection

toJSON()

Ü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 das Objekt ü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 Auflistung enthält.

toJSON(): PowerPoint.Interfaces.TagCollectionData;

Gibt zurück

PowerPoint.Interfaces.TagCollectionData

PowerPoint.TagCollection class

Hinweise

Eigenschaften

Methoden

Details zur Eigenschaft

context

Eigenschaftswert

items

Eigenschaftswert

Details zur Methode

add(key, value)

Parameter

Gibt zurück

Hinweise

Beispiele

delete(key)

Parameter

Gibt zurück

Hinweise

Beispiele

getCount()

Gibt zurück

Hinweise

getItem(key)

Parameter

Gibt zurück

Hinweise

Beispiele

getItemAt(index)

Parameter

Gibt zurück

Hinweise

getItemOrNullObject(key)

Parameter

Gibt zurück

Hinweise

load(options)

Parameter

Gibt zurück

load(propertyNames)

Parameter

Gibt zurück

load(propertyNamesAndPaths)

Parameter

Gibt zurück

toJSON()

Gibt zurück

Feedback

Zusätzliche Ressourcen