Visio.ShapeCollection class

Pacote:

visio

Representa a Coleção de Formas.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: 1.1 ]

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.
items	Obtém os itens filhos carregados nesta coleção.

Métodos

getCount()	Obtém a quantidade de Shapes da coleção.
getItem(key)	Obtém uma Forma usando sua chave (nome ou Índice).
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 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.

Detalhes da propriedade

context

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

Visio.RequestContext

items

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

readonly items: Visio.Shape[];

Valor da propriedade

Visio.Shape[]

Detalhes do método

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

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

getItem(key)

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

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

Parâmetros

key

number | string

A chave é o Nome ou Índice do Hiperlink a ser recuperado.

Retornos

Visio.Shape

Comentários

[ Conjunto de API: 1.1 ]

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(options?: Visio.Interfaces.ShapeCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.ShapeCollection;

Parâmetros

options

Visio.Interfaces.ShapeCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions

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

Retornos

Visio.ShapeCollection

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

Parâmetros

propertyNames

string | string[]

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

Retornos

Visio.ShapeCollection

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

OfficeExtension.LoadOption

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

Visio.ShapeCollection

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

Visio.Interfaces.ShapeCollectionData