Visio.Shape class

Retorna a Coleção de Comentários.

readonly comments: Visio.CommentCollection;

Valor da propriedade

Comentários

Conjunto de APIs: 1.1

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Retorna a coleção de Hiperlinks para um objeto Forma.

readonly hyperlinks: Visio.HyperlinkCollection;

Valor da propriedade

Comentários

Conjunto de APIs: 1.1

Identificador da forma.

readonly id: number;

Valor da propriedade

Comentários

Conjunto de APIs: 1.1

Nome da Shape.

readonly name: string;

Valor da propriedade

Comentários

Conjunto de APIs: 1.1

Retorna verdadeiro, se a forma estiver selecionada. O usuário pode definir como verdadeiro para selecionar a forma explicitamente.

select: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: 1.1

Retorna a Seção de Dados da Shape.

readonly shapeDataItems: Visio.ShapeDataItemCollection;

Valor da propriedade

Comentários

Conjunto de APIs: 1.1

Obtém a Coleção SubShape.

readonly subShapes: Visio.ShapeCollection;

Valor da propriedade

Comentários

Conjunto de APIs: 1.1

Texto da forma.

readonly text: string;

Valor da propriedade

Comentários

Conjunto de APIs: 1.1

Retorna a visualização da forma.

readonly view: Visio.ShapeView;

Valor da propriedade

Comentários

Conjunto de APIs: 1.1

Retorna o objeto AbsoluteBoundingBox que especifica a caixa delimitadora absoluta da forma.

getAbsoluteBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;

Retornos

Comentários

Conjunto de APIs: 1.1

Retorna o objeto BoundingBox que especifica a caixa delimitadora da forma.

getBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;

Retornos

Comentários

Conjunto de APIs: 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.ShapeLoadOptions): Visio.Shape;

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

Parâmetros

Retornos

Exemplos

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shapeName = "Sample Name";
    const shape = activePage.shapes.getItem(shapeName);
    shape.load(["name", "id", "text", "select"]);
    return ctx.sync().then(function () {
        console.log(shape.name);
        console.log(shape.id);
        console.log(shape.text);
        console.log(shape.select);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    shape.view.highlight = { color: "#E7E7E7", width: 100 };
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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

Parâmetros

Retornos

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Visio.Shape): void;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Visio.Shape original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Visio.Interfaces.ShapeData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Visio.Interfaces.ShapeData;

Retornos