Excel.Interfaces.NamedItemData interface

パッケージ:

excel

namedItem.toJSON() を呼び出すことによって返されるデータを記述するインターフェイス。

プロパティ

arrayValues	名前付きアイテムの値と型を含むオブジェクトを返します。
comment	この名前に関連付けられているコメントを指定します。
formula	名前付き項目の数式。 数式は常に等号 ("=") で始まります。
name	オブジェクトの名前。
scope	名前の範囲をブックまたは特定のワークシートに指定するかどうかを指定します。 使用可能な値は、ワークシート、ブックです。
type	名前の数式によって返される値の型を指定します。 詳細は「Excel.NamedItemType」をご覧ください。
value	名前の数式で計算された値を表します。 名前付き範囲の場合、範囲アドレスが返されます。 この API は、#VALUE を返します。 ユーザー定義関数を参照している場合は、Excel UI でエラーが発生します。
valueAsJson	この名前付き項目内の値の JSON 表現。 NamedItem.value とは異なり、NamedItem.valueAsJsonではセルに含めることができるすべてのデータ型がサポートされます。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常に en-US ロケールと一致します。 ユーザーの表示ロケールでデータを取得するには、 NamedItem.valueAsJsonLocalを使用します。
valueAsJsonLocal	この名前付き項目内の値の JSON 表現。 NamedItem.value とは異なり、NamedItem.valueAsJsonLocalではセルに含めることができるすべてのデータ型がサポートされます。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常にユーザーの表示ロケールと一致します。 ロケールに依存しないデータを取得するには、 NamedItem.valueAsJsonを使用します。
visible	オブジェクトが表示されるかどうかを指定します。

プロパティの詳細

arrayValues

名前付きアイテムの値と型を含むオブジェクトを返します。

arrayValues?: Excel.Interfaces.NamedItemArrayValuesData;

プロパティ値

Excel.Interfaces.NamedItemArrayValuesData

注釈

[ API セット: ExcelApi 1.7 ]

comment

この名前に関連付けられているコメントを指定します。

comment?: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.4 ]

formula

名前付き項目の数式。 数式は常に等号 ("=") で始まります。

formula?: any;

プロパティ値

any

注釈

[ API セット: ExcelApi 1.7 ]

name

オブジェクトの名前。

name?: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.1 ]

scope

名前の範囲をブックまたは特定のワークシートに指定するかどうかを指定します。 使用可能な値は、ワークシート、ブックです。

scope?: Excel.NamedItemScope | "Worksheet" | "Workbook";

プロパティ値

Excel.NamedItemScope | "Worksheet" | "Workbook"

注釈

[ API セット: ExcelApi 1.4 ]

type

名前の数式によって返される値の型を指定します。 詳細は「Excel.NamedItemType」をご覧ください。

type?: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";

プロパティ値

Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array"

注釈

[ API set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 for Array ]

value

名前の数式で計算された値を表します。 名前付き範囲の場合、範囲アドレスが返されます。 この API は、#VALUE を返します。 ユーザー定義関数を参照している場合は、Excel UI でエラーが発生します。

value?: any;

プロパティ値

any

注釈

[ API セット: ExcelApi 1.1 ]

valueAsJson

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

valueAsJson?: CellValue | string;

プロパティ値

Excel.CellValue | string

注釈

[ API セット: ExcelApi 1.16 ]

valueAsJsonLocal

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

valueAsJsonLocal?: CellValue | string;

プロパティ値

Excel.CellValue | string

注釈

[ API セット: ExcelApi 1.16 ]

visible

オブジェクトが表示されるかどうかを指定します。

visible?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]