PowerPoint.TagCollection class

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: PowerPoint.Tag[];

Valeur de propriété

Ajoute une nouvelle balise à la fin de la collection. Si le key existe déjà dans la collection, la valeur de la balise existante sera remplacée par la valeur .value

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

Paramètres

Retours

Remarques

Jeu d’API : PowerPointApi 1.3

Exemples

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

Supprime la balise avec le donné key dans cette collection. Ne fait rien si le key n’existe pas.

delete(key: string): void;

Paramètres

Retours

Remarques

Jeu d’API : PowerPointApi 1.3

Exemples

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

Obtient le nombre de balises dans la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Nombre de balises dans la collection.

Remarques

Jeu d’API : PowerPointApi 1.3

Obtient une balise à l’aide de son ID unique. Une erreur est générée si la balise n’existe pas.

getItem(key: string): PowerPoint.Tag;

Paramètres

Retours

Balise avec l’ID unique. Si une telle balise n’existe pas, une erreur est générée.

Remarques

Jeu d’API : PowerPointApi 1.3

Exemples

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

Obtient une balise à l’aide de son index de base zéro dans la collection. Une erreur est générée si l’index est hors plage.

getItemAt(index: number): PowerPoint.Tag;

Paramètres

Retours

Balise à l’index donné. Une erreur est générée si l’index est hors plage.

Remarques

Jeu d’API : PowerPointApi 1.3

Obtient une balise à l’aide de son ID unique. Si une telle balise n’existe pas, un objet avec une isNullObject propriété définie sur true est renvoyé. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getItemOrNullObject(key: string): PowerPoint.Tag;

Paramètres

Retours

Balise avec l’ID unique. Si une telle balise n’existe pas, un objet avec une isNullObject propriété définie sur true est renvoyé.

Remarques

Jeu d’API : PowerPointApi 1.3

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine PowerPoint.TagCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) PowerPoint.Interfaces.TagCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): PowerPoint.Interfaces.TagCollectionData;

Retours