PowerPoint.ShapeScopedCollection class

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

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

readonly items: PowerPoint.Shape[];

Valor da propriedade

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

getCount(): OfficeExtension.ClientResult<number>;

Retornos

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

Comentários

Conjunto de API: PowerPointApi 1.5

Exemplos

// 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>";
  const outputSpan = document.getElementById("outputSpan");
  outputSpan.innerHTML = "";
  outputSpan.innerHTML += finalTable;
});

Obtém uma forma com o respetivo ID exclusivo. É apresentado um erro se a forma não existir.

getItem(key: string): PowerPoint.Shape;

Parâmetros

Retornos

A forma com o ID exclusivo. Se tal forma não existir, é gerado um erro.

Comentários

Conjunto de API: PowerPointApi 1.5

Obtém uma forma com o respetivo índice baseado em zero na coleção. É gerado um erro se o índice estiver fora do intervalo.

getItemAt(index: number): PowerPoint.Shape;

Parâmetros

Retornos

A forma no índice especificado. É apresentado um erro se o índice estiver fora do intervalo.

Comentários

Conjunto de API: PowerPointApi 1.5

Obtém uma forma com o respetivo ID exclusivo. Se tal forma não existir, é devolvido um objeto com uma isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getItemOrNullObject(id: string): PowerPoint.Shape;

Parâmetros

Retornos

A forma com o ID exclusivo. Se tal forma não existir, é devolvido um objeto com uma isNullObject propriedade definida como true.

Comentários

Conjunto de API: PowerPointApi 1.5

Exemplos

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

// Uses getItemOrNullObject to find a shape by ID within the selected shapes.
// If the ID is not found in the selected shapes, the returned object's isNullObject property is true.
await PowerPoint.run(async (context) => {
  const shapeId = (document.getElementById("shape-id-input") as HTMLInputElement).value.trim();
  if (!shapeId) {
    console.log("Enter a shape ID in the text box first.");
    return;
  }

  const selectedShapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();

  // getItemOrNullObject returns a Shape object without throwing if the ID isn't found.
  const shape: PowerPoint.Shape = selectedShapes.getItemOrNullObject(shapeId);
  shape.load("id,name,type");
  await context.sync();

  if (shape.isNullObject) {
    console.log(`Shape ID "${shapeId}" was not found in the selected shapes.`);
  } else {
    console.log(`Shape found in the selected shapes.`);
    console.log(`  ID: ${shape.id}`);
    console.log(`  Name: "${shape.name}"`);
    console.log(`  Type: ${shape.type}`);
  }
});

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

Parâmetros

Retornos

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

Parâmetros

Retornos

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

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.ShapeScopedCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.ShapeScopedCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;

Retornos