Office.CustomXmlParts interface

  • Référence
Paquet:
office

Représente une collection d’objets CustomXmlPart.

Remarques

Applications : Word

Méthodes

addAsync(xml, options, callback)

Ajoute de manière asynchrone une nouvelle partie XML personnalisée à un fichier.
addAsync(xml, callback)

Ajoute de manière asynchrone une nouvelle partie XML personnalisée à un fichier.
getByIdAsync(id, options, callback)

Obtient de façon asynchrone la partie XML personnalisée spécifiée par son ID.
getByIdAsync(id, callback)

Obtient de façon asynchrone la partie XML personnalisée spécifiée par son ID.
getByNamespaceAsync(ns, options, callback)

Obtient de façon asynchrone les parties XML personnalisées spécifiées par son espace de noms.
getByNamespaceAsync(ns, callback)

Obtient de façon asynchrone les parties XML personnalisées spécifiées par son espace de noms.

Détails de la méthode

addAsync(xml, options, callback)

Ajoute de manière asynchrone une nouvelle partie XML personnalisée à un fichier.

addAsync(xml: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlPart>) => void): void;

Paramètres

xml

string

Contenu XML à ajouter à la partie XML personnalisée qui vient d’être créée.

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<Office.CustomXmlPart>) => 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 l’objet CustomXmlPart nouvellement créé.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

addAsync(xml, callback)

Ajoute de manière asynchrone une nouvelle partie XML personnalisée à un fichier.

addAsync(xml: string, callback?: (result: AsyncResult<CustomXmlPart>) => void): void;

Paramètres

xml

string

Contenu XML à ajouter à la partie XML personnalisée qui vient d’être créée.

callback

(result: Office.AsyncResult<Office.CustomXmlPart>) => 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 l’objet CustomXmlPart nouvellement créé.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Exemples

function addXMLPart() {
    Office.context.document.customXmlParts.addAsync(
        '<root categoryId="1" xmlns="http://tempuri.org"><item name="Cheap Item" price="$193.95"/><item name="Expensive Item" price="$931.88"/></root>',
        function (result) {});
}

function addXMLPartandHandler() {
    Office.context.document.customXmlParts.addAsync(
        "<testns:book xmlns:testns='http://testns.com'><testns:page number='1'>Hello</testns:page><testns:page number='2'>world!</testns:page></testns:book>",
        function(r) { r.value.addHandlerAsync(Office.EventType.DataNodeDeleted,
            function(a) {write(a.type)
            },
                function(s) {write(s.status)
                });
        });
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message;
}

getByIdAsync(id, options, callback)

Obtient de façon asynchrone la partie XML personnalisée spécifiée par son ID.

getByIdAsync(id: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlPart>) => void): void;

Paramètres

id

string

GUID de la partie XML personnalisée, incluant les accolades d’ouverture et de fermeture.

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<Office.CustomXmlPart>) => 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 un objet CustomXmlPart qui représente la partie XML personnalisée spécifiée. S’il n’existe aucune partie XML personnalisée avec l’ID spécifié, la méthode retourne null.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Exemples

function showXMLPartInnerXML() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        xmlPart.getXmlAsync({}, function (eventArgs) {
            write(eventArgs.value);
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

getByIdAsync(id, callback)

Obtient de façon asynchrone la partie XML personnalisée spécifiée par son ID.

getByIdAsync(id: string, callback?: (result: AsyncResult<CustomXmlPart>) => void): void;

Paramètres

id

string

GUID de la partie XML personnalisée, incluant les accolades d’ouverture et de fermeture.

callback

(result: Office.AsyncResult<Office.CustomXmlPart>) => 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 un objet CustomXmlPart qui représente la partie XML personnalisée spécifiée. S’il n’existe aucune partie XML personnalisée avec l’ID spécifié, la méthode retourne null.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

getByNamespaceAsync(ns, options, callback)

Obtient de façon asynchrone les parties XML personnalisées spécifiées par son espace de noms.

getByNamespaceAsync(ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlPart[]>) => void): void;

Paramètres

ns

string

URI de l’espace de noms.

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<Office.CustomXmlPart[]>) => 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 un tableau d’objets CustomXmlPart qui correspondent à l’espace de noms spécifié.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

getByNamespaceAsync(ns, callback)

Obtient de façon asynchrone les parties XML personnalisées spécifiées par son espace de noms.

getByNamespaceAsync(ns: string, callback?: (result: AsyncResult<CustomXmlPart[]>) => void): void;

Paramètres

ns

string

URI de l’espace de noms.

callback

(result: Office.AsyncResult<Office.CustomXmlPart[]>) => 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 un tableau d’objets CustomXmlPart qui correspondent à l’espace de noms spécifié.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Exemples

function showXMLPartsInNamespace() {
    Office.context.document.customXmlParts.getByNamespaceAsync(
        "http://tempuri.org", 
        function (eventArgs) {
            write("Found " + eventArgs.value.length + " parts with this namespace");
    }); 
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}