PowerPoint.TagCollection class

Represents the collection of tags.

Extends

Remarks

[ API set: PowerPointApi 1.3 ]

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

items

Gets the loaded child items in this collection.

Methods

add(key, value)

Adds a new tag at the end of the collection. If the key already exists in the collection, the value of the existing tag will be replaced with the given value.

delete(key)

Deletes the tag with the given key in this collection. Does nothing if the key does not exist.

getCount()

Gets the number of tags in the collection.

getItem(key)

Gets a tag using its unique ID. An error is thrown if the tag does not exist.

getItemAt(index)

Gets a tag using its zero-based index in the collection. An error is thrown if the index is out of range.

getItemOrNullObject(key)

Gets a tag using its unique ID. If such a tag does not exist, an object with an isNullObject property set to true is returned.

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original PowerPoint.TagCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.TagCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

items

Gets the loaded child items in this collection.

readonly items: PowerPoint.Tag[];

Property Value

Method Details

add(key, value)

Adds a new tag at the end of the collection. If the key already exists in the collection, the value of the existing tag will be replaced with the given value.

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

Parameters

key

string

The unique ID of a tag, which is unique within this TagCollection. 'key' parameter is case-insensitive, but it is always capitalized when saved in the document.

value

string

The value of the tag.

Returns

void

Remarks

[ API set: PowerPointApi 1.3 ]

Examples

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

Deletes the tag with the given key in this collection. Does nothing if the key does not exist.

delete(key: string): void;

Parameters

key

string

The unique ID of a tag, which is unique within this TagCollection. key parameter is case-insensitive.

Returns

void

Remarks

[ API set: PowerPointApi 1.3 ]

Examples

// 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()

Gets the number of tags in the collection.

getCount(): OfficeExtension.ClientResult<number>;

Returns

The number of tags in the collection.

Remarks

[ API set: PowerPointApi 1.3 ]

getItem(key)

Gets a tag using its unique ID. An error is thrown if the tag does not exist.

getItem(key: string): PowerPoint.Tag;

Parameters

key

string

The ID of the tag. The key parameter is case-sensitive.

Returns

The tag with the unique ID. If such a tag does not exist, an error is thrown.

Remarks

[ API set: PowerPointApi 1.3 ]

Examples

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

Gets a tag using its zero-based index in the collection. An error is thrown if the index is out of range.

getItemAt(index: number): PowerPoint.Tag;

Parameters

index

number

The index of the tag in the collection.

Returns

The tag at the given index. An error is thrown if index is out of range.

Remarks

[ API set: PowerPointApi 1.3 ]

getItemOrNullObject(key)

Gets a tag using its unique ID. If such a tag does not exist, an object with an isNullObject property set to true is returned.

getItemOrNullObject(key: string): PowerPoint.Tag;

Parameters

key

string

The ID of the tag. The key parameter is case-sensitive.

Returns

The tag with the unique ID. If such a tag does not exist, an object with an isNullObject property set to true is returned.

Remarks

[ API set: PowerPointApi 1.3 ]

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

options

PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original PowerPoint.TagCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.TagCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): PowerPoint.Interfaces.TagCollectionData;

Returns