PowerPoint.TagCollection class

Référence

Paquet:: powerpoint

Représente la collection de balises.

Extends: OfficeExtension.ClientObject

Remarques

Propriétés

context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
items	Obtient l’élément enfant chargé dans cette collection de sites.

Méthodes

add(key, value)	Ajoute une nouvelle balise à la fin de la collection. Si la clé existe déjà dans la collection, la valeur de la balise existante est remplacée par le donné `value`.
delete(key)	Supprime la balise avec la clé donnée dans cette collection. Ne fait rien si la clé n’existe pas.
getCount()	Obtient le nombre de balises dans la collection.
getItem(key)	Obtient une balise à l’aide de son ID unique. Une erreur est générée si la balise n’existe pas.
getItemAt(index)	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 limites.
getItemOrNullObject(key)	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 retourné.
load(options)	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)	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)	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.
toJSON()	Remplace la méthode JavaScript `toJSON()` afin de fournir une sortie plus utile lorsqu’un objet API est passé à `JSON.stringify()`. (`JSON.stringify`appelle à son tour 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 brut (typé en tant `PowerPoint.Interfaces.TagCollectionData`que ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

Détails de la propriété

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

PowerPoint.RequestContext

items

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

readonly items: PowerPoint.Tag[];

Valeur de propriété

PowerPoint.Tag[]

Détails de la méthode

add(key, value)

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

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

Paramètres

key: string

ID unique d’une balise, qui est unique dans ce TagCollection. La chaîne de clé est en majuscule lorsqu’elle est enregistrée dans le document.

value: string

Valeur de la balise.

Retours

void

Remarques

[ Ensemble 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 = 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)

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

delete(key: string): void;

Paramètres

key: string

ID unique d’une balise, qui est unique dans ce TagCollection. Ce paramètre ne respecte pas la casse.

Retours

void

Remarques

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

  presentationTags.delete("COLOR");

  await context.sync();

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

getCount()

Obtient le nombre de balises dans la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Nombre de balises dans la collection.

Remarques

[ Ensemble d’API : PowerPointApi 1.3 ]

getItem(key)

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

key: string

ID de la balise. L’ID respecte la casse et doit être en majuscules.

Retours

PowerPoint.Tag

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

Remarques

[ Ensemble 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 = 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)

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 limites.

getItemAt(index: number): PowerPoint.Tag;

Paramètres

index: number

Index de la balise dans la collection.

Retours

PowerPoint.Tag

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

Remarques

[ Ensemble d’API : PowerPointApi 1.3 ]

getItemOrNullObject(key)

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 retourné.

getItemOrNullObject(key: string): PowerPoint.Tag;

Paramètres

key: string

ID de la balise. L’ID respecte la casse et doit être en majuscules.

Retours

PowerPoint.Tag

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

Remarques

[ Ensemble d’API : PowerPointApi 1.3 ]

load(options)

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

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

Fournit des options pour les propriétés de l’objet à charger.

Retours

PowerPoint.TagCollection

load(propertyNames)

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

propertyNames: string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

PowerPoint.TagCollection

load(propertyNamesAndPaths)

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

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

PowerPoint.TagCollection

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour 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 brut (typé en tant PowerPoint.Interfaces.TagCollectionDataque ) qui 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

PowerPoint.Interfaces.TagCollectionData

PowerPoint.TagCollection class

Remarques

Propriétés

Méthodes

Détails de la propriété

context

Valeur de propriété

items

Valeur de propriété

Détails de la méthode

add(key, value)

Paramètres

Retours

Remarques

Exemples

delete(key)

Paramètres

Retours

Remarques

Exemples

getCount()

Retours

Remarques

getItem(key)

Paramètres

Retours

Remarques

Exemples

getItemAt(index)

Paramètres

Retours

Remarques

getItemOrNullObject(key)

Paramètres

Retours

Remarques

load(options)

Paramètres

Retours

load(propertyNames)

Paramètres

Retours

load(propertyNamesAndPaths)

Paramètres

Retours

toJSON()

Retours

Commentaires

Ressources supplémentaires