Compartir a través de

PowerPoint.ShapeScopedCollection class

  • Referencia
Paquete:
powerpoint

Representa una colección de formas.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: PowerPointApi 1.5 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml

// Changes the selected shapes fill color to red.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  shapes.items.map((shape) => {
    shape.fill.setSolidColor("red");
  });
  await context.sync();
});

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

getCount()

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

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

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

Obtiene una forma con su identificador único. Si dicha forma 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.ShapeScopedCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.ShapeScopedCollectionData) 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.Shape[];

Valor de propiedad

PowerPoint.Shape[]

Detalles del método

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

OfficeExtension.ClientResult<number>

Número de formas de la colección.

Comentarios

[ Conjunto de API: PowerPointApi 1.5 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml

// Gets the shapes you selected on the slide and displays their IDs on the task pane.
await PowerPoint.run(async (context) => {
  let finalTable = "";
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  await context.sync();
  finalTable += "<br>getSelectedShapes.getCount returned:<b>" + shapeCount.value + "</b><br>";
  finalTable +=
    "<br><table border=1 cellpadding=3 cellspacing=0><tr><td bgcolor=#3333EE><font color=white>Index</font></td><td bgcolor=#3333EE><font color=white>Id</font></td></tr>";
  shapes.load("items");
  await context.sync();
  shapes.items.map((shape, index) => {
    finalTable += "<tr><td>" + index + "</td><td>" + shape.id + "</td></tr>";
  });
  finalTable += "</table>";
  $("#outputSpan").empty();
  $("#outputSpan").append(finalTable);
});

getItem(key)

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

getItem(key: string): PowerPoint.Shape;

Parámetros

key

string

Identificador de la forma.

Devoluciones

PowerPoint.Shape

Forma con el identificador único. Si dicha forma no existe, se produce un error.

Comentarios

[ Conjunto de API: PowerPointApi 1.5 ]

getItemAt(index)

Obtiene una forma 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.Shape;

Parámetros

index

number

Índice de la forma de la colección.

Devoluciones

PowerPoint.Shape

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

Comentarios

[ Conjunto de API: PowerPointApi 1.5 ]

getItemOrNullObject(id)

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

getItemOrNullObject(id: string): PowerPoint.Shape;

Parámetros

id

string

Identificador de la forma.

Devoluciones

PowerPoint.Shape

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

Comentarios

[ Conjunto de API: PowerPointApi 1.5 ]

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.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeScopedCollection;

Parámetros

options

PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

Devoluciones

PowerPoint.ShapeScopedCollection

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

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.ShapeScopedCollection

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

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.ShapeScopedCollection

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.ShapeScopedCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.ShapeScopedCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;

Devoluciones

PowerPoint.Interfaces.ShapeScopedCollectionData