PowerPoint.TagCollection class

Referência

Pacote:: powerpoint

Representa a coleção de marcas.

Extends: OfficeExtension.ClientObject

Comentários

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
items	Obtém os itens filhos carregados nesta coleção.

Métodos

add(key, value)	Adiciona uma nova marca no final da coleção. Se a chave já existir na coleção, o valor da marca existente será substituído pelo determinado `value`.
delete(key)	Exclui a marca com a chave fornecida nesta coleção. Não fará nada se a chave não existir.
getCount()	Obtém o número de marcas na coleção.
getItem(key)	Obtém uma marca usando sua ID exclusiva. Um erro será gerado se a marca não existir.
getItemAt(index)	Obtém uma marca usando seu índice baseado em zero na coleção. Um erro será gerado se o índice estiver fora do intervalo.
getItemOrNullObject(key)	Obtém uma marca usando sua ID exclusiva. Se essa marca não existir, um objeto com uma `isNullObject` propriedade definida como true será retornado.
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é passado para `JSON.stringify()`. (`JSON.stringify`por sua vez, chama o `toJSON` método do objeto que é passado para ele.) Considerando que o objeto original `PowerPoint.TagCollection` é um objeto API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `PowerPoint.Interfaces.TagCollectionData`) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

PowerPoint.RequestContext

items

Obtém os itens filhos carregados nesta coleção.

readonly items: PowerPoint.Tag[];

Valor da propriedade

PowerPoint.Tag[]

Detalhes do método

add(key, value)

Adiciona uma nova marca no final da coleção. Se a chave já existir na coleção, o valor da marca existente será substituído pelo determinado value.

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

Parâmetros

key: string

A ID exclusiva de uma marca, que é exclusiva dentro deste TagCollection. A cadeia de caracteres de chave é maiúscula quando salva no documento.

value: string

O valor da marca.

Retornos

void

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

Exemplos

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

Exclui a marca com a chave fornecida nesta coleção. Não fará nada se a chave não existir.

delete(key: string): void;

Parâmetros

key: string

A ID exclusiva de uma marca, que é exclusiva dentro deste TagCollection. Esse parâmetro é insensível a casos.

Retornos

void

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

Exemplos

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

Obtém o número de marcas na coleção.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

O número de marcas na coleção.

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

getItem(key)

Obtém uma marca usando sua ID exclusiva. Um erro será gerado se a marca não existir.

getItem(key: string): PowerPoint.Tag;

Parâmetros

key: string

A ID da marca. A ID é sensível a casos e deve ser maiúscula.

Retornos

PowerPoint.Tag

A marca com a ID exclusiva. Se essa marca não existir, um erro será gerado.

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

Exemplos

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

Obtém uma marca usando seu índice baseado em zero na coleção. Um erro será gerado se o índice estiver fora do intervalo.

getItemAt(index: number): PowerPoint.Tag;

Parâmetros

index: number

O índice da marca na coleção.

Retornos

PowerPoint.Tag

A marca no índice determinado. Um erro será gerado se o índice estiver fora do intervalo.

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

getItemOrNullObject(key)

Obtém uma marca usando sua ID exclusiva. Se essa marca não existir, um objeto com uma isNullObject propriedade definida como true será retornado.

getItemOrNullObject(key: string): PowerPoint.Tag;

Parâmetros

key: string

A ID da marca. A ID é sensível a casos e deve ser maiúscula.

Retornos

PowerPoint.Tag

A marca com a ID exclusiva. Se essa marca não existir, um objeto com uma isNullObject propriedade definida como true será retornado.

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

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

Fornece opções para quais propriedades do objeto carregar.

Retornos

PowerPoint.TagCollection

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames: string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

PowerPoint.TagCollection

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

PowerPoint.TagCollection

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Considerando que o objeto original PowerPoint.TagCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.TagCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): PowerPoint.Interfaces.TagCollectionData;

Retornos

PowerPoint.Interfaces.TagCollectionData

Share via

PowerPoint.TagCollection class

Comentários

Propriedades

Métodos

Detalhes da propriedade

context

Valor da propriedade

items

Valor da propriedade

Detalhes do método

add(key, value)

Parâmetros

Retornos

Comentários

Exemplos

delete(key)

Parâmetros

Retornos

Comentários

Exemplos

getCount()

Retornos

Comentários

getItem(key)

Parâmetros

Retornos

Comentários

Exemplos

getItemAt(index)

Parâmetros

Retornos

Comentários

getItemOrNullObject(key)

Parâmetros

Retornos

Comentários

load(options)

Parâmetros

Retornos

load(propertyNames)

Parâmetros

Retornos

load(propertyNamesAndPaths)

Parâmetros

Retornos

toJSON()

Retornos

Comentários

Recursos adicionais