Office.CustomXmlPart interface

Пакет:

office

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

Комментарии

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

Свойства

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

Комментарии

Набор обязательных элементов: CustomXmlParts

Можно добавить несколько обработчиков событий для указанного eventType, если имя каждой функции обработчика событий является уникальным.

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

Комментарии

Набор обязательных элементов: CustomXmlParts

Можно добавить несколько обработчиков событий для указанного eventType, если имя каждой функции обработчика событий является уникальным.

Примеры

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

Комментарии

Набор обязательных элементов: CustomXmlParts

deleteAsync(callback)

Удаляет настраиваемую XML-часть.

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

Параметры

callback

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

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

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

void

Комментарии

Набор обязательных элементов: CustomXmlParts

Примеры

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

Комментарии

Набор обязательных элементов: CustomXmlParts

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

Комментарии

Набор обязательных элементов: CustomXmlParts

Примеры

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

Комментарии

Набор обязательных элементов: CustomXmlParts

getXmlAsync(callback)

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

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

Параметры

callback

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

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

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

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

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

Комментарии

Набор обязательных элементов: CustomXmlParts

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

Комментарии

Набор обязательных элементов: CustomXmlParts

Примеры

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