Excel.NamedItemArrayValues class

名前付き項目の値と型を含むオブジェクトを表します。

Extends

注釈

[ API セット: ExcelApi 1.7 ]

プロパティ

context

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

types

名前付き項目配列内の各項目の型を表します

values

名前付きアイテムの配列に含まれる各アイテムの値を表します。読み取り専用。

valuesAsJson

この名前付き項目配列内の値の JSON 表現。 NamedItemArrayValues.valuesAsJsonとは異なりNamedItemArrayValues.values、セルに含めることができるすべてのデータ型がサポートされています。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常に en-US ロケールと一致します。 ユーザーの表示ロケールでデータを取得するには、 を使用 NamedItemArrayValues.valuesAsJsonLocalします。

valuesAsJsonLocal

この名前付き項目配列内の値の JSON 表現。 NamedItemArrayValues.valuesAsJsonLocalとは異なりNamedItemArrayValues.values、セルに含めることができるすべてのデータ型がサポートされています。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常にユーザーの表示ロケールと一致します。 ロケールに依存しないデータを取得するには、 を使用します NamedItemArrayValues.valuesAsJson

メソッド

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

types

名前付き項目配列内の各項目の型を表します

readonly types: Excel.RangeValueType[][];

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

values

名前付きアイテムの配列に含まれる各アイテムの値を表します。読み取り専用。

readonly values: any[][];

プロパティ値

any[][]

注釈

[ API セット: ExcelApi 1.7 ]

valuesAsJson

この名前付き項目配列内の値の JSON 表現。 NamedItemArrayValues.valuesAsJsonとは異なりNamedItemArrayValues.values、セルに含めることができるすべてのデータ型がサポートされています。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常に en-US ロケールと一致します。 ユーザーの表示ロケールでデータを取得するには、 を使用 NamedItemArrayValues.valuesAsJsonLocalします。

readonly valuesAsJson: CellValue[][];

プロパティ値

注釈

[ API セット: ExcelApi 1.16 ]

valuesAsJsonLocal

この名前付き項目配列内の値の JSON 表現。 NamedItemArrayValues.valuesAsJsonLocalとは異なりNamedItemArrayValues.values、セルに含めることができるすべてのデータ型がサポートされています。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常にユーザーの表示ロケールと一致します。 ロケールに依存しないデータを取得するには、 を使用します NamedItemArrayValues.valuesAsJson

readonly valuesAsJsonLocal: CellValue[][];

プロパティ値

注釈

[ API セット: ExcelApi 1.16 ]

メソッドの詳細

load(options)

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

load(options?: Excel.Interfaces.NamedItemArrayValuesLoadOptions): Excel.NamedItemArrayValues;

パラメーター

options
Excel.Interfaces.NamedItemArrayValuesLoadOptions

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

戻り値

load(propertyNames)

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

load(propertyNames?: string | string[]): Excel.NamedItemArrayValues;

パラメーター

propertyNames

string | string[]

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

戻り値

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.NamedItemArrayValues;

パラメーター

propertyNamesAndPaths

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

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

戻り値

toJSON()

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

toJSON(): Excel.Interfaces.NamedItemArrayValuesData;

戻り値