Office.CustomXmlPrefixMappings interface

Paquet:

office

Représente une collection d’objets CustomXmlPart.

Remarques

Applications : Word

Méthodes

addNamespaceAsync(prefix, ns, options, callback)	Ajoute de manière asynchrone un préfixe au mappage d’espace de noms à utiliser lors de l’interrogation d’un élément.
addNamespaceAsync(prefix, ns, callback)	Ajoute de manière asynchrone un préfixe au mappage d’espace de noms à utiliser lors de l’interrogation d’un élément.
getNamespaceAsync(prefix, options, callback)	Obtient de manière asynchrone l’espace de noms mappé au préfixe spécifié.
getNamespaceAsync(prefix, callback)	Obtient de manière asynchrone l’espace de noms mappé au préfixe spécifié.
getPrefixAsync(ns, options, callback)	Obtient de manière asynchrone le préfixe de l’espace de noms spécifié.
getPrefixAsync(ns, callback)	Obtient de manière asynchrone le préfixe de l’espace de noms spécifié.

Détails de la méthode

addNamespaceAsync(prefix, ns, options, callback)

Ajoute de manière asynchrone un préfixe au mappage d’espace de noms à utiliser lors de l’interrogation d’un élément.

addNamespaceAsync(prefix: string, ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

prefix

string

Spécifie le préfixe à ajouter à la liste de mappages de préfixes. Obligatoire.

ns

string

Spécifie l’URI d’espace de noms à affecter au préfixe nouvellement ajouté. Obligatoire.

options

Office.AsyncContextOptions

Fournit une option permettant de conserver des données de contexte de tout type, inchangées, pour une utilisation dans un rappel.

callback

(result: Office.AsyncResult<void>) => void

Facultatif. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Si aucun espace de noms n’est affecté au préfixe demandé, la méthode retourne une chaîne vide ("").

addNamespaceAsync(prefix, ns, callback)

Ajoute de manière asynchrone un préfixe au mappage d’espace de noms à utiliser lors de l’interrogation d’un élément.

addNamespaceAsync(prefix: string, ns: string, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

prefix

string

Spécifie le préfixe à ajouter à la liste de mappages de préfixes. Obligatoire.

ns

string

Spécifie l’URI d’espace de noms à affecter au préfixe nouvellement ajouté. Obligatoire.

callback

(result: Office.AsyncResult<void>) => void

Facultatif. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Si aucun espace de noms n’est affecté au préfixe demandé, la méthode retourne une chaîne vide ("").

getNamespaceAsync(prefix, options, callback)

Obtient de manière asynchrone l’espace de noms mappé au préfixe spécifié.

getNamespaceAsync(prefix: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;

Paramètres

prefix

string

Spécifie le préfixe pour lequel obtenir l’espace de noms. Obligatoire.

options

Office.AsyncContextOptions

Fournit une option permettant de conserver des données de contexte de tout type, inchangées, pour une utilisation dans un rappel.

callback

(result: Office.AsyncResult<string>) => void

Facultatif. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult. La value propriété du résultat est une chaîne qui contient l’espace de noms mappé au préfixe spécifié.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Si le préfixe existe déjà dans le gestionnaire d’espaces de noms, cette méthode remplace le mappage du préfixe, sauf quand le préfixe est ajouté ou utilisé par le magasin de données de façon interne. Dans ce cas, une erreur est retournée.

getNamespaceAsync(prefix, callback)

Obtient de manière asynchrone l’espace de noms mappé au préfixe spécifié.

getNamespaceAsync(prefix: string, callback?: (result: AsyncResult<string>) => void): void;

Paramètres

prefix

string

Spécifie le préfixe pour lequel obtenir l’espace de noms. Obligatoire.

callback

(result: Office.AsyncResult<string>) => void

Facultatif. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult. La value propriété du résultat est une chaîne qui contient l’espace de noms mappé au préfixe spécifié.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Si le préfixe existe déjà dans le gestionnaire d’espaces de noms, cette méthode remplace le mappage du préfixe, sauf quand le préfixe est ajouté ou utilisé par le magasin de données de façon interne. Dans ce cas, une erreur est retournée.

getPrefixAsync(ns, options, callback)

Obtient de manière asynchrone le préfixe de l’espace de noms spécifié.

getPrefixAsync(ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;

Paramètres

ns

string

Spécifie l’espace de noms dont le préfixe doit être obtenu. Obligatoire.

options

Office.AsyncContextOptions

Fournit une option permettant de conserver des données de contexte de tout type, inchangées, pour une utilisation dans un rappel.

callback

(result: Office.AsyncResult<string>) => void

Facultatif. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult. La value propriété du résultat est une chaîne qui contient le préfixe de l’espace de noms spécifié.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Si aucun préfixe n’est affecté à l’espace de noms demandé, la méthode retourne une chaîne vide (""). Si plusieurs préfixes sont spécifiés dans le gestionnaire d’espaces de noms, la méthode retourne le premier préfixe qui correspond à l’espace de noms fourni.

getPrefixAsync(ns, callback)

Obtient de manière asynchrone le préfixe de l’espace de noms spécifié.

getPrefixAsync(ns: string, callback?: (result: AsyncResult<string>) => void): void;

Paramètres

ns

string

Spécifie l’espace de noms dont le préfixe doit être obtenu. Obligatoire.

callback

(result: Office.AsyncResult<string>) => void

Facultatif. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult. La value propriété du résultat est une chaîne qui contient le préfixe de l’espace de noms spécifié.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Si aucun préfixe n’est affecté à l’espace de noms demandé, la méthode retourne une chaîne vide (""). Si plusieurs préfixes sont spécifiés dans le gestionnaire d’espaces de noms, la méthode retourne le premier préfixe qui correspond à l’espace de noms fourni.