Freigeben über

Office.CustomXmlParts interface

  • Referenz
Paket:
office

Stellt eine Auflistung von CustomXmlPart-Objekten dar.

Hinweise

Anwendungen: Word

Methoden

addAsync(xml, options, callback)

Fügt einer Datei asynchron eine neue benutzerdefinierte XML-Komponente hinzu.
addAsync(xml, callback)

Fügt einer Datei asynchron eine neue benutzerdefinierte XML-Komponente hinzu.
getByIdAsync(id, options, callback)

Ruft die angegebene benutzerdefinierte XML-Komponente asynchron anhand seiner ID ab.
getByIdAsync(id, callback)

Ruft die angegebene benutzerdefinierte XML-Komponente asynchron anhand seiner ID ab.
getByNamespaceAsync(ns, options, callback)

Ruft die angegebenen benutzerdefinierten XML-Teile nach ihrem Namespace asynchron ab.
getByNamespaceAsync(ns, callback)

Ruft die angegebenen benutzerdefinierten XML-Teile nach ihrem Namespace asynchron ab.

Details zur Methode

addAsync(xml, options, callback)

Fügt einer Datei asynchron eine neue benutzerdefinierte XML-Komponente hinzu.

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

Parameter

xml

string

Der XML-Code, der der neu erstellten benutzerdefinierten XML-Komponente hinzugefügt werden soll.

options
Office.AsyncContextOptions

Bietet eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist das neu erstellte CustomXmlPart-Objekt.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

addAsync(xml, callback)

Fügt einer Datei asynchron eine neue benutzerdefinierte XML-Komponente hinzu.

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

Parameter

xml

string

Der XML-Code, der der neu erstellten benutzerdefinierten XML-Komponente hinzugefügt werden soll.

callback

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist das neu erstellte CustomXmlPart-Objekt.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

Beispiele

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)

Ruft die angegebene benutzerdefinierte XML-Komponente asynchron anhand seiner ID ab.

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

Parameter

id

string

Die GUID der benutzerdefinierten XML-Komponente, einschließlich öffnender und schließender Klammern.

options
Office.AsyncContextOptions

Bietet eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist ein CustomXmlPart-Objekt, das die angegebene benutzerdefinierte XML-Komponente darstellt. Wenn keine benutzerdefinierte XML-Komponente mit der angegebenen ID vorhanden ist, gibt die Methode NULL zurück.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

Beispiele

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)

Ruft die angegebene benutzerdefinierte XML-Komponente asynchron anhand seiner ID ab.

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

Parameter

id

string

Die GUID der benutzerdefinierten XML-Komponente, einschließlich öffnender und schließender Klammern.

callback

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist ein CustomXmlPart-Objekt, das die angegebene benutzerdefinierte XML-Komponente darstellt. Wenn keine benutzerdefinierte XML-Komponente mit der angegebenen ID vorhanden ist, gibt die Methode NULL zurück.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

getByNamespaceAsync(ns, options, callback)

Ruft die angegebenen benutzerdefinierten XML-Teile nach ihrem Namespace asynchron ab.

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

Parameter

ns

string

Die Namespace-URI.

options
Office.AsyncContextOptions

Bietet eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback

(result: Office.AsyncResult<Office.CustomXmlPart[]>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist ein Array von CustomXmlPart-Objekten, die dem angegebenen Namespace entsprechen.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

getByNamespaceAsync(ns, callback)

Ruft die angegebenen benutzerdefinierten XML-Teile nach ihrem Namespace asynchron ab.

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

Parameter

ns

string

Die Namespace-URI.

callback

(result: Office.AsyncResult<Office.CustomXmlPart[]>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist ein Array von CustomXmlPart-Objekten, die dem angegebenen Namespace entsprechen.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

Beispiele

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