Excel.ShapeGroup class

Package:
excel

Représente un groupe de formes à l’intérieur d’une feuille de calcul. Pour obtenir l’objet correspondant Shape , utilisez ShapeGroup.shape.

Extends
OfficeExtension.ClientObject

Remarques

[Jeu d’API : ExcelApi 1.9]

Propriétés

context

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

Spécifie l’identificateur de forme.
shape

Renvoie l’objet Shape associé au groupe.
shapes

Renvoie l’ensemble des Shape objets.

Méthodes

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.
toJSON()

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 d’origine Excel.ShapeGroup est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ShapeGroupDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
ungroup()

Dissocie toutes les formes groupées dans la forme spécifiée.

Détails de la propriété

context

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é

Excel.RequestContext

id

Spécifie l’identificateur de forme.

readonly id: string;

Valeur de propriété

string

Remarques

[Jeu d’API : ExcelApi 1.9]

shape

Renvoie l’objet Shape associé au groupe.

readonly shape: Excel.Shape;

Valeur de propriété

Excel.Shape

Remarques

[Jeu d’API : ExcelApi 1.9]

shapes

Renvoie l’ensemble des Shape objets.

readonly shapes: Excel.GroupShapeCollection;

Valeur de propriété

Excel.GroupShapeCollection

Remarques

[Jeu d’API : ExcelApi 1.9]

Détails de la méthode

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?: Excel.Interfaces.ShapeGroupLoadOptions): Excel.ShapeGroup;

Paramètres

options
Excel.Interfaces.ShapeGroupLoadOptions

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

Retours

Excel.ShapeGroup

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[]): Excel.ShapeGroup;

Paramètres

propertyNames

string | string[]

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

Retours

Excel.ShapeGroup

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;
        }): Excel.ShapeGroup;

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

Excel.ShapeGroup

toJSON()

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 d’origine Excel.ShapeGroup est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ShapeGroupDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.ShapeGroupData;

Retours

Excel.Interfaces.ShapeGroupData

ungroup()

Dissocie toutes les formes groupées dans la forme spécifiée.

ungroup(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.9]