Word.XmlNode class

ドキュメントに適用される単一の XML ノードを表します。

注釈

使用元

プロパティ

attributes	この XML ノードの属性を取得します。ノードの種類が `attribute` の場合は `null` を返します。
baseName	プレフィックスなしで要素の名前を取得します。
childNodes	この XML ノードの子要素を取得します。ノード型が `attribute` の場合は空のコレクションを返します。
context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
firstChild	最初の子ノードが親ノードである場合は、最初の子ノードを取得します。ノードの種類が `attribute` の場合は `null` を返します。
hasChildNodes	この XML ノードに子ノードがあるかどうかを取得します。属性ノードは子を持つことができないため、常に属性ノードの `false` を返します。
lastChild	これが親ノードである場合は、最後の子ノードを取得します。ノードの種類が `attribute` の場合は `null` を返します。
level	この XML 要素が段落の一部であるか、段落であるか、表のセル内に含まれているか、表の行が含まれているかを取得します。ノードの種類が `attribute` の場合は `null` を返します。
namespaceUri	この XML ノードのスキーマ名前空間の Uniform Resource Identifier (URI) を取得します。
nextSibling	この XML ノードと同じ階層にあるドキュメント内の次の要素を取得します。ノードの種類が `attribute` の場合は `null` を返します。
ownerDocument	この XML ノードの親ドキュメントを取得します。
parentNode	この XML ノードの親要素を取得します。
placeholderText	この要素にテキストが含まれない場合に表示されるテキストを指定します。属性ノードではなく、要素ノードにのみ適用されます。
previousSibling	この XML ノードと同じレベルにあるドキュメント内の前の要素を取得します。ノードの種類が `attribute` の場合は `null` を返します。
range	この XML ノードに含まれているドキュメントの部分を取得します。ノードの種類が `attribute` の場合は `null` を返します。
text	XML 要素内に含まれるテキストを指定します。ノード型が `attribute` の場合は空の文字列を返します。
type	ノードのタイプを取得します。
validationErrorText	この `XmlNode` オブジェクトの検証エラーの説明を取得します。属性ノードには意味がない可能性があります。
validationStatus	添付されたスキーマに従ってこの要素が有効かどうかを取得します。属性ノードには意味がない可能性があります。
value	この XML ノードの値を指定します。要素ノードの場合、テキストコンテンツを表します。属性ノードの場合、属性値を表します。

メソッド

copy()	この XML ノード (XML マークアップを除く) をクリップボードにコピーします。属性ノードで、属性値のみをテキストとしてコピーします。
cut()	この XML ノードをドキュメントから削除し、クリップボードに配置します。属性ノードで、親要素から属性を削除し、属性値のみをテキストとしてクリップボードにコピーします。
delete()	XML ドキュメントから XML ノードを削除します。要素ノードの場合、要素全体とその内容を削除します。属性ノードに対して、親要素から属性を削除します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
removeChild(childElement)	この XML ノードから子要素を削除します。ノードタイプが `attribute` の場合、このメソッドは効果がありません (属性ノードには子要素がないため)。
selectNodes(xPath, options)	XPath パラメーターに一致するすべての子要素を、この XML ノード内に表示される順序で返します。ノード・タイプが`attribute`の場合は`null`を返します(属性ノードには検索する子要素がないため)。
selectSingleNode(xPath, options)	この XML ノード内の XPath パラメーターに一致する最初の子要素を返します。ノード・タイプが`attribute`の場合は`null`を返します(属性ノードには検索する子要素がないため)。
setValidationError(status, options)	この XML ノードについてユーザーに表示される検証エラーテキストと、ノードを無効として報告するように Word に強制するかどうかを変更します。属性ノードには意味がない可能性があります。
setValidationError(status, options)	この XML ノードについてユーザーに表示される検証エラーテキストと、ノードを無効として報告するように Word に強制するかどうかを変更します。属性ノードには意味がない可能性があります。
toJSON()	API オブジェクトが `JSON.stringify()` に渡されるときに、より有用な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (次に、`JSON.stringify`渡されたオブジェクトの `toJSON` メソッドを呼び出します)。元の `Word.XmlNode` オブジェクトが API オブジェクトであるのに対し、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `Word.Interfaces.XmlNodeData` と型指定) を返します。
track()	ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。このオブジェクトを `.sync` 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクトコレクションにオブジェクトを追加する必要があります。このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
untrack()	前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。追跡対象オブジェクトが多いとホストアプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。メモリリリースを有効にする前に、 `context.sync()` を呼び出す必要があります。
validate()	ドキュメントに添付されている XML スキーマに対してこの XML ノードを検証します。属性ノードには意味がない可能性があります。

attributes

この XML ノードの属性を取得します。ノードの種類が attribute の場合は null を返します。

