PowerPoint.ShapeScopedCollection class
Représente une collection de formes.
- Extends
Remarques
[ Ensemble d’API : PowerPointApi 1.5 ]
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
get |
Obtient le nombre de formes dans la collection. |
get |
Obtient une forme à l’aide de son ID unique. Une erreur est générée si la forme n’existe pas. |
get |
Obtient une forme à l’aide de son index de base zéro dans la collection. Une erreur est générée si l’index est hors limites. |
get |
Obtient une forme à l’aide de son ID unique. Si une telle forme n’existe pas, un objet avec une |
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 |
toJSON() | Remplace la méthode JavaScript |
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é
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: PowerPoint.Shape[];
Valeur de propriété
Détails de la méthode
getCount()
Obtient le nombre de formes dans la collection.
getCount(): OfficeExtension.ClientResult<number>;
Retours
OfficeExtension.ClientResult<number>
Nombre de formes dans la collection.
Remarques
getItem(key)
Obtient une forme à l’aide de son ID unique. Une erreur est générée si la forme n’existe pas.
getItem(key: string): PowerPoint.Shape;
Paramètres
- key
-
string
ID de la forme.
Retours
Forme avec l’ID unique. Si une telle forme n’existe pas, une erreur est générée.
Remarques
getItemAt(index)
Obtient une forme à l’aide de son index de base zéro dans la collection. Une erreur est générée si l’index est hors limites.
getItemAt(index: number): PowerPoint.Shape;
Paramètres
- index
-
number
Index de la forme dans la collection.
Retours
Forme à l’index donné. Une erreur est générée si l’index est hors limites.
Remarques
getItemOrNullObject(id)
Obtient une forme à l’aide de son ID unique. Si une telle forme n’existe pas, un objet avec une isNullObject
propriété définie sur true est retourné.
getItemOrNullObject(id: string): PowerPoint.Shape;
Paramètres
- id
-
string
ID de la forme.
Retours
Forme avec l’ID unique. Si une telle forme n’existe pas, un objet avec une isNullObject
propriété définie sur true est retourné.
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?: PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeScopedCollection;
Paramètres
- options
-
PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
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[]): PowerPoint.ShapeScopedCollection;
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
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): PowerPoint.ShapeScopedCollection;
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
toJSON()
Remplace la méthode JavaScript toJSON()
afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify()
. (JSON.stringify
appelle à son tour la toJSON
méthode de l’objet qui lui est passé.) Alors que l’objet d’origine PowerPoint.ShapeScopedCollection
est un objet API, la toJSON
méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.ShapeScopedCollectionData
que ) 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(): PowerPoint.Interfaces.ShapeScopedCollectionData;