Partager via


PowerPoint.CustomXmlPartScopedCollection class

Collection délimitée de parties XML personnalisées. Une collection délimitée est le résultat d’une opération (comme le filtrage par espace de noms). Une collection délimitée ne peut plus être étendue.

S' étend

Remarques

[ Ensemble d’API : PowerPointApi 1.7 ]

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éthode

getCount()

Obtient le nombre de parties XML personnalisées dans cette collection.

getItem(id)

Obtient un CustomXmlPart en fonction de son ID.

getItemAt(index)

Obtient un CustomXmlPart par son index de base zéro dans la collection. Lève une InvalidArgument exception lorsque l’index est hors limites.

getItemOrNullObject(id)

Obtient un CustomXmlPart en fonction de son ID. Si n’existe CustomXmlPart pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getOnlyItem()

Si la collection contient exactement un élément, cette méthode le renvoie. Si la collection ne contient aucun élément ou plusieurs éléments, cette méthode retourne l’erreur GeneralException .

getOnlyItemOrNullObject()

Si la collection contient exactement un élément, cette méthode le renvoie. Sinon, cette méthode retourne null.

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 PowerPoint.CustomXmlPartScopedCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.CustomXmlPartScopedCollectionDataque ) 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 la propriété

items

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

readonly items: PowerPoint.CustomXmlPart[];

Valeur de la propriété

Détails de la méthode

getCount()

Obtient le nombre de parties XML personnalisées dans cette collection.

getCount(): OfficeExtension.ClientResult<number>;

Retourne

Nombre de parties XML personnalisées dans la collection.

Remarques

[ Ensemble d’API : PowerPointApi 1.7 ]

getItem(id)

Obtient un CustomXmlPart en fonction de son ID.

getItem(id: string): PowerPoint.CustomXmlPart;

Paramètres

id

string

ID de l’objet à récupérer.

Retourne

Remarques

[ Ensemble d’API : PowerPointApi 1.7 ]

getItemAt(index)

Obtient un CustomXmlPart par son index de base zéro dans la collection. Lève une InvalidArgument exception lorsque l’index est hors limites.

getItemAt(index: number): PowerPoint.CustomXmlPart;

Paramètres

index

number

Index de la partie XML personnalisée dans la collection.

Retourne

Partie XML personnalisée à l’index donné.

Remarques

[ Ensemble d’API : PowerPointApi 1.10 ]

getItemOrNullObject(id)

Obtient un CustomXmlPart en fonction de son ID. Si n’existe CustomXmlPart pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;

Paramètres

id

string

ID de l’objet à récupérer.

Retourne

Remarques

[ Ensemble d’API : PowerPointApi 1.7 ]

getOnlyItem()

Si la collection contient exactement un élément, cette méthode le renvoie. Si la collection ne contient aucun élément ou plusieurs éléments, cette méthode retourne l’erreur GeneralException .

getOnlyItem(): PowerPoint.CustomXmlPart;

Retourne

Remarques

[ Ensemble d’API : PowerPointApi 1.7 ]

getOnlyItemOrNullObject()

Si la collection contient exactement un élément, cette méthode le renvoie. Sinon, cette méthode retourne null.

getOnlyItemOrNullObject(): PowerPoint.CustomXmlPart;

Retourne

Remarques

[ Ensemble d’API : PowerPointApi 1.7 ]

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.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartScopedCollection;

Paramètres

options

PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

Retourne

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

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.

Retourne

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

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.

Retourne

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 PowerPoint.CustomXmlPartScopedCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.CustomXmlPartScopedCollectionDataque ) 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.CustomXmlPartScopedCollectionData;

Retourne