readonly attributes: Word.XmlNodeCollection;

プロパティ値

Word.XmlNodeCollection

注釈

API セット: WordApiDesktop 1.4

baseName

プレフィックスなしで要素の名前を取得します。

readonly baseName: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.4

childNodes

この XML ノードの子要素を取得します。ノード型が attribute の場合は空のコレクションを返します。

readonly childNodes: Word.XmlNodeCollection;

プロパティ値

Word.XmlNodeCollection

注釈

API セット: WordApiDesktop 1.4

context

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

context: RequestContext;

プロパティ値

Word.RequestContext

firstChild

最初の子ノードが親ノードである場合は、最初の子ノードを取得します。ノードの種類が attribute の場合は null を返します。

readonly firstChild: Word.XmlNode;

プロパティ値

Word.XmlNode

注釈

API セット: WordApiDesktop 1.4

hasChildNodes

この XML ノードに子ノードがあるかどうかを取得します。属性ノードは子を持つことができないため、常に属性ノードの false を返します。

readonly hasChildNodes: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

lastChild

これが親ノードである場合は、最後の子ノードを取得します。ノードの種類が attribute の場合は null を返します。

readonly lastChild: Word.XmlNode;

プロパティ値

Word.XmlNode

注釈

API セット: WordApiDesktop 1.4

level

この XML 要素が段落の一部であるか、段落であるか、表のセル内に含まれているか、表の行が含まれているかを取得します。ノードの種類が attribute の場合は null を返します。

readonly level: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell";

プロパティ値

Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell"

注釈

API セット: WordApiDesktop 1.4

namespaceUri

この XML ノードのスキーマ名前空間の Uniform Resource Identifier (URI) を取得します。

readonly namespaceUri: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.4

nextSibling

この XML ノードと同じ階層にあるドキュメント内の次の要素を取得します。ノードの種類が attribute の場合は null を返します。

readonly nextSibling: Word.XmlNode;

プロパティ値

Word.XmlNode

注釈

API セット: WordApiDesktop 1.4

ownerDocument

この XML ノードの親ドキュメントを取得します。

readonly ownerDocument: Word.Document;

プロパティ値

Word.Document

注釈

API セット: WordApiDesktop 1.4

parentNode

この XML ノードの親要素を取得します。

readonly parentNode: Word.XmlNode;

プロパティ値

Word.XmlNode

注釈

API セット: WordApiDesktop 1.4

placeholderText

この要素にテキストが含まれない場合に表示されるテキストを指定します。属性ノードではなく、要素ノードにのみ適用されます。

placeholderText: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.4

previousSibling

この XML ノードと同じレベルにあるドキュメント内の前の要素を取得します。ノードの種類が attribute の場合は null を返します。

readonly previousSibling: Word.XmlNode;

プロパティ値

Word.XmlNode

注釈

API セット: WordApiDesktop 1.4

range

この XML ノードに含まれているドキュメントの部分を取得します。ノードの種類が attribute の場合は null を返します。

readonly range: Word.Range;

プロパティ値

Word.Range

注釈

API セット: WordApiDesktop 1.4

text

XML 要素内に含まれるテキストを指定します。ノード型が attribute の場合は空の文字列を返します。

text: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.4

type

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

ノードのタイプを取得します。

readonly type: Word.XmlNodeType | "Element" | "Attribute";

プロパティ値

Word.XmlNodeType | "Element" | "Attribute"

注釈

API セット: WordApi ベータ版 (プレビューのみ)

validationErrorText

この XmlNode オブジェクトの検証エラーの説明を取得します。属性ノードには意味がない可能性があります。

readonly validationErrorText: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.4

validationStatus

添付されたスキーマに従ってこの要素が有効かどうかを取得します。属性ノードには意味がない可能性があります。

readonly validationStatus: Word.XmlValidationStatus | "Ok" | "Custom";

プロパティ値

Word.XmlValidationStatus | "Ok" | "Custom"

注釈

API セット: WordApiDesktop 1.4

value

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

この XML ノードの値を指定します。要素ノードの場合、テキストコンテンツを表します。属性ノードの場合、属性値を表します。

value: string;

プロパティ値

string

注釈

API セット: WordApi ベータ版 (プレビューのみ)

copy()

この XML ノード (XML マークアップを除く) をクリップボードにコピーします。属性ノードで、属性値のみをテキストとしてコピーします。

copy(): void;

返品

void

注釈

API セット: WordApiDesktop 1.4

cut()

この XML ノードをドキュメントから削除し、クリップボードに配置します。属性ノードで、親要素から属性を削除し、属性値のみをテキストとしてクリップボードにコピーします。

cut(): void;

返品

void

注釈

API セット: WordApiDesktop 1.4

delete()

XML ドキュメントから XML ノードを削除します。要素ノードの場合、要素全体とその内容を削除します。属性ノードに対して、親要素から属性を削除します。

delete(): void;

返品

void

注釈

API セット: WordApiDesktop 1.4

load(options)

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

load(options?: Word.Interfaces.XmlNodeLoadOptions): Word.XmlNode;

パラメーター

options: Word.Interfaces.XmlNodeLoadOptions

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

返品

Word.XmlNode

load(propertyNames)

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

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

パラメーター

propertyNames: string | string[]

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

返品

Word.XmlNode

load(propertyNamesAndPaths)

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

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

パラメーター

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

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

返品

Word.XmlNode

removeChild(childElement)

この XML ノードから子要素を削除します。ノードタイプが attribute の場合、このメソッドは効果がありません (属性ノードには子要素がないため)。

removeChild(childElement: Word.XmlNode): void;

パラメーター

childElement: Word.XmlNode

削除する子要素。

返品

void

注釈

API セット: WordApiDesktop 1.4

selectNodes(xPath, options)

XPath パラメーターに一致するすべての子要素を、この XML ノード内に表示される順序で返します。ノード・タイプがattributeの場合はnullを返します(属性ノードには検索する子要素がないため)。

selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection;

パラメーター

xPath: string

評価する XPath 式。

options: Word.SelectNodesOptions

省略可能。 XPath 検索の構成オプション。

返品

Word.XmlNodeCollection

XPath 式に一致する XML ノードのコレクション。

注釈

API セット: WordApiDesktop 1.4

selectSingleNode(xPath, options)

この XML ノード内の XPath パラメーターに一致する最初の子要素を返します。ノード・タイプがattributeの場合はnullを返します(属性ノードには検索する子要素がないため)。

selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode;

パラメーター

xPath: string

評価する XPath 式。

options: Word.SelectSingleNodeOptions

省略可能。 XPath 検索の構成オプション。

返品

Word.XmlNode

XPath 式に一致する最初の XML ノード。一致するものが見つからない場合は null 。

注釈

API セット: WordApiDesktop 1.4

setValidationError(status, options)

この XML ノードについてユーザーに表示される検証エラーテキストと、ノードを無効として報告するように Word に強制するかどうかを変更します。属性ノードには意味がない可能性があります。

setValidationError(status: Word.XmlValidationStatus, options?: Word.XmlNodeSetValidationErrorOptions): void;

パラメーター

status: Word.XmlValidationStatus

設定する検証状態。

options: Word.XmlNodeSetValidationErrorOptions

省略可能。検証エラーを設定するための構成オプション。

返品

void

注釈

API セット: WordApiDesktop 1.4

setValidationError(status, options)

この XML ノードについてユーザーに表示される検証エラーテキストと、ノードを無効として報告するように Word に強制するかどうかを変更します。属性ノードには意味がない可能性があります。

setValidationError(status: "Ok" | "Custom", options?: Word.XmlNodeSetValidationErrorOptions): void;

パラメーター

status: "Ok" | "Custom"

設定する検証状態。

options: Word.XmlNodeSetValidationErrorOptions

省略可能。検証エラーを設定するための構成オプション。

返品

void

注釈

API セット: WordApiDesktop 1.4

toJSON()

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

toJSON(): Word.Interfaces.XmlNodeData;

返品

Word.Interfaces.XmlNodeData

track()

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

track(): Word.XmlNode;

返品

Word.XmlNode

untrack()

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

untrack(): Word.XmlNode;

返品

Word.XmlNode

validate()

ドキュメントに添付されている XML スキーマに対してこの XML ノードを検証します。属性ノードには意味がない可能性があります。

validate(): void;

返品

void

注釈

API セット: WordApiDesktop 1.4

注釈

使用元

プロパティ

メソッド

プロパティの詳細

attributes

プロパティ値

注釈

baseName

プロパティ値

注釈

childNodes

プロパティ値

注釈

context

プロパティ値

firstChild

プロパティ値

注釈

hasChildNodes

プロパティ値

注釈

lastChild

プロパティ値

注釈

level

プロパティ値

注釈

namespaceUri

プロパティ値

注釈

nextSibling

プロパティ値

注釈

ownerDocument

プロパティ値

注釈

parentNode

プロパティ値

注釈

placeholderText

プロパティ値

注釈

previousSibling

プロパティ値

注釈

range

プロパティ値

注釈

text

プロパティ値

注釈

type

プロパティ値

注釈

validationErrorText

プロパティ値

注釈

validationStatus

プロパティ値

注釈

value

プロパティ値

注釈

メソッドの詳細

copy()

返品

注釈

cut()

返品

注釈

delete()

返品

注釈

load(options)

パラメーター

返品

load(propertyNames)

パラメーター