Office.CustomXmlParts interface

CustomXmlPart オブジェクトのコレクションを表します。

注釈

アプリケーション: Word

使用元

Office.Document: customXmlParts

メソッド

addAsync(xml, options, callback)	新しいカスタム XML パーツをファイルに非同期に追加します。
addAsync(xml, callback)	新しいカスタム XML パーツをファイルに非同期に追加します。
getByIdAsync(id, options, callback)	指定されたカスタム XML パーツをその ID によって非同期に取得します。
getByIdAsync(id, callback)	指定されたカスタム XML パーツをその ID によって非同期に取得します。
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 パーツをその ID によって非同期に取得します。

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

パラメーター

id: string

カスタム XML パーツの GUID (左かっこと右かっこを含む)。

options: Office.AsyncContextOptions

コールバックで使用するために、任意の種類のコンテキストデータを変更されないまま保持するためのオプションを提供します。

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

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。結果の value プロパティは、指定されたカスタム XML パーツを表す CustomXmlPart オブジェクトです。指定された ID のカスタム 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 パーツをその ID によって非同期に取得します。

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

パラメーター

id: string

カスタム XML パーツの GUID (左かっこと右かっこを含む)。

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

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。結果の value プロパティは、指定されたカスタム XML パーツを表す CustomXmlPart オブジェクトです。指定された ID のカスタム 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;
}

注釈

使用元

メソッド

メソッドの詳細

addAsync(xml, options, callback)

パラメーター

返品

注釈

addAsync(xml, callback)

パラメーター

返品

注釈

例

getByIdAsync(id, options, callback)

パラメーター

返品

注釈

例

getByIdAsync(id, callback)

パラメーター

返品

注釈

getByNamespaceAsync(ns, options, callback)

パラメーター

返品

注釈

getByNamespaceAsync(ns, callback)

パラメーター

返品

注釈

例

フィードバック