Excel.CustomXmlPart class
Représente un objet de composant XML personnalisé dans un classeur.
- 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. |
| id | ID de la partie XML personnalisée. |
| namespace |
URI de l’espace de noms de la partie XML personnalisée. |
Méthodes
| delete() | Supprime la partie XML personnalisée. |
| get |
Obtient l’intégralité du contenu XML de la partie XML personnalisée. |
| 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 |
| set |
Définit l’intégralité du contenu XML de la partie XML personnalisée. |
| 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é
id
ID de la partie XML personnalisée.
readonly id: string;Valeur de propriété
string
Remarques
[Jeu d’API : ExcelApi 1.5]
namespaceUri
URI de l’espace de noms de la partie XML personnalisée.
readonly namespaceUri: string;Valeur de propriété
string
Remarques
[Jeu d’API : ExcelApi 1.5]
Détails de la méthode
delete()
Supprime la partie XML personnalisée.
delete(): void;Retours
void
Remarques
[Jeu d’API : ExcelApi 1.5]
getXml()
Obtient l’intégralité du contenu XML de la partie XML personnalisée.
getXml(): OfficeExtension.ClientResult<string>;Retours
OfficeExtension.ClientResult<string>
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.CustomXmlPartLoadOptions): Excel.CustomXmlPart;Paramètres
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.CustomXmlPart;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?: {
select?: string;
expand?: string;
}): Excel.CustomXmlPart;Paramètres
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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
setXml(xml)
Définit l’intégralité du contenu XML de la partie XML personnalisée.
setXml(xml: string): void;Paramètres
- xml
-
string
Contenu XML de la pièce.
Retours
void
Remarques
[Jeu d’API : ExcelApi 1.5]
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.CustomXmlPart est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.CustomXmlPartDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.CustomXmlPartData;