Office.CustomXmlNode interface

Представляет XML-узел в дереве документа.

Свойства

baseName	Получает базовое имя узла без префикса пространства имен (если оно существует).
namespaceUri	Получает GUID строки CustomXMLPart.
nodeType	Получает тип CustomXMLNode.

Методы

getNodesAsync(xPath, options, callback)	Получает узлы, связанные с выражением XPath.
getNodesAsync(xPath, callback)	Получает узлы, связанные с выражением XPath.
getNodeValueAsync(options, callback)	Получает значение узла.
getNodeValueAsync(callback)	Получает значение узла.
getTextAsync(options, callback)	Получает текст узла XML в настраиваемой части XML.
getTextAsync(callback)	Получает текст узла XML в настраиваемой части XML.
getXmlAsync(options, callback)	Получает XML-файл узла.
getXmlAsync(callback)	Получает XML-файл узла.
setNodeValueAsync(value, options, callback)	Задает значение узла.
setNodeValueAsync(value, callback)	Задает значение узла.
setTextAsync(text, options, callback)	Асинхронно задает текст XML-узла в настраиваемой XML-части.
setTextAsync(text, callback)	Асинхронно задает текст XML-узла в настраиваемой XML-части.
setXmlAsync(xml, options, callback)	Задает узел XML.
setXmlAsync(xml, callback)	Задает узел XML.

baseName

Получает базовое имя узла без префикса пространства имен (если оно существует).

baseName: string;

Значение свойства

string

Примеры

function showXmlNodeBaseNames() {
    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.baseName);
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

namespaceUri

Получает GUID строки CustomXMLPart.

namespaceUri: string;

Значение свойства

string

Примеры

function showXmlNamespaceUri() {
    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.namespaceUri);
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

nodeType

Получает тип CustomXMLNode.

nodeType: string;

Значение свойства

string

Примеры

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

getNodesAsync(xPath, options, callback)

Получает узлы, связанные с выражением XPath.

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

Параметры

xPath: string

Выражение XPath, указывающее узлы, которые нужно получить. Обязательно.

options: Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в обратном вызове.

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult. Свойством value результата является массив объектов CustomXmlNode, представляющих узлы, заданные выражением XPath, переданным параметру xPath .

Возвращаемое значение

void

getNodesAsync(xPath, callback)

Получает узлы, связанные с выражением XPath.

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

Параметры

xPath: string

Выражение XPath, указывающее узлы, которые нужно получить. Обязательно.

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult. Свойством value результата является массив объектов CustomXmlNode, представляющих узлы, заданные выражением XPath, переданным параметру xPath .

Возвращаемое значение

void

Примеры

function showXmlChildNodes() {
    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];
                node.getNodesAsync('*', function (nodeResults) {
                    write(nodeResults.value.length + " childNodes");
                });
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

getNodeValueAsync(options, callback)

Получает значение узла.

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

Параметры

options: Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в обратном вызове.

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult. Свойством value результата является строка, содержащая значение узла, на который ссылается ссылка.

Возвращаемое значение

void

getNodeValueAsync(callback)

Получает значение узла.

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

Параметры

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult. Свойством value результата является строка, содержащая значение узла, на который ссылается ссылка.

Возвращаемое значение

void

Примеры

function showXmlNodeValues() {
    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];
                node.getNodeValueAsync(function (asyncResult) {
                    write(asyncResult.value);
                });
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

getTextAsync(options, callback)

Получает текст узла XML в настраиваемой части XML.

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

Параметры

options: Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в обратном вызове.

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult. Свойством value результата является строка, содержащая внутренний текст узлов, на которые ссылаются.

Возвращаемое значение

void

Примеры

