Excel.FunctionResult class

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

context: RequestContext;

プロパティ値

エラーを表すエラー値 ("#DIV/0" など)。 エラー文字列が設定されていない場合、関数は成功し、その結果が Value フィールドに書き込まれます。 エラーは常に英語のロケールにあります。

readonly error: string;

プロパティ値

注釈

[ API セット: ExcelApi 1.2 ]

関数評価の値。 値フィールドは、エラーが発生していない場合にのみ設定されます (つまり、Error プロパティが設定されていません)。

readonly value: T;

プロパティ値

注釈

[ API セット: ExcelApi 1.2 ]

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

load(options?: Excel.Interfaces.FunctionResultLoadOptions): FunctionResult<T>;

パラメーター

戻り値

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

load(propertyNames?: string | string[]): FunctionResult<T>;

パラメーター

戻り値

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): FunctionResult<T>;

パラメーター

戻り値

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

toJSON(): Interfaces.FunctionResultData<T>;

戻り値