Visio.Shape class
Représente la classe Shape.
- Extends
Remarques
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. |
| shape |
Renvoie la section de données de l’objet Shape. |
| sub |
Obtient la collection SubShape. |
| text | Texte de la forme. |
| view | Renvoie l’affichage de la forme. |
Méthodes
| get |
Renvoie l’objet AbsoluteBoundingBox qui spécifie le cadre englobant absolu de la forme. |
| get |
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 |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| 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. |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
comments
Renvoie la collection de commentaires.
readonly comments: Visio.CommentCollection;Valeur de propriété
Remarques
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é
hyperlinks
Renvoie la collection Hyperlinks d’un objet Shape.
readonly hyperlinks: Visio.HyperlinkCollection;Valeur de propriété
Remarques
id
Identificateur de la forme.
readonly id: number;Valeur de propriété
number
Remarques
name
Nom de l’objet Shape.
readonly name: string;Valeur de propriété
string
Remarques
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
shapeDataItems
Renvoie la section de données de l’objet Shape.
readonly shapeDataItems: Visio.ShapeDataItemCollection;Valeur de propriété
Remarques
subShapes
Obtient la collection SubShape.
readonly subShapes: Visio.ShapeCollection;Valeur de propriété
Remarques
text
Texte de la forme.
readonly text: string;Valeur de propriété
string
Remarques
view
Renvoie l’affichage de la forme.
readonly view: Visio.ShapeView;Valeur de propriété
Remarques
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
Remarques
getBounds()
Renvoie l’objet BoundingBox qui spécifie le cadre englobant de la forme.
getBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;Retours
Remarques
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
Fournit des options pour les propriétés de l’objet à charger.
Retours
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
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
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
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;