// Get the built-in core properties XML part by using its ID. This results in a call to Word.
Office.context.document.customXmlParts.getByIdAsync(
    "{6C3C8BC8-F283-45AE-878A-BAB7291924A1}", function (getByIdAsyncResult) {
    
    // Access the XML part.
    const xmlPart = getByIdAsyncResult.value;
    
    // Add namespaces to the namespace manager. These two calls result in two calls to Word.
    xmlPart.namespaceManager.addNamespaceAsync(
        'cp',
        'http://schemas.openxmlformats.org/package/2006/metadata/core-properties',
        function () {
        xmlPart.namespaceManager.addNamespaceAsync(
            'dc', 
            'http://purl.org/dc/elements/1.1/', 
            function () {

            // Get XML nodes by using an Xpath expression. This results in a call to Word.
            xmlPart.getNodesAsync("/cp:coreProperties/dc:title", function (getNodesAsyncResult) {
                
                // Get the first node returned by using the Xpath expression. 
                const node = getNodesAsyncResult.value[0];
                
                // Get the text value of the node and use the asyncContext. This results in a call to Word. 
                // The results are logged to the browser console.
                node.getTextAsync({asyncContext: "StateNormal"}, function (getTextAsyncResult) {
                  console.log("Text of the title element = " + getTextAsyncResult.value;
                  console.log("The asyncContext value = " + getTextAsyncResult.asyncContext;
                });
            });
        });
    });
});

getTextAsync(callback)

Получает текст узла XML в настраиваемой части XML.

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

Параметры

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult. Свойством value результата является строка, содержащая внутренний текст узлов, на которые ссылаются.

Возвращаемое значение

void

getXmlAsync(options, callback)

Получает XML-файл узла.

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

Параметры

options: Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в обратном вызове.

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult. Свойством value результата является строка, содержащая XML-код узла, на который указывает ссылка.

Возвращаемое значение

void

getXmlAsync(callback)

Получает XML-файл узла.

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

Параметры

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult. Свойством value результата является строка, содержащая XML-код узла, на который указывает ссылка.

Возвращаемое значение

void

Примеры

function showXmlNodeInnerXml() {
    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];
                node.getXmlAsync(function (asyncResult) {
                    write(asyncResult.value);
                });
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

setNodeValueAsync(value, options, callback)

Задает значение узла.

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

Параметры

value: string

Значение, необходимое для узла

options: Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в обратном вызове.

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

setNodeValueAsync(value, callback)

Задает значение узла.

setNodeValueAsync(value: string, callback?: (result: AsyncResult<void>) => void): void;

Параметры

value: string

Значение, необходимое для узла

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Примеры

function setXmlNodeValue() {
    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);
                node.setNodeValueAsync("item number" + i, function (result) { });
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

setTextAsync(text, options, callback)

Асинхронно задает текст XML-узла в настраиваемой XML-части.

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

Параметры

text: string

Обязательно. Текстовое значение XML-узла.

options: Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в обратном вызове.

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Примеры

// Learn how to set the text value of a node in a custom XML part from the following example.

// Get the built-in core properties XML part by using its ID. This results in a call to Word.
Office.context.document.customXmlParts.getByIdAsync(
    "{6C3C8BC8-F283-45AE-878A-BAB7291924A1}",
    function (getByIdAsyncResult) {
    
    // Access the XML part.
    const xmlPart = getByIdAsyncResult.value;
    
    // Add namespaces to the namespace manager. These two calls result in two calls to Word.
    xmlPart.namespaceManager.addNamespaceAsync(
        'cp', 
        'http://schemas.openxmlformats.org/package/2006/metadata/core-properties', 
        function () {
        xmlPart.namespaceManager.addNamespaceAsync(
            'dc', 
            'http://purl.org/dc/elements/1.1/', 
            function () {

            // Get XML nodes by using an Xpath expression. This results in a call to the host.
            xmlPart.getNodesAsync("/cp:coreProperties/dc:subject", function (getNodesAsyncResult) {
                
                // Get the first node returned by using the Xpath expression.
                // This will be the subject element in this example.
                const subjectNode = getNodesAsyncResult.value[0];
                
                // Set the text value of the subject node and use the asyncContext. 
                // This results in a call to the host.  The results are logged to the browser console.
                subjectNode.setTextAsync(
                    "newSubject", 
                    {asyncContext: "StateNormal"}, 
                    function (setTextAsyncResult) {
                        console.log("The status of the call: " + setTextAsyncResult.status);
                        console.log("The asyncContext value = " + setTextAsyncResult.asyncContext);
                });
            });
        });
    });
});

setTextAsync(text, callback)

Асинхронно задает текст XML-узла в настраиваемой XML-части.

setTextAsync(text: string, callback?: (result: AsyncResult<void>) => void): void;

Параметры

text: string

Обязательно. Текстовое значение XML-узла.

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

setXmlAsync(xml, options, callback)

Задает узел XML.

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

Параметры

xml: string

XML-код, который необходимо установить на узле

options: Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в обратном вызове.

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Примеры

function setXmlNodeInnerXml() {
    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];
                node.setXmlAsync("<childNode>" + i + "</childNode>");
            }
        });
    });
}

setXmlAsync(xml, callback)

Задает узел XML.

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

Параметры

xml: string

XML-код, который необходимо установить на узле

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

Необязательный параметр. Функция, вызываемая при возврате обратного вызова, единственный параметр которой имеет тип Office.AsyncResult.

Возвращаемое значение

void

Комментарии

Используется

Свойства

Методы

Сведения о свойстве

baseName

Значение свойства

Примеры

namespaceUri

Значение свойства

Примеры

nodeType

Значение свойства

Примеры

Сведения о методе

getNodesAsync(xPath, options, callback)

Параметры

Возвращаемое значение

Комментарии

getNodesAsync(xPath, callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

getNodeValueAsync(options, callback)

Параметры

Возвращаемое значение

Комментарии

getNodeValueAsync(callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

getTextAsync(options, callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

getTextAsync(callback)

Параметры

Возвращаемое значение

Комментарии

getXmlAsync(options, callback)

Параметры

Возвращаемое значение

Комментарии

getXmlAsync(callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

setNodeValueAsync(value, options, callback)

Параметры

Возвращаемое значение

Комментарии

setNodeValueAsync(value, callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

setTextAsync(text, options, callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

setTextAsync(text, callback)

Параметры

Возвращаемое значение

Комментарии

setXmlAsync(xml, options, callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

setXmlAsync(xml, callback)

Параметры

Возвращаемое значение

Комментарии

Обратная связь