Office.CustomXmlPart interface

Представляет один объект CustomXMLPart в коллекции Office.CustomXmlParts .

Свойства

builtIn	True, если пользовательская часть XML встроена; в противном случае false.
id	Получает GUID объекта CustomXMLPart.
namespaceManager	Получает набор сопоставлений префиксов пространства имен (Office.CustomXmlPrefixMappings), используемых для текущего объекта CustomXmlPart.

Методы

addHandlerAsync(eventType, handler, options, callback)	Добавляет обработчик событий к объекту, используя указанный тип события.
addHandlerAsync(eventType, handler, callback)	Добавляет обработчик событий к объекту, используя указанный тип события.
deleteAsync(options, callback)	Удаляет пользовательскую часть XML.
deleteAsync(callback)	Удаляет пользовательскую часть XML.
getNodesAsync(xPath, options, callback)	Асинхронно получает все объекты CustomXmlNode в настраиваемой XML-части, соответствующие указанному параметру XPath.
getNodesAsync(xPath, callback)	Асинхронно получает все объекты CustomXmlNode в настраиваемой XML-части, соответствующие указанному параметру XPath.
getXmlAsync(options, callback)	Асинхронно получает XML внутри настраиваемой XML-части.
getXmlAsync(callback)	Асинхронно получает XML внутри настраиваемой XML-части.
removeHandlerAsync(eventType, handler, options, callback)	Удаляет обработчик событий указанного типа.
removeHandlerAsync(eventType, handler, callback)	Удаляет обработчик событий указанного типа.

builtIn

True, если пользовательская часть XML встроена; в противном случае false.

builtIn: boolean;

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

boolean

Примеры

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

Получает GUID объекта CustomXMLPart.

id: string;

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

string

Примеры

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

Получает набор сопоставлений префиксов пространства имен (Office.CustomXmlPrefixMappings), используемых для текущего объекта CustomXmlPart.

namespaceManager: CustomXmlPrefixMappings;

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

Office.CustomXmlPrefixMappings

Примеры

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

addHandlerAsync(eventType, handler, options, callback)

Добавляет обработчик событий к объекту, используя указанный тип события.

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

Параметры

eventType: Office.EventType

Указывает тип добавляемого события. Для объекта CustomXmlPart параметр eventType может быть указан как Office.EventType.NodeDeleted, Office.EventType.NodeInsertedи Office.EventType.NodeReplaced.

handler: (result: any) => void

Добавляемая функция обработчика событий, единственный параметр которой имеет тип Office.NodeDeletedEventArgs, Office.NodeInsertedEventArgs или Office.NodeReplacedEventArgs

options: Office.AsyncContextOptions

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

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

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

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

void

addHandlerAsync(eventType, handler, callback)

Добавляет обработчик событий к объекту, используя указанный тип события.

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

Параметры

eventType: Office.EventType

Указывает тип добавляемого события. Для объекта CustomXmlPart параметр eventType может быть указан как Office.EventType.NodeDeleted, Office.EventType.NodeInsertedи Office.EventType.NodeReplaced.

handler: (result: any) => void

Добавляемая функция обработчика событий, единственный параметр которой имеет тип Office.NodeDeletedEventArgs, Office.NodeInsertedEventArgs или Office.NodeReplacedEventArgs

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

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

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

void

Примеры

// 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)

Удаляет пользовательскую часть XML.

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

Параметры

options: Office.AsyncContextOptions

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

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

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

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

void

deleteAsync(callback)

Удаляет пользовательскую часть XML.

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

Параметры

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

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

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

void

Примеры

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)

Асинхронно получает все объекты CustomXmlNode в настраиваемой XML-части, соответствующие указанному параметру 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)

Асинхронно получает все объекты CustomXmlNode в настраиваемой XML-части, соответствующие указанному параметру 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 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)

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

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

Параметры

options: Office.AsyncContextOptions

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

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

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

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

void

getXmlAsync(callback)

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

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

Параметры

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

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

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

void

Примеры

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)

Удаляет обработчик событий указанного типа.

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

Параметры

eventType: Office.EventType

Указывает тип удаляемого события. Для объекта CustomXmlPart параметр eventType может быть указан как Office.EventType.NodeDeleted, Office.EventType.NodeInsertedи Office.EventType.NodeReplaced.

handler: (result: any) => void

Имя удаляемого обработчика.

options: Office.RemoveHandlerOptions

Предоставляет параметры для определения того, какой обработчик или обработчики событий удаляются.

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

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

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

void

removeHandlerAsync(eventType, handler, callback)

Удаляет обработчик событий указанного типа.

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

Параметры

eventType: Office.EventType

Указывает тип удаляемого события. Для объекта CustomXmlPart параметр eventType может быть указан как Office.EventType.NodeDeleted, Office.EventType.NodeInsertedи Office.EventType.NodeReplaced.

handler: (result: any) => void

Имя удаляемого обработчика.

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

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

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

void

Примеры

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

Комментарии

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

Свойства

Методы

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

builtIn

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

Примеры

id

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

Примеры

namespaceManager

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

Примеры

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

addHandlerAsync(eventType, handler, options, callback)

Параметры

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

Комментарии

addHandlerAsync(eventType, handler, callback)

Параметры

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

Комментарии

Примеры

deleteAsync(options, callback)

Параметры

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

Комментарии

deleteAsync(callback)

Параметры

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

Комментарии

Примеры

getNodesAsync(xPath, options, callback)

Параметры

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

Комментарии

getNodesAsync(xPath, callback)

Параметры

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

Комментарии

Примеры

getXmlAsync(options, callback)

Параметры

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

Комментарии

getXmlAsync(callback)

Параметры

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

Комментарии

Примеры

removeHandlerAsync(eventType, handler, options, callback)

Параметры

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

Комментарии

removeHandlerAsync(eventType, handler, callback)

Параметры

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

Комментарии

Примеры

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