Compartilhar via

PowerPoint.ShapeGroup class

  • Referência
Pacote:
powerpoint

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa um grupo de formas dentro de uma apresentação. Para obter o objeto Forma correspondente, utilize ShapeGroup.shape.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Propriedades

context

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

Obtém o ID exclusivo do grupo de formas.
shape

Devolve o Shape objeto associado ao grupo.
shapes

Devolve a coleção de Shape objetos no grupo.

Métodos

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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.ShapeGroup é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.ShapeGroupData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
ungroup()

Desagrupa todas as formas agrupadas no grupo de forma especificado.

Detalhes da propriedade

context

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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

PowerPoint.RequestContext

id

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém o ID exclusivo do grupo de formas.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

shape

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Devolve o Shape objeto associado ao grupo.

readonly shape: PowerPoint.Shape;

Valor da propriedade

PowerPoint.Shape

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

shapes

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Devolve a coleção de Shape objetos no grupo.

readonly shapes: PowerPoint.ShapeScopedCollection;

Valor da propriedade

PowerPoint.ShapeScopedCollection

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Detalhes do método

load(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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.ShapeGroupLoadOptions): PowerPoint.ShapeGroup;

Parâmetros

options
PowerPoint.Interfaces.ShapeGroupLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

PowerPoint.ShapeGroup

load(propertyNames)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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

Parâmetros

propertyNames

string | string[]

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

Retornos

PowerPoint.ShapeGroup

load(propertyNamesAndPaths)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.ShapeGroup;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

Retornos

PowerPoint.ShapeGroup

toJSON()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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.ShapeGroup é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.ShapeGroupData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): PowerPoint.Interfaces.ShapeGroupData;

Retornos

PowerPoint.Interfaces.ShapeGroupData

ungroup()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Desagrupa todas as formas agrupadas no grupo de forma especificado.

ungroup(): void;

Retornos

void

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]