Excel.FunctionResult class

パッケージ:

excel

関数評価操作の結果を含むオブジェクト

Extends

OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.2 ]

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
error	エラーを表すエラー値 ("#DIV/0" など)。 エラー文字列が設定されていない場合、関数は成功し、その結果が Value フィールドに書き込まれます。 エラーは常に英語のロケールにあります。
value	関数評価の値。 値フィールドは、エラーが発生していない場合にのみ設定されます (つまり、Error プロパティが設定されていません)。

メソッド

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

error

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

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>;

パラメーター

options

Excel.Interfaces.FunctionResultLoadOptions

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

戻り値

Excel.FunctionResult<T>

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

Excel.FunctionResult<T>

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

Excel.FunctionResult<T>

toJSON()

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

toJSON(): Interfaces.FunctionResultData<T>;

戻り値

Excel.Interfaces.FunctionResultData<T>