Word.CustomXmlNode class

パッケージ:: word

ドキュメント内のツリー内の XML ノードを表します。 CustomXmlNode オブジェクトは、Wordのメンバーです。CustomXmlNodeCollection オブジェクト。

Extends: OfficeExtension.ClientObject

注釈

プロパティ

attributes	現在のノード内の現在の要素の属性を表す `CustomXmlNodeCollection` オブジェクトを取得します。
baseName	名前空間プレフィックスを持たないノードがある場合、そのベース名を取得します。
childNodes	現在のノードのすべての子要素を含む `CustomXmlNodeCollection` オブジェクトを取得します。
context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
firstChild	現在のノードの最初の子要素に対応する `CustomXmlNode` オブジェクトを取得します。ノードに子要素がない場合 (または CustomXmlNodeType.element 型でない場合)、 `Nothing`を返します。
lastChild	現在のノードの最後の子要素に対応する `CustomXmlNode` オブジェクトを取得します。ノードに子要素がない場合 (または CustomXmlNodeType.element 型でない場合)、プロパティは `Nothing`を返します。
namespaceUri	ノードの名前空間の一意のアドレス識別子を取得します。
nextSibling	現在のノードに次の兄弟ノード (要素、コメント、または処理命令) を取得します。ノードがそのレベルの最後の兄弟である場合、プロパティは `Nothing`を返します。
nodeType	現在のノードの種類を取得します。
nodeValue	現在のノードの値を指定します。
ownerPart	指定したノードに関連付けられている部分を表すオブジェクトを取得します。
parentNode	要素ノードを現在のノードの親を取得します。現在のノードがルートレベルにある場合、プロパティは `Nothing`を返します。
previousSibling	現在のノードに前の兄弟ノード (要素、コメント、または処理命令) を取得します。現在のノードがそのレベルの最初の兄弟である場合、プロパティは `Nothing`を返します。
text	現在のノードのテキストを指定します。
xml	現在のノードとその子の XML 表現を取得します。
xpath	現在のノードの正規化された XPath を含む文字列を取得します。ノードがドキュメントオブジェクトモデル (DOM) 内で不要になった場合は、エラーメッセージを返します。

メソッド

appendChildNode(options)	シングルノードを、ツリー内のコンテキスト要素ノードの最後の子として追加します。
appendChildSubtree(xml)	サブツリーを、ツリー内のコンテキスト要素ノードの最後の子として追加します。
delete()	ツリーから現在のノード (存在する場合はそのすべての子ノード) を削除します。
hasChildNodes()	現在の要素ノードに子要素ノードがあるかどうかを指定します。
insertNodeBefore(options)	新しいノードを、ツリー内のコンテキストノードの直前に挿入します。
insertSubtreeBefore(xml, options)	指定したサブツリーをコンテキストノードの直前に挿入します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
removeChild(child)	指定した子ノードをツリーから削除します。
replaceChildNode(oldNode, options)	指定した子ノードを削除し、同じ場所にある別のノードに置き換えます。
replaceChildSubtree(xml, oldNode)	指定したノードを削除し、同じ場所にある別のサブツリーに置き換えます。
selectNodes(xPath)	XPath 式に一致するノードのコレクションを選択します。
selectSingleNode(xPath)	XPath 式に一致するコレクションから 1 つのノードを選択します。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
toJSON()	API オブジェクトが`JSON.stringify()`に渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (`JSON.stringify`、それに渡されるオブジェクトの `toJSON` メソッドを呼び出します)。元の `Word.CustomXmlNode` オブジェクトは API オブジェクトですが、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `Word.Interfaces.CustomXmlNodeData` として型指定) を返します。
track()	ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。このオブジェクトを `.sync` 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクトコレクションにオブジェクトを追加する必要があります。このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
untrack()	前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。この呼び出しは、context.trackedObjects.remove(thisObject)の短縮形です。追跡対象オブジェクトが多いとホストアプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。メモリ解放が有効になる前に、 `context.sync()` を呼び出す必要があります。

プロパティの詳細

attributes

現在のノード内の現在の要素の属性を表す CustomXmlNodeCollection オブジェクトを取得します。

readonly attributes: Word.CustomXmlNodeCollection;

プロパティ値

Word.CustomXmlNodeCollection

注釈

[ API set: WordApiDesktop 1.3 ]

baseName

名前空間プレフィックスを持たないノードがある場合、そのベース名を取得します。

readonly baseName: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.3 ]

childNodes

現在のノードのすべての子要素を含む CustomXmlNodeCollection オブジェクトを取得します。

readonly childNodes: Word.CustomXmlNodeCollection;

プロパティ値

Word.CustomXmlNodeCollection

