PowerPoint.TagCollection class

Представляет коллекцию тегов.

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

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
items	Получает загруженные дочерние элементы в этой коллекции.

Методы

add(key, value)	Добавляет новый тег в конце коллекции. Если он `key` уже существует в коллекции, значение существующего тега будет заменено на заданное `value`.
delete(key)	Удаляет тег с указанным `key` в этой коллекции. Ничего не делает, если его `key` не существует.
getCount()	Получает количество тегов в коллекции.
getItem(key)	Получает тег по своему уникальному идентификатору. Если тег не существует, возникает ошибка.
getItemAt(index)	Получает тег с использованием отсчитываемого от нуля индекса в коллекции. Если индекс находится за пределами допустимого диапазона, возникает ошибка.
getItemOrNullObject(key)	Получает тег по своему уникальному идентификатору. Если такого тега нет, возвращается объект со свойством `isNullObject` true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `PowerPoint.TagCollection` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `PowerPoint.Interfaces.TagCollectionData`), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

PowerPoint.RequestContext

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: PowerPoint.Tag[];

Значение свойства

PowerPoint.Tag[]

add(key, value)

Добавляет новый тег в конце коллекции. Если он key уже существует в коллекции, значение существующего тега будет заменено на заданное value.

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

Параметры

key: string

Уникальный идентификатор тега, который является уникальным в этом TagCollectionдомене Параметр 'key' не чувствителен к регистру, но всегда пишется с заглавной буквы при сохранении в документе.

value: string

Значение тега.

Возвращаемое значение

void

Примеры

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

delete(key)

Удаляет тег с указанным key в этой коллекции. Ничего не делает, если его key не существует.

delete(key: string): void;

Параметры

key: string

Уникальный идентификатор тега, который является уникальным в этом TagCollectionдомене key без учета регистра.

Возвращаемое значение

void

Примеры

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

getCount()

Получает количество тегов в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество тегов в коллекции.

getItem(key)

Получает тег по своему уникальному идентификатору. Если тег не существует, возникает ошибка.

getItem(key: string): PowerPoint.Tag;

Параметры

key: string

Идентификатор тега.

Возвращаемое значение

PowerPoint.Tag

Тег с уникальным идентификатором. Если такого тега нет, выводится сообщение об ошибке.

Примеры

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

getItemAt(index)

Получает тег с использованием отсчитываемого от нуля индекса в коллекции. Если индекс находится за пределами допустимого диапазона, возникает ошибка.

getItemAt(index: number): PowerPoint.Tag;

Параметры

index: number

Индекс тега в коллекции.

Возвращаемое значение

PowerPoint.Tag

Тег в заданном индексе. Если индекс выходит за пределы допустимого диапазона, возникает ошибка.

getItemOrNullObject(key)

Получает тег по своему уникальному идентификатору. Если такого тега нет, возвращается объект со свойством isNullObject true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(key: string): PowerPoint.Tag;

Параметры

key: string

Идентификатор тега.

Возвращаемое значение

PowerPoint.Tag

Тег с уникальным идентификатором. Если такого тега нет, возвращается объект со свойством isNullObject true.

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

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

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

PowerPoint.TagCollection

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

Возвращаемое значение

PowerPoint.TagCollection

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

Возвращаемое значение

PowerPoint.TagCollection

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.TagCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как PowerPoint.Interfaces.TagCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

toJSON(): PowerPoint.Interfaces.TagCollectionData;

Возвращаемое значение

PowerPoint.Interfaces.TagCollectionData

Комментарии

Используется

Примеры

Свойства

Методы

Сведения о свойстве

context

Значение свойства

items

Значение свойства

Сведения о методе

add(key, value)

Параметры

Возвращаемое значение

Комментарии

Примеры

delete(key)

Параметры

Возвращаемое значение

Комментарии

Примеры

getCount()

Возвращаемое значение

Комментарии

getItem(key)

Параметры

Возвращаемое значение

Комментарии

Примеры

getItemAt(index)

Параметры

Возвращаемое значение

Комментарии

getItemOrNullObject(key)

Параметры

Возвращаемое значение

Комментарии

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

toJSON()

Возвращаемое значение

Обратная связь