Partager via

PowerPoint.CustomXmlPartScopedCollection class

  • Référence
Paquet:
powerpoint

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

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

Obtient le nombre de parties XML personnalisées dans cette collection.
getItem(id)

Obtient un CustomXmlPart en fonction de son ID.
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.stringifyappelle à son tour 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

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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é

PowerPoint.RequestContext

items

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

readonly items: PowerPoint.CustomXmlPart[];

Valeur de propriété

PowerPoint.CustomXmlPart[]

Détails de la méthode

getCount()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Nombre de parties XML personnalisées dans la collection.

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

getItem(id)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient un CustomXmlPart en fonction de son ID.

getItem(id: string): PowerPoint.CustomXmlPart;

Paramètres

id

string

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

Retours

PowerPoint.CustomXmlPart

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

getItemOrNullObject(id)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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.

Retours

PowerPoint.CustomXmlPart

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

getOnlyItem()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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;

Retours

PowerPoint.CustomXmlPart

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

getOnlyItemOrNullObject()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

getOnlyItemOrNullObject(): PowerPoint.CustomXmlPart;

Retours

PowerPoint.CustomXmlPart

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

load(options)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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.

Retours

PowerPoint.CustomXmlPartScopedCollection

load(propertyNames)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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.

Retours

PowerPoint.CustomXmlPartScopedCollection

load(propertyNamesAndPaths)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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.

Retours

PowerPoint.CustomXmlPartScopedCollection

toJSON()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

Retours

PowerPoint.Interfaces.CustomXmlPartScopedCollectionData