Excel.Interfaces.NamedItemData interface

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

注釈

使用元

プロパティ

arrayValues

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

comment

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

formula

名前付きアイテムの数式。 数式は常に等号 ("=") で始まります。

name

オブジェクトの名前。

scope

名前をブックまたは特定のワークシートのどちらにスコープするかを指定します。 指定可能な値は Worksheet、Workbook です。

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;

プロパティ値

注釈

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

名前をブックまたは特定のワークシートのどちらにスコープするかを指定します。 指定可能な値は Worksheet、Workbook です。

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 セット: 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