Office.CustomXmlParts interface

Пакет:

office

Представляет коллекцию объектов CustomXmlPart.

Комментарии

Приложения: Word

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

• Office.Document: customXmlParts

Методы

addAsync(xml, options, callback)	Асинхронно добавляет новую настраиваемую XML-часть в файл.
addAsync(xml, callback)	Асинхронно добавляет новую настраиваемую XML-часть в файл.
getByIdAsync(id, options, callback)	Асинхронно получает указанную пользовательскую часть XML по ее идентификатору.
getByIdAsync(id, callback)	Асинхронно получает указанную пользовательскую часть XML по ее идентификатору.
getByNamespaceAsync(ns, options, callback)	Асинхронно получает указанные пользовательские части XML по своему пространству имен.
getByNamespaceAsync(ns, callback)	Асинхронно получает указанные пользовательские части XML по своему пространству имен.

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

addAsync(xml, options, callback)

Асинхронно добавляет новую настраиваемую XML-часть в файл.

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

Параметры

xml

string

XML для добавления в недавно созданную пользовательскую XML-часть.

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

Набор требований: CustomXmlParts

addAsync(xml, callback)

Асинхронно добавляет новую настраиваемую XML-часть в файл.

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

Параметры

xml

string

XML для добавления в недавно созданную пользовательскую XML-часть.

callback

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

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

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

void

Комментарии

Набор требований: CustomXmlParts

Примеры

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)

Асинхронно получает указанную пользовательскую часть XML по ее идентификатору.

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

Параметры

id

string

GUID пользовательской XML-части, заключенный в скобки.

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

Набор требований: CustomXmlParts

Примеры

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)

Асинхронно получает указанную пользовательскую часть XML по ее идентификатору.

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

Параметры

id

string

GUID пользовательской XML-части, заключенный в скобки.

callback

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

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

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

void

Комментарии

Набор требований: CustomXmlParts

getByNamespaceAsync(ns, options, callback)

Асинхронно получает указанные пользовательские части XML по своему пространству имен.

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

Параметры

ns

string

URI пространства имен.

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

Набор требований: CustomXmlParts

getByNamespaceAsync(ns, callback)

Асинхронно получает указанные пользовательские части XML по своему пространству имен.

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

Параметры

ns

string

URI пространства имен.

callback

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

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

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

void

Комментарии

Набор требований: CustomXmlParts

Примеры

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