Visio.Shape class

Renvoie la collection de commentaires.

readonly comments: Visio.CommentCollection;

Valeur de propriété

Remarques

Jeu d’API : 1.1

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Renvoie la collection Hyperlinks d’un objet Shape.

readonly hyperlinks: Visio.HyperlinkCollection;

Valeur de propriété

Remarques

Jeu d’API : 1.1

Identificateur de la forme.

readonly id: number;

Valeur de propriété

Remarques

Jeu d’API : 1.1

Nom de l’objet Shape.

readonly name: string;

Valeur de propriété

Remarques

Jeu d’API : 1.1

Renvoie True si l’objet Shape est sélectionné. L’utilisateur peut le définir sur True pour sélectionner explicitement l’objet Shape.

select: boolean;

Valeur de propriété

Remarques

Jeu d’API : 1.1

Renvoie la section de données de l’objet Shape.

readonly shapeDataItems: Visio.ShapeDataItemCollection;

Valeur de propriété

Remarques

Jeu d’API : 1.1

Obtient la collection SubShape.

readonly subShapes: Visio.ShapeCollection;

Valeur de propriété

Remarques

Jeu d’API : 1.1

Texte de la forme.

readonly text: string;

Valeur de propriété

Remarques

Jeu d’API : 1.1

Renvoie l’affichage de la forme.

readonly view: Visio.ShapeView;

Valeur de propriété

Remarques

Jeu d’API : 1.1

Renvoie l’objet AbsoluteBoundingBox qui spécifie le cadre de sélection absolu de la forme.

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

Retours

Remarques

Jeu d’API : 1.1

Renvoie l’objet BoundingBox qui spécifie le cadre englobant de la forme.

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

Retours

Remarques

Jeu d’API : 1.1

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Visio.Interfaces.ShapeLoadOptions): Visio.Shape;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Visio.Shape;

Paramètres

Retours

Exemples

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

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Visio.Shape;

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

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

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Visio.Shape): void;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Visio.Shape d’origine est un objet API, la méthode renvoie un objet JavaScript simple (dont le toJSON type Visio.Interfaces.ShapeDataest ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Visio.Interfaces.ShapeData;

Retours