Excel.CustomXmlPartCollection class
Collection de parties XML personnalisées.
- Extends
Remarques
[Jeu d’API : ExcelApi 1.5]
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. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
| add(xml) | Ajoute une nouvelle partie XML personnalisée au classeur. |
| get |
Obtient une nouvelle collection limitée de parties XML personnalisées dont les espaces de noms correspondent à l’espace de noms donné. |
| get |
Obtient le nombre de parties XML personnalisées dans la collection. |
| get |
Obtient une partie XML personnalisée en fonction de son ID. |
| get |
Obtient une partie XML personnalisée en fonction de son ID. Si la n’existe pas, cette méthode renvoie un objet dont la |
| 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. Cette opération connecte le processus du complément à celui 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: Excel.CustomXmlPart[];Valeur de propriété
Détails de la méthode
add(xml)
Ajoute une nouvelle partie XML personnalisée au classeur.
add(xml: string): Excel.CustomXmlPart;Paramètres
- xml
-
string
Contenu XML. Doit être un fragment XML valide.
Retours
Remarques
[Jeu d’API : ExcelApi 1.5]
getByNamespace(namespaceUri)
Obtient une nouvelle collection limitée de parties XML personnalisées dont les espaces de noms correspondent à l’espace de noms donné.
getByNamespace(namespaceUri: string): Excel.CustomXmlPartScopedCollection;Paramètres
- namespaceUri
-
string
Il doit s’agir d’un URI de schéma complet ; Par exemple, "http://schemas.contoso.com/review/1.0" ;.
Retours
Remarques
[Jeu d’API : ExcelApi 1.5]
getCount()
Obtient le nombre de parties XML personnalisées dans la collection.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
[Jeu d’API : ExcelApi 1.5]
getItem(id)
Obtient une partie XML personnalisée en fonction de son ID.
getItem(id: string): Excel.CustomXmlPart;Paramètres
- id
-
string
ID de l’objet à récupérer.
Retours
Remarques
[Jeu d’API : ExcelApi 1.5]
getItemOrNullObject(id)
Obtient une partie XML personnalisée en fonction de son ID. Si la n’existe pas, cette méthode renvoie un objet dont la CustomXmlPart propriété est définie sur true.isNullObject Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getItemOrNullObject(id: string): Excel.CustomXmlPart;Paramètres
- id
-
string
ID de l’objet à récupérer.
Retours
Remarques
[Jeu d’API : ExcelApi 1.5]
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.CustomXmlPartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartCollection;Paramètres
- options
-
Excel.Interfaces.CustomXmlPartCollectionLoadOptions & Excel.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[]): Excel.CustomXmlPartCollection;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
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.CustomXmlPartCollection;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, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.CustomXmlPartCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.CustomXmlPartCollectionDataqui 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.CustomXmlPartCollectionData;