注釈

[ API set: WordApiDesktop 1.3 ]

context

オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Word.RequestContext

firstChild

現在のノードの最初の子要素に対応する CustomXmlNode オブジェクトを取得します。ノードに子要素がない場合 (または CustomXmlNodeType.element 型でない場合)、 Nothingを返します。

readonly firstChild: Word.CustomXmlNode;

プロパティ値

Word.CustomXmlNode

注釈

[ API set: WordApiDesktop 1.3 ]

lastChild

現在のノードの最後の子要素に対応する CustomXmlNode オブジェクトを取得します。ノードに子要素がない場合 (または CustomXmlNodeType.element 型でない場合)、プロパティは Nothingを返します。

readonly lastChild: Word.CustomXmlNode;

プロパティ値

Word.CustomXmlNode

注釈

[ API set: WordApiDesktop 1.3 ]

namespaceUri

ノードの名前空間の一意のアドレス識別子を取得します。

readonly namespaceUri: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.3 ]

nextSibling

現在のノードに次の兄弟ノード (要素、コメント、または処理命令) を取得します。ノードがそのレベルの最後の兄弟である場合、プロパティは Nothingを返します。

readonly nextSibling: Word.CustomXmlNode;

プロパティ値

Word.CustomXmlNode

注釈

[ API set: WordApiDesktop 1.3 ]

nodeType

現在のノードの種類を取得します。

readonly nodeType: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document";

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

nodeValue

現在のノードの値を指定します。

nodeValue: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.3 ]

ownerPart

指定したノードに関連付けられている部分を表すオブジェクトを取得します。

readonly ownerPart: Word.CustomXmlPart;

プロパティ値

Word.CustomXmlPart

注釈

[ API set: WordApiDesktop 1.3 ]

parentNode

要素ノードを現在のノードの親を取得します。現在のノードがルートレベルにある場合、プロパティは Nothingを返します。

readonly parentNode: Word.CustomXmlNode;

プロパティ値

Word.CustomXmlNode

注釈

[ API set: WordApiDesktop 1.3 ]

previousSibling

現在のノードに前の兄弟ノード (要素、コメント、または処理命令) を取得します。現在のノードがそのレベルの最初の兄弟である場合、プロパティは Nothingを返します。

readonly previousSibling: Word.CustomXmlNode;

プロパティ値

Word.CustomXmlNode

注釈

[ API set: WordApiDesktop 1.3 ]

text

現在のノードのテキストを指定します。

text: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.3 ]

xml

現在のノードとその子の XML 表現を取得します。

readonly xml: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.3 ]

xpath

現在のノードの正規化された XPath を含む文字列を取得します。ノードがドキュメントオブジェクトモデル (DOM) 内で不要になった場合は、エラーメッセージを返します。

readonly xpath: string;

プロパティ値

string

注釈

[ API set: WordApiDesktop 1.3 ]

メソッドの詳細

appendChildNode(options)

シングルノードを、ツリー内のコンテキスト要素ノードの最後の子として追加します。

appendChildNode(options?: Word.CustomXmlAppendChildNodeOptions): OfficeExtension.ClientResult<number>;

パラメーター

options: Word.CustomXmlAppendChildNodeOptions

省略可能。追加するノードを定義するオプション。

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API set: WordApiDesktop 1.3 ]

appendChildSubtree(xml)

サブツリーを、ツリー内のコンテキスト要素ノードの最後の子として追加します。

appendChildSubtree(xml: string): OfficeExtension.ClientResult<number>;

パラメーター

xml: string

XML サブツリーを表す文字列。

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API set: WordApiDesktop 1.3 ]

delete()

ツリーから現在のノード (存在する場合はそのすべての子ノード) を削除します。

delete(): void;

戻り値

void

注釈

[ API set: WordApiDesktop 1.3 ]

hasChildNodes()

現在の要素ノードに子要素ノードがあるかどうかを指定します。

hasChildNodes(): OfficeExtension.ClientResult<boolean>;

戻り値

OfficeExtension.ClientResult<boolean>

注釈

[ API set: WordApiDesktop 1.3 ]

insertNodeBefore(options)

新しいノードを、ツリー内のコンテキストノードの直前に挿入します。

insertNodeBefore(options?: Word.CustomXmlInsertNodeBeforeOptions): OfficeExtension.ClientResult<number>;

パラメーター

options: Word.CustomXmlInsertNodeBeforeOptions

省略可能。挿入するノードを定義するオプション。

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API set: WordApiDesktop 1.3 ]

insertSubtreeBefore(xml, options)

指定したサブツリーをコンテキストノードの直前に挿入します。

