Office.CustomXmlPart interface

Referenz

Paket:: office

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

Hinweise

Anwendungen: Word

Eigenschaften

builtIn	True, wenn die benutzerdefinierte XML-Komponente integriert ist; andernfalls false.
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 unter Verwendung des angegebenen Ereignistyps einen Ereignishandler hinzu.
addHandlerAsync(eventType, handler, callback)	Fügt dem -Objekt unter Verwendung des angegebenen Ereignistyps einen Ereignishandler hinzu.
deleteAsync(options, callback)	Löscht die benutzerdefinierte XML-Komponente.
deleteAsync(callback)	Löscht die benutzerdefinierte XML-Komponente.
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

True, wenn die benutzerdefinierte XML-Komponente integriert ist; andernfalls false.

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 unter Verwendung des angegebenen Ereignistyps einen Ereignishandler 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.NodeReplacedEventArgs ist

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<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, 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 unter Verwendung des angegebenen Ereignistyps einen Ereignishandler hinzu.

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

Parameter

eventType: Office.EventType

handler: (result: any) => void

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

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, 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 die benutzerdefinierte XML-Komponente.

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

Parameter

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<void>) => void

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

Gibt zurück

void

Hinweise

Anforderungssatz: CustomXmlParts

deleteAsync(callback)

Löscht die benutzerdefinierte XML-Komponente.

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ückgibt, 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 Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback: (result: Office.AsyncResult<Office.CustomXmlNode[]>) => 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 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

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 Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback: (result: Office.AsyncResult<string>) => 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 eine Zeichenfolge, die den XML-Code des CustomXmlPart-Objekts enthält, auf das verwiesen wird.

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ückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist eine Zeichenfolge, die den XML-Code des CustomXmlPart-Objekts enthält, auf das verwiesen wird.

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

Stellt Optionen bereit, um zu bestimmen, welche Ereignishandler oder Handler entfernt werden.

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

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, 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

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ückgibt, 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});
    });
}

Freigeben über

Office.CustomXmlPart interface

Hinweise

Eigenschaften

Methoden

Details zur Eigenschaft

builtIn

Eigenschaftswert

Beispiele

id

Eigenschaftswert

Beispiele

namespaceManager

Eigenschaftswert

Beispiele

Details zur Methode

addHandlerAsync(eventType, handler, options, callback)

Parameter

Gibt zurück

Hinweise

addHandlerAsync(eventType, handler, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

deleteAsync(options, callback)

Parameter

Gibt zurück

Hinweise

deleteAsync(callback)

Parameter

Gibt zurück

Hinweise

Beispiele

getNodesAsync(xPath, options, callback)

Parameter

Gibt zurück

Hinweise

getNodesAsync(xPath, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

getXmlAsync(options, callback)

Parameter

Gibt zurück

Hinweise

getXmlAsync(callback)

Parameter

Gibt zurück

Hinweise

Beispiele

removeHandlerAsync(eventType, handler, options, callback)

Parameter

Gibt zurück

Hinweise

removeHandlerAsync(eventType, handler, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

Zusätzliche Ressourcen