Excel.GroupShapeCollection class

  • Référence
Paquet:
excel

Représente la collection de formes à l’intérieur d’un groupe de formes.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Propriétés

context

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

Obtient l’élément enfant chargé dans cette collection de sites.

Méthodes

getCount()

Renvoie le nombre de formes dans le groupe de la forme.
getItem(key)

Obtient une forme à l’aide de son nom ou de son ID.
getItemAt(index)

Obtient une forme en fonction de sa position dans la collection.
getItemOrNullObject(key)

Obtient une forme à l’aide de son nom ou de son ID. Si l’objet shape n’existe pas, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.GroupShapeCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.GroupShapeCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

Détails de la propriété

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é

Excel.RequestContext

items

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Excel.Shape[];

Valeur de propriété

Excel.Shape[]

Détails de la méthode

getCount()

Renvoie le nombre de formes dans le groupe de la forme.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getItem(key)

Obtient une forme à l’aide de son nom ou de son ID.

getItem(key: string): Excel.Shape;

Paramètres

key

string

Nom ou ID de la forme à récupérer.

Retours

Excel.Shape

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getItemAt(index)

Obtient une forme en fonction de sa position dans la collection.

getItemAt(index: number): Excel.Shape;

Paramètres

index

number

Valeur d’index de base zéro de l’objet à récupérer.

Retours

Excel.Shape

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getItemOrNullObject(key)

Obtient une forme à l’aide de son nom ou de son ID. Si l’objet shape n’existe pas, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getItemOrNullObject(key: string): Excel.Shape;

Paramètres

key

string

Nom ou ID de la forme à récupérer.

Retours

Excel.Shape

Remarques

[ Ensemble d’API : ExcelApi 1.14 ]

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.GroupShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.GroupShapeCollection;

Paramètres

options

Excel.Interfaces.GroupShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Retours

Excel.GroupShapeCollection

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

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

Excel.GroupShapeCollection

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?: OfficeExtension.LoadOption): Excel.GroupShapeCollection;

Paramètres

propertyNamesAndPaths
OfficeExtension.LoadOption

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.GroupShapeCollection

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 d’origine Excel.GroupShapeCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.GroupShapeCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Excel.Interfaces.GroupShapeCollectionData;

Retours

Excel.Interfaces.GroupShapeCollectionData