insertSubtreeBefore(xml: string, options?: Word.CustomXmlInsertSubtreeBeforeOptions): OfficeExtension.ClientResult<number>;

パラメーター

xml: string

XML サブツリーを表す文字列。

options: Word.CustomXmlInsertSubtreeBeforeOptions

省略可能。サブツリーの挿入に使用できるオプション。

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API set: WordApiDesktop 1.3 ]

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Word.Interfaces.CustomXmlNodeLoadOptions): Word.CustomXmlNode;

パラメーター

options: Word.Interfaces.CustomXmlNodeLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Word.CustomXmlNode

load(propertyNames)

load(propertyNames?: string | string[]): Word.CustomXmlNode;

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Word.CustomXmlNode

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.CustomXmlNode;

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。

戻り値

Word.CustomXmlNode

removeChild(child)

指定した子ノードをツリーから削除します。

removeChild(child: Word.CustomXmlNode): OfficeExtension.ClientResult<number>;

パラメーター

child: Word.CustomXmlNode

削除する子ノード。

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API set: WordApiDesktop 1.3 ]

replaceChildNode(oldNode, options)

指定した子ノードを削除し、同じ場所にある別のノードに置き換えます。

replaceChildNode(oldNode: Word.CustomXmlNode, options?: Word.CustomXmlReplaceChildNodeOptions): OfficeExtension.ClientResult<number>;

パラメーター

oldNode: Word.CustomXmlNode

置き換えるノード。

options: Word.CustomXmlReplaceChildNodeOptions

省略可能。古いノードを置き換える子ノードを定義するオプション。

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API set: WordApiDesktop 1.3 ]

replaceChildSubtree(xml, oldNode)

指定したノードを削除し、同じ場所にある別のサブツリーに置き換えます。

replaceChildSubtree(xml: string, oldNode: Word.CustomXmlNode): OfficeExtension.ClientResult<number>;

パラメーター

xml: string

新しいサブツリーを表す文字列。

oldNode: Word.CustomXmlNode

置き換えるノード。

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API set: WordApiDesktop 1.3 ]

selectNodes(xPath)

XPath 式に一致するノードのコレクションを選択します。

selectNodes(xPath: string): Word.CustomXmlNodeCollection;

パラメーター

xPath: string

XPath 式。

戻り値

Word.CustomXmlNodeCollection

注釈

[ API set: WordApiDesktop 1.3 ]

selectSingleNode(xPath)

XPath 式に一致するコレクションから 1 つのノードを選択します。

selectSingleNode(xPath: string): Word.CustomXmlNode;

パラメーター

xPath: string

XPath 式。

戻り値

Word.CustomXmlNode

注釈

[ API set: WordApiDesktop 1.3 ]

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.CustomXmlNodeUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties: Word.Interfaces.CustomXmlNodeUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Word.CustomXmlNode): void;

パラメーター

properties: Word.CustomXmlNode

戻り値

void

toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Word.CustomXmlNode オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.CustomXmlNodeData として型指定) を返します。

toJSON(): Word.Interfaces.CustomXmlNodeData;

戻り値

Word.Interfaces.CustomXmlNodeData

track()

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクトコレクションにオブジェクトを追加する必要があります。このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.CustomXmlNode;

戻り値

Word.CustomXmlNode

untrack()

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。この呼び出しは、context.trackedObjects.remove(thisObject)の短縮形です。追跡対象オブジェクトが多いとホストアプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。

untrack(): Word.CustomXmlNode;

戻り値

Word.CustomXmlNode

フィードバック

このページはお役に立ちましたか?

次の方法で共有

Word.CustomXmlNode class

注釈

プロパティ

メソッド

プロパティの詳細

attributes

プロパティ値

注釈

baseName

プロパティ値

注釈

childNodes

プロパティ値

注釈

context

プロパティ値

firstChild

プロパティ値

注釈

lastChild

プロパティ値

注釈

namespaceUri

プロパティ値

注釈

nextSibling

プロパティ値

注釈

nodeType

プロパティ値

注釈

nodeValue

プロパティ値

注釈

ownerPart

プロパティ値

注釈

parentNode

プロパティ値

注釈

previousSibling

プロパティ値

注釈

text

プロパティ値

注釈

xml

プロパティ値

注釈

xpath

プロパティ値

注釈

メソッドの詳細

appendChildNode(options)

パラメーター

戻り値

注釈

appendChildSubtree(xml)

パラメーター

戻り値

注釈

delete()

戻り値

注釈

hasChildNodes()

戻り値

注釈

insertNodeBefore(options)

パラメーター

戻り値

注釈

insertSubtreeBefore(xml, options)

パラメーター

戻り値

注釈

load(options)

パラメーター

戻り値

load(propertyNames)