Visio.ShapeCollection 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: Visio.Shape[];

Valor da propriedade

Obtém a quantidade de Shapes da coleção.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

Comentários

[ Conjunto de API: 1.1 ]

Exemplos

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const numShapesActivePage = activePage.shapes.getCount();
    return ctx.sync().then(function () {
        console.log("Shapes Count: " + numShapesActivePage.value);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

Obtém uma Forma usando sua chave (nome ou Índice).

getItem(key: number | string): Visio.Shape;

Parâmetros

Retornos

Comentários

[ Conjunto de API: 1.1 ]

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

load(options?: Visio.Interfaces.ShapeCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.ShapeCollection;

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[]): Visio.ShapeCollection;

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): Visio.ShapeCollection;

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 Visio.ShapeCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Visio.Interfaces.ShapeCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): Visio.Interfaces.ShapeCollectionData;

Retornos