Visio.Shape class

Paquet:

visio

Représente la classe Shape.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : 1.1 ]

Propriétés

comments	Renvoie la collection de commentaires.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
hyperlinks	Renvoie la collection Hyperlinks d’un objet Shape.
id	Identificateur de la forme.
name	Nom de l’objet Shape.
select	Renvoie True si l’objet Shape est sélectionné. L’utilisateur peut le définir sur True pour sélectionner explicitement l’objet Shape.
shapeDataItems	Renvoie la section de données de l’objet Shape.
subShapes	Obtient la collection SubShape.
text	Texte de la forme.
view	Renvoie l’affichage de la forme.

Méthodes

getAbsoluteBounds()	Renvoie l’objet AbsoluteBoundingBox qui spécifie le cadre englobant absolu de la forme.
getBounds()	Renvoie l’objet BoundingBox qui spécifie le cadre englobant de la forme.
load(options)	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)	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)	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.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
setMockData(data)	Définir des données fictives
toJSON()	Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Visio.Shape d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Visio.Interfaces.ShapeDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

comments

Renvoie la collection de commentaires.

readonly comments: Visio.CommentCollection;

Valeur de propriété

Visio.CommentCollection

Remarques

[ Ensemble d’API : 1.1 ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Visio.RequestContext

hyperlinks

Renvoie la collection Hyperlinks d’un objet Shape.

readonly hyperlinks: Visio.HyperlinkCollection;

Valeur de propriété

Visio.HyperlinkCollection

Remarques

[ Ensemble d’API : 1.1 ]

id

Identificateur de la forme.

readonly id: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : 1.1 ]

name

Nom de l’objet Shape.

readonly name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : 1.1 ]

select

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é

boolean

Remarques

[ Ensemble d’API : 1.1 ]

shapeDataItems

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

readonly shapeDataItems: Visio.ShapeDataItemCollection;

Valeur de propriété

Visio.ShapeDataItemCollection

Remarques

[ Ensemble d’API : 1.1 ]

subShapes

Obtient la collection SubShape.

readonly subShapes: Visio.ShapeCollection;

Valeur de propriété

Visio.ShapeCollection

Remarques

[ Ensemble d’API : 1.1 ]

text

Texte de la forme.

readonly text: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : 1.1 ]

view

Renvoie l’affichage de la forme.

readonly view: Visio.ShapeView;

Valeur de propriété

Visio.ShapeView

Remarques

[ Ensemble d’API : 1.1 ]

Détails de la méthode

getAbsoluteBounds()

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

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

Retours

OfficeExtension.ClientResult<Visio.BoundingBox>

Remarques

[ Ensemble d’API : 1.1 ]

getBounds()

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

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

Retours

OfficeExtension.ClientResult<Visio.BoundingBox>

Remarques

[ Ensemble d’API : 1.1 ]

load(options)

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

options

Visio.Interfaces.ShapeLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Visio.Shape

load(propertyNames)

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

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Visio.Shape

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

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

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

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Visio.Shape

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

properties

Visio.Interfaces.ShapeUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options

OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

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

properties

Visio.Shape

Retours

void

setMockData(data)

Définir des données fictives

setMockData(data: Visio.Interfaces.ShapeData): void;

Paramètres

data

Visio.Interfaces.ShapeData

Retours

void

toJSON()

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

toJSON(): Visio.Interfaces.ShapeData;

Retours

Visio.Interfaces.ShapeData