Word.XmlMapping class
Word の XML マッピングを表します。ContentControl オブジェクトを、カスタム XML とそのコンテンツ コントロールの間で容易にします。 XML マッピングは、コンテンツ コントロール内の文字列と、このドキュメントのカスタム XML データ ストア内の XML 要素とのリンクです。
- Extends
注釈
使用元
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| custom |
ドキュメント内のコンテンツ コントロールのマップ先となるデータ ストア内のカスタム XML ノードを表す |
| custom |
ドキュメント内のコンテンツ コントロールのマップ先のカスタム XML パーツを表す |
| is |
ドキュメント内のコンテンツ コントロールがドキュメントの XML データ ストア内の XML ノードにマップされているかどうかを返します。 |
| prefix |
現在の XML マッピングの XPath を評価するために使用されるプレフィックス マッピングを返します。 |
| xpath | 現在マップされている XML ノードに評価される XML マッピングの XPath を返します。 |
メソッド
| delete() | 親コンテンツ コントロールから XML マッピングを削除します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| set |
コンテンツ コントロールで XML マッピングを作成または変更できます。 |
| set |
コンテンツ コントロールで XML データ マッピングを作成または変更できます。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
customXmlNode
ドキュメント内のコンテンツ コントロールのマップ先となるデータ ストア内のカスタム XML ノードを表す CustomXmlNode オブジェクトを返します。
readonly customXmlNode: Word.CustomXmlNode;プロパティ値
注釈
customXmlPart
ドキュメント内のコンテンツ コントロールのマップ先のカスタム XML パーツを表す CustomXmlPart オブジェクトを返します。
readonly customXmlPart: Word.CustomXmlPart;プロパティ値
注釈
isMapped
ドキュメント内のコンテンツ コントロールがドキュメントの XML データ ストア内の XML ノードにマップされているかどうかを返します。
readonly isMapped: boolean;プロパティ値
boolean
注釈
prefixMappings
現在の XML マッピングの XPath を評価するために使用されるプレフィックス マッピングを返します。
readonly prefixMappings: string;プロパティ値
string
注釈
xpath
現在マップされている XML ノードに評価される XML マッピングの XPath を返します。
readonly xpath: string;プロパティ値
string
注釈
メソッドの詳細
delete()
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.XmlMappingLoadOptions): Word.XmlMapping;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.XmlMapping;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.XmlMapping;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.XmlMappingUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Word.Interfaces.XmlMappingUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.XmlMapping): void;パラメーター
- properties
- Word.XmlMapping
返品
void
setMapping(xPath, options)
コンテンツ コントロールで XML マッピングを作成または変更できます。
setMapping(xPath: string, options?: Word.XmlSetMappingOptions): OfficeExtension.ClientResult<boolean>;パラメーター
- xPath
-
string
評価する XPath 式。
- options
- Word.XmlSetMappingOptions
省略可能。 XML マッピングの設定に使用できるオプション。
返品
OfficeExtension.ClientResult<boolean>
注釈
setMappingByNode(node)
コンテンツ コントロールで XML データ マッピングを作成または変更できます。
setMappingByNode(node: Word.CustomXmlNode): OfficeExtension.ClientResult<boolean>;パラメーター
- node
- Word.CustomXmlNode
マップするカスタム XML ノード。
返品
OfficeExtension.ClientResult<boolean>
注釈
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.XmlMapping オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.XmlMappingData と型指定) を返します。
toJSON(): Word.Interfaces.XmlMappingData;返品
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.XmlMapping;返品
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。
untrack(): Word.XmlMapping;