PowerPoint.Tag class

  • Reference
Package:
powerpoint

Represents a single tag in the slide.

Extends
OfficeExtension.ClientObject

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: PowerPoint.TagCollection = context.presentation.tags;
  presentationTags.add("COLOR", "blue");

  await context.sync();

  const tag: PowerPoint.Tag = presentationTags.getItem("COLOR");
  tag.load("key, value");

  await context.sync();

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

Properties

context

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

Gets the unique ID of the tag. The key is unique within the owning TagCollection and always stored as uppercase letters within the document.
value

Gets the value of the tag.

Methods

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.Tag object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.TagData) that contains shallow copies of any loaded child properties from the original object.

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

PowerPoint.RequestContext

key

Gets the unique ID of the tag. The key is unique within the owning TagCollection and always stored as uppercase letters within the document.

readonly key: string;

Property Value

string

Remarks

[ API set: PowerPointApi 1.3 ]

value

Gets the value of the tag.

value: string;

Property Value

string

Remarks

[ API set: PowerPointApi 1.3 ]

Method Details

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.TagLoadOptions): PowerPoint.Tag;

Parameters

options
PowerPoint.Interfaces.TagLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.Tag

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.Tag;

Parameters

propertyNames

string | string[]

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

Returns

PowerPoint.Tag

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?: {
            select?: string;
            expand?: string;
        }): PowerPoint.Tag;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

PowerPoint.Tag

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.Tag object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.TagData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): PowerPoint.Interfaces.TagData;

Returns

PowerPoint.Interfaces.TagData