Compartir a través de

PowerPoint.TagCollection class

  • Referencia
Paquete:
powerpoint

Representa la colección de etiquetas.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: PowerPointApi 1.3 ]

Ejemplos

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

Propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
items

Obtiene los elementos secundarios cargados en esta colección.

Métodos

add(key, value)

Agrega una nueva etiqueta al final de la colección. Si ya key existe en la colección, el valor de la etiqueta existente se reemplazará por el especificado value.
delete(key)

Elimina la etiqueta con la especificada key en esta colección. No hace nada si key no existe.
getCount()

Obtiene el número de etiquetas de la colección.
getItem(key)

Obtiene una etiqueta con su identificador único. Se produce un error si la etiqueta no existe.
getItemAt(index)

Obtiene una etiqueta mediante su índice de base cero en la colección. Se produce un error si el índice está fuera del intervalo.
getItemOrNullObject(key)

Obtiene una etiqueta con su identificador único. Si dicha etiqueta no existe, se devuelve un objeto con una isNullObject propiedad establecida en true.
load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.TagCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.TagCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

PowerPoint.RequestContext

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: PowerPoint.Tag[];

Valor de propiedad

PowerPoint.Tag[]

Detalles del método

add(key, value)

Agrega una nueva etiqueta al final de la colección. Si ya key existe en la colección, el valor de la etiqueta existente se reemplazará por el especificado value.

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

Parámetros

key

string

Identificador único de una etiqueta, que es único dentro de este TagCollection. El parámetro "key" no distingue mayúsculas de minúsculas, pero siempre tiene mayúsculas y minúsculas cuando se guarda en el documento.

value

string

Valor de la etiqueta.

Devoluciones

void

Comentarios

[ Conjunto de API: PowerPointApi 1.3 ]

Ejemplos

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

Elimina la etiqueta con la especificada key en esta colección. No hace nada si key no existe.

delete(key: string): void;

Parámetros

key

string

Identificador único de una etiqueta, que es único dentro de este TagCollection. key el parámetro no distingue mayúsculas de minúsculas.

Devoluciones

void

Comentarios

[ Conjunto de API: PowerPointApi 1.3 ]

Ejemplos

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

Obtiene el número de etiquetas de la colección.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

OfficeExtension.ClientResult<number>

Número de etiquetas de la colección.

Comentarios

[ Conjunto de API: PowerPointApi 1.3 ]

getItem(key)

Obtiene una etiqueta con su identificador único. Se produce un error si la etiqueta no existe.

getItem(key: string): PowerPoint.Tag;

Parámetros

key

string

Identificador de la etiqueta.

Devoluciones

PowerPoint.Tag

Etiqueta con el identificador único. Si dicha etiqueta no existe, se produce un error.

Comentarios

[ Conjunto de API: PowerPointApi 1.3 ]

Ejemplos

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

Obtiene una etiqueta mediante su índice de base cero en la colección. Se produce un error si el índice está fuera del intervalo.

getItemAt(index: number): PowerPoint.Tag;

Parámetros

index

number

Índice de la etiqueta de la colección.

Devoluciones

PowerPoint.Tag

Etiqueta en el índice especificado. Se produce un error si el índice está fuera del intervalo.

Comentarios

[ Conjunto de API: PowerPointApi 1.3 ]

getItemOrNullObject(key)

Obtiene una etiqueta con su identificador único. Si dicha etiqueta no existe, se devuelve un objeto con una isNullObject propiedad establecida en true.

getItemOrNullObject(key: string): PowerPoint.Tag;

Parámetros

key

string

Identificador de la etiqueta.

Devoluciones

PowerPoint.Tag

Etiqueta con el identificador único. Si dicha etiqueta no existe, se devuelve un objeto con una isNullObject propiedad establecida en true.

Comentarios

[ Conjunto de API: PowerPointApi 1.3 ]

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

options

PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

PowerPoint.TagCollection

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

PowerPoint.TagCollection

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

PowerPoint.TagCollection

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.TagCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.TagCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): PowerPoint.Interfaces.TagCollectionData;

Devoluciones

PowerPoint.Interfaces.TagCollectionData