Word.CustomXmlNode class

パッケージ:

word

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

Extends

OfficeExtension.ClientObject

注釈

API セット: WordApiDesktop 1.3

使用元

• Word.CustomXmlAddNodeOptions: nextSibling
• Word.CustomXmlInsertNodeBeforeOptions: nextSibling
• Word.CustomXmlInsertSubtreeBeforeOptions: nextSibling
• Word.CustomXmlNodeCollection: getItem, items
• Word.CustomXmlPart: addNode, documentElement, selectSingleNode
• Word.CustomXmlValidationError: node
• Word.CustomXmlValidationErrorCollection: add
• Word.ドキュメント: selectLinkedControls
• Word.XmlMapping: customXmlNode, setMappingByNode

プロパティ

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 セット: WordApiDesktop 1.3

baseName

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

readonly baseName: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

childNodes

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

readonly childNodes: Word.CustomXmlNodeCollection;

プロパティ値

Word.CustomXmlNodeCollection

注釈

API セット: WordApiDesktop 1.3

context

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

context: RequestContext;

プロパティ値

Word.RequestContext

firstChild

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

readonly firstChild: Word.CustomXmlNode;

プロパティ値

Word.CustomXmlNode

注釈

API セット: WordApiDesktop 1.3

lastChild

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

readonly lastChild: Word.CustomXmlNode;

プロパティ値

Word.CustomXmlNode

注釈

API セット: WordApiDesktop 1.3

namespaceUri

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

readonly namespaceUri: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

nextSibling

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

readonly nextSibling: Word.CustomXmlNode;

プロパティ値

Word.CustomXmlNode

注釈

API セット: WordApiDesktop 1.3

nodeType

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

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

プロパティ値

Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"

注釈

API セット: WordApiDesktop 1.3

nodeValue

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

nodeValue: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

ownerPart

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

readonly ownerPart: Word.CustomXmlPart;

プロパティ値

Word.CustomXmlPart

注釈

API セット: WordApiDesktop 1.3

parentNode

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

readonly parentNode: Word.CustomXmlNode;

プロパティ値

Word.CustomXmlNode

注釈

API セット: WordApiDesktop 1.3

previousSibling

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

readonly previousSibling: Word.CustomXmlNode;

プロパティ値

Word.CustomXmlNode

注釈

API セット: WordApiDesktop 1.3

text

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

text: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

xml

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

readonly xml: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

xpath

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

readonly xpath: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

メソッドの詳細

appendChildNode(options)

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

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

パラメーター

options

Word.CustomXmlAppendChildNodeOptions

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

返品

OfficeExtension.ClientResult<number>

注釈

API セット: WordApiDesktop 1.3

appendChildSubtree(xml)

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

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

パラメーター

xml

string

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

返品

OfficeExtension.ClientResult<number>

注釈

API セット: WordApiDesktop 1.3

delete()

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

delete(): void;

返品

void

注釈

API セット: WordApiDesktop 1.3

hasChildNodes()

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

hasChildNodes(): OfficeExtension.ClientResult<boolean>;

返品

OfficeExtension.ClientResult<boolean>

注釈

API セット: WordApiDesktop 1.3

insertNodeBefore(options)

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

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

パラメーター

options

Word.CustomXmlInsertNodeBeforeOptions

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

返品

OfficeExtension.ClientResult<number>

注釈

API セット: 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 セット: WordApiDesktop 1.3

load(options)

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

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

パラメーター

options

Word.Interfaces.CustomXmlNodeLoadOptions

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

返品

Word.CustomXmlNode

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

返品

Word.CustomXmlNode

load(propertyNamesAndPaths)

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

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 セット: 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 セット: WordApiDesktop 1.3

replaceChildSubtree(xml, oldNode)

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

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

パラメーター

xml

string

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

oldNode

Word.CustomXmlNode

置き換えるノード。

返品

OfficeExtension.ClientResult<number>

注釈

API セット: WordApiDesktop 1.3

selectNodes(xPath)

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

selectNodes(xPath: string): Word.CustomXmlNodeCollection;

パラメーター

xPath

string

XPath 式。

返品

Word.CustomXmlNodeCollection

注釈

API セット: WordApiDesktop 1.3

selectSingleNode(xPath)

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

selectSingleNode(xPath: string): Word.CustomXmlNode;

パラメーター

xPath

string

XPath 式。

返品

Word.CustomXmlNode

注釈

API セット: WordApiDesktop 1.3

set(properties, options)

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

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

パラメーター

properties

Word.Interfaces.CustomXmlNodeUpdateData

メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。

options

OfficeExtension.UpdateOptions

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

返品

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