Office.CustomXmlPart interface

Paket:
office

Stellt ein einzelnes CustomXMLPart in einer Office.CustomXmlParts-Auflistung dar.

Hinweise

Anwendungen: Word

Verwendet von

Eigenschaften

builtIn

Wahr, wenn der benutzerdefinierte XML-Teil integriert ist; Andernfalls falsch.
id

Ruft die GUID von CustomXMLPart ab.
namespaceManager

Ruft den Satz von Namespacepräfixzuordnungen (Office.CustomXmlPrefixMappings) ab, die für das aktuelle CustomXmlPart verwendet werden.

Methoden

addHandlerAsync(eventType, handler, options, callback)

Fügt dem Objekt einen Ereignishandler mit dem angegebenen Ereignistyp hinzu.
addHandlerAsync(eventType, handler, callback)

Fügt dem Objekt einen Ereignishandler mit dem angegebenen Ereignistyp hinzu.
deleteAsync(options, callback)

Löscht den benutzerdefinierten XML-Teil.
deleteAsync(callback)

Löscht den benutzerdefinierten XML-Teil.
getNodesAsync(xPath, options, callback)

Ruft asynchron alle CustomXmlNodes in dieser benutzerdefinierten XML-Komponente ab, die dem angegebenen XPath entsprechen.
getNodesAsync(xPath, callback)

Ruft asynchron alle CustomXmlNodes in dieser benutzerdefinierten XML-Komponente ab, die dem angegebenen XPath entsprechen.
getXmlAsync(options, callback)

Ruft asynchron den XML-Code in der benutzerdefinierten XML-Komponente ab.
getXmlAsync(callback)

Ruft asynchron den XML-Code in der benutzerdefinierten XML-Komponente ab.
removeHandlerAsync(eventType, handler, options, callback)

Entfernt einen Ereignishandler für den angegebenen Ereignistyp.
removeHandlerAsync(eventType, handler, callback)

Entfernt einen Ereignishandler für den angegebenen Ereignistyp.

Details zur Eigenschaft

builtIn

Wahr, wenn der benutzerdefinierte XML-Teil integriert ist; Andernfalls falsch.

builtIn: boolean;

Eigenschaftswert

boolean

Beispiele

function showXMLPartBuiltIn() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        write(xmlPart.builtIn);
    });
}

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

id

Ruft die GUID von CustomXMLPart ab.

id: string;

Eigenschaftswert

string

Beispiele

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

namespaceManager

Ruft den Satz von Namespacepräfixzuordnungen (Office.CustomXmlPrefixMappings) ab, die für das aktuelle CustomXmlPart verwendet werden.

namespaceManager: CustomXmlPrefixMappings;

Eigenschaftswert

Office.CustomXmlPrefixMappings

Beispiele

function setXMLPartNamespaceManagerNamespace() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        xmlPart.namespaceManager.addNamespaceAsync("myPrefix", "myNamespace");
    });
}

Details zur Methode

addHandlerAsync(eventType, handler, options, callback)

Fügt dem Objekt einen Ereignishandler mit dem angegebenen Ereignistyp hinzu.

addHandlerAsync(eventType: Office.EventType, handler: (result: any) => void, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parameter

eventType
Office.EventType

Gibt den Ereignistyp an, der hinzugefügt werden soll. Für ein CustomXmlPart-Objekt kann der eventType-Parameter als Office.EventType.NodeDeleted, Office.EventType.NodeInsertedund Office.EventType.NodeReplacedangegeben werden.

handler

(result: any) => void

Die hinzuzufügende Ereignishandlerfunktion, deren einziger Parameter vom Typ Office.NodeDeletedEventArgs, Office.NodeInsertedEventArgs oder Office.NodeReplacementEventArgs ist

options
Office.AsyncContextOptions

Bietet eine Option zum unveränderten Beibehalten von Kontextdaten beliebigen Typs zur Verwendung in einem Rückruf.

callback

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgegeben wird, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

Sie können mehrere Ereignishandler für den angegebenen eventType hinzufügen, solange der Name jeder Ereignishandlerfunktion eindeutig ist.

addHandlerAsync(eventType, handler, callback)

Fügt dem Objekt einen Ereignishandler mit dem angegebenen Ereignistyp hinzu.

addHandlerAsync(eventType: Office.EventType, handler: (result: any) => void, callback?: (result: AsyncResult<void>) => void): void;

Parameter

eventType
Office.EventType

Gibt den Ereignistyp an, der hinzugefügt werden soll. Für ein CustomXmlPart-Objekt kann der eventType-Parameter als Office.EventType.NodeDeleted, Office.EventType.NodeInsertedund Office.EventType.NodeReplacedangegeben werden.

handler

(result: any) => void

Die hinzuzufügende Ereignishandlerfunktion, deren einziger Parameter vom Typ Office.NodeDeletedEventArgs, Office.NodeInsertedEventArgs oder Office.NodeReplacementEventArgs ist

callback

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgegeben wird, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

Sie können mehrere Ereignishandler für den angegebenen eventType hinzufügen, solange der Name jeder Ereignishandlerfunktion eindeutig ist.

Beispiele

// To add an event handler for the NodeDeleted event, use the addHandlerAsync method of the CustomXmlPart object.
function addNodeDeletedEvent() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        xmlPart.addHandlerAsync(Office.EventType.NodeDeleted, function (eventArgs) {
            write("A node has been deleted.");
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

// To add an event handler for the NodeInserted event, use the addHandlerAsync method of the CustomXmlPart object.
function addNodeInsertedEvent() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        xmlPart.addHandlerAsync(Office.EventType.NodeInserted, function (eventArgs) {
            write("A node has been inserted.");
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

// To add an event handler for the NodeReplaced event, use the addHandlerAsync method of the CustomXmlPart object.
function addNodeReplacedEvent() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        xmlPart.addHandlerAsync(Office.EventType.NodeReplaced, function (eventArgs) {
            write("A node has been replaced.");
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

deleteAsync(options, callback)

Löscht den benutzerdefinierten XML-Teil.

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

Parameter

options
Office.AsyncContextOptions

Bietet eine Option zum unveränderten Beibehalten von Kontextdaten beliebigen Typs zur Verwendung in einem Rückruf.

callback

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgegeben wird, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

deleteAsync(callback)

Löscht den benutzerdefinierten XML-Teil.

deleteAsync(callback?: (result: AsyncResult<void>) => void): void;

Parameter

callback

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgegeben wird, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

Beispiele

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

getNodesAsync(xPath, options, callback)

Ruft asynchron alle CustomXmlNodes in dieser benutzerdefinierten XML-Komponente ab, die dem angegebenen XPath entsprechen.

getNodesAsync(xPath: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlNode[]>) => void): void;

Parameter

xPath

string

Ein XPath-Ausdruck, der die zurückzugebenden Knoten angibt. Erforderlich.

options
Office.AsyncContextOptions

Bietet eine Option zum unveränderten Beibehalten von Kontextdaten beliebigen Typs zur Verwendung in einem Rückruf.

callback

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgegeben wird, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value Eigenschaft des Ergebnisses ist ein Array von CustomXmlNode-Objekten, die die Knoten darstellen, die durch den XPath-Ausdruck angegeben werden, der an den xPath-Parameter übergeben wird.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

getNodesAsync(xPath, callback)

Ruft asynchron alle CustomXmlNodes in dieser benutzerdefinierten XML-Komponente ab, die dem angegebenen XPath entsprechen.

getNodesAsync(xPath: string, callback?: (result: AsyncResult<CustomXmlNode[]>) => void): void;

Parameter

xPath

string

Ein XPath-Ausdruck, der die zurückzugebenden Knoten angibt. Erforderlich.

callback

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgegeben wird, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value Eigenschaft des Ergebnisses ist ein Array von CustomXmlNode-Objekten, die die Knoten darstellen, die durch den XPath-Ausdruck angegeben werden, der an den xPath-Parameter übergeben wird.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

Beispiele

function showXmlNodeType() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        xmlPart.getNodesAsync('*/*', function (nodeResults) {
            for (let i = 0; i < nodeResults.value.length; i++) {
                const node = nodeResults.value[i];
                write(node.nodeType);
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

getXmlAsync(options, callback)

Ruft asynchron den XML-Code in der benutzerdefinierten XML-Komponente ab.

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

Parameter

options
Office.AsyncContextOptions

Bietet eine Option zum unveränderten Beibehalten von Kontextdaten beliebigen Typs zur Verwendung in einem Rückruf.

callback

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgegeben wird, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value Eigenschaft des Ergebnisses ist eine Zeichenfolge, die den XML-Code des referenzierten CustomXmlPart-Objekts enthält.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

getXmlAsync(callback)

Ruft asynchron den XML-Code in der benutzerdefinierten XML-Komponente ab.

getXmlAsync(callback?: (result: AsyncResult<string>) => void): void;

Parameter

callback

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgegeben wird, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value Eigenschaft des Ergebnisses ist eine Zeichenfolge, die den XML-Code des referenzierten CustomXmlPart-Objekts enthält.

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

removeHandlerAsync(eventType, handler, options, callback)

Entfernt einen Ereignishandler für den angegebenen Ereignistyp.

removeHandlerAsync(eventType: Office.EventType, handler?: (result: any) => void, options?: RemoveHandlerOptions, callback?: (result: AsyncResult<void>) => void): void;

Parameter

eventType
Office.EventType

Gibt den Typ des zu entfernenden Ereignisses an. Für ein CustomXmlPart-Objekt kann der eventType-Parameter als Office.EventType.NodeDeleted, Office.EventType.NodeInsertedund Office.EventType.NodeReplacedangegeben werden.

handler

(result: any) => void

Der Name des zu entfernenden Handlers.

options
Office.RemoveHandlerOptions

Bietet Optionen zum Bestimmen, welche(r) Ereignishandler/-handler entfernt werden.

callback

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgegeben wird, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

removeHandlerAsync(eventType, handler, callback)

Entfernt einen Ereignishandler für den angegebenen Ereignistyp.

removeHandlerAsync(eventType: Office.EventType, handler?: (result: any) => void, callback?: (result: AsyncResult<void>) => void): void;

Parameter

eventType
Office.EventType

Gibt den Typ des zu entfernenden Ereignisses an. Für ein CustomXmlPart-Objekt kann der eventType-Parameter als Office.EventType.NodeDeleted, Office.EventType.NodeInsertedund Office.EventType.NodeReplacedangegeben werden.

handler

(result: any) => void

Der Name des zu entfernenden Handlers.

callback

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgegeben wird, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

Beispiele

function removeNodeInsertedEventHandler() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}",
        function (result) {
            const xmlPart = result.value;
            xmlPart.removeHandlerAsync(Office.EventType.DataNodeInserted, {handler:myHandler});
    });
}