Office.CustomXmlPrefixMappings interface
CustomXmlPart オブジェクトのコレクションを表します。
メソッド
| add |
アイテムのクエリを実行するときに使用するプレフィックスを名前空間マッピングに非同期で追加します。 |
| add |
アイテムのクエリを実行するときに使用するプレフィックスを名前空間マッピングに非同期で追加します。 |
| get |
指定したプレフィックスにマップされた名前空間を非同期で取得します。 |
| get |
指定したプレフィックスにマップされた名前空間を非同期で取得します。 |
| get |
指定した名前空間のプレフィックスを非同期で取得します。 |
| get |
指定した名前空間のプレフィックスを非同期で取得します。 |
メソッドの詳細
addNamespaceAsync(prefix, ns, options, callback)
アイテムのクエリを実行するときに使用するプレフィックスを名前空間マッピングに非同期で追加します。
addNamespaceAsync(prefix: string, ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;パラメーター
- prefix
-
string
プレフィックスのマッピング リストに追加するプレフィックスを指定します。 必須です。
- ns
-
string
新しく追加したプレフィックスに割り当てる名前空間 URI を指定します。 必須です。
- options
- Office.AsyncContextOptions
コールバックで使用するために、任意の種類のコンテキスト データを変更されないまま保持するためのオプションを提供します。
- callback
-
(result: Office.AsyncResult<void>) => void
省略可能。 コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。
返品
void
注釈
要件セット: CustomXmlParts
要求されたプレフィックスに名前空間が割り当てられていない場合は、空の文字列 ("") が返されます。
addNamespaceAsync(prefix, ns, callback)
アイテムのクエリを実行するときに使用するプレフィックスを名前空間マッピングに非同期で追加します。
addNamespaceAsync(prefix: string, ns: string, callback?: (result: AsyncResult<void>) => void): void;パラメーター
- prefix
-
string
プレフィックスのマッピング リストに追加するプレフィックスを指定します。 必須です。
- ns
-
string
新しく追加したプレフィックスに割り当てる名前空間 URI を指定します。 必須です。
- callback
-
(result: Office.AsyncResult<void>) => void
省略可能。 コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。
返品
void
注釈
要件セット: CustomXmlParts
要求されたプレフィックスに名前空間が割り当てられていない場合は、空の文字列 ("") が返されます。
getNamespaceAsync(prefix, options, callback)
指定したプレフィックスにマップされた名前空間を非同期で取得します。
getNamespaceAsync(prefix: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;パラメーター
- prefix
-
string
名前空間を取得するプレフィックスを TSpecished します。 必須です。
- options
- Office.AsyncContextOptions
コールバックで使用するために、任意の種類のコンテキスト データを変更されないまま保持するためのオプションを提供します。
- callback
-
(result: Office.AsyncResult<string>) => void
省略可能。 コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。 結果の value プロパティは、指定されたプレフィックスにマップされた名前空間を含む文字列です。
返品
void
注釈
要件セット: CustomXmlParts
プレフィックスが既に名前空間マネージャーに存在する場合は、そのプレフィックスのマッピングが上書きされます。ただし、そのプレフィックスが、データ ストアによって内部的に追加または使用されている場合は除きます。この場合、エラーが返されます。
getNamespaceAsync(prefix, callback)
指定したプレフィックスにマップされた名前空間を非同期で取得します。
getNamespaceAsync(prefix: string, callback?: (result: AsyncResult<string>) => void): void;パラメーター
- prefix
-
string
名前空間を取得するプレフィックスを TSpecished します。 必須です。
- callback
-
(result: Office.AsyncResult<string>) => void
省略可能。 コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。 結果の value プロパティは、指定されたプレフィックスにマップされた名前空間を含む文字列です。
返品
void
注釈
要件セット: CustomXmlParts
プレフィックスが既に名前空間マネージャーに存在する場合は、そのプレフィックスのマッピングが上書きされます。ただし、そのプレフィックスが、データ ストアによって内部的に追加または使用されている場合は除きます。この場合、エラーが返されます。
getPrefixAsync(ns, options, callback)
指定した名前空間のプレフィックスを非同期で取得します。
getPrefixAsync(ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;パラメーター
- ns
-
string
プレフィックスを取得する名前空間を指定します。 必須です。
- options
- Office.AsyncContextOptions
コールバックで使用するために、任意の種類のコンテキスト データを変更されないまま保持するためのオプションを提供します。
- callback
-
(result: Office.AsyncResult<string>) => void
省略可能。 コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。 結果の value プロパティは、指定された名前空間のプレフィックスを含む文字列です。
返品
void
注釈
要件セット: CustomXmlParts
要求した名前空間にプレフィックスが割り当てられていない場合は、空の文字列 ("") が返されます。 名前空間マネージャーに複数のプレフィックスが指定されている場合は、指定した名前空間に一致する最初のプレフィックスが返されます。
getPrefixAsync(ns, callback)
指定した名前空間のプレフィックスを非同期で取得します。
getPrefixAsync(ns: string, callback?: (result: AsyncResult<string>) => void): void;パラメーター
- ns
-
string
プレフィックスを取得する名前空間を指定します。 必須です。
- callback
-
(result: Office.AsyncResult<string>) => void
省略可能。 コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。 結果の value プロパティは、指定された名前空間のプレフィックスを含む文字列です。
返品
void
注釈
要件セット: CustomXmlParts
要求した名前空間にプレフィックスが割り当てられていない場合は、空の文字列 ("") が返されます。 名前空間マネージャーに複数のプレフィックスが指定されている場合は、指定した名前空間に一致する最初のプレフィックスが返されます。