Excel.FunctionResult class
関数の評価操作の結果を含むオブジェクト
- Extends
注釈
[API セット: ExcelApi 1.2]
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| error | エラーを表すエラー値 ("#DIV/0" など)。 エラー文字列が設定されていない場合、関数は成功し、その結果が [値] フィールドに書き込まれます。 エラーは常に英語のロケールにあります。 |
| value | 関数の評価の値。 値フィールドには、エラーが発生していない (つまり、Error プロパティが設定されていない) 場合にのみ設定されます。 |
メソッド
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
error
エラーを表すエラー値 ("#DIV/0" など)。 エラー文字列が設定されていない場合、関数は成功し、その結果が [値] フィールドに書き込まれます。 エラーは常に英語のロケールにあります。
readonly error: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.2]
value
関数の評価の値。 値フィールドには、エラーが発生していない (つまり、Error プロパティが設定されていない) 場合にのみ設定されます。
readonly value: T;
プロパティ値
T
注釈
[API セット: ExcelApi 1.2]
メソッドの詳細
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.FunctionResultLoadOptions): FunctionResult<T>;
パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): FunctionResult<T>;
パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): FunctionResult<T>;
パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の FunctionResult<T> オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Interfaces.FunctionResultData<T> と型指定) を返します。
toJSON(): Interfaces.FunctionResultData<T>;