Excel.Interfaces.NamedItemLoadOptions interface

  • リファレンス
パッケージ:
excel

セルまたは値の範囲の定義済みの名前を表します。 名前には、プリミティブの名前付きオブジェクト (以下の型に示すように)、範囲オブジェクト、または範囲への参照を指定できます。 このオブジェクトを使用して、名前に関連付けられた範囲オブジェクトを取得することができます。

注釈

[ API セット: ExcelApi 1.1 ]

プロパティ

$all

LoadOptions に $all を指定すると、すべてのスカラー プロパティ (例: Range.address) が読み込まれますが、ナビゲーション プロパティ (例: Range.format.fill.color) は読み込まれません。
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

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

名前付きのアイテムの対象になるワークシートを返します。 アイテムのスコープがブックの代わりにある場合は、エラーをスローします。
worksheetOrNullObject

名前付き項目のスコープを設定するワークシートを返します。 アイテムのスコープがブックの場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

プロパティの詳細

$all

LoadOptions に $all を指定すると、すべてのスカラー プロパティ (例: Range.address) が読み込まれますが、ナビゲーション プロパティ (例: Range.format.fill.color) は読み込まれません。

$all?: boolean;

プロパティ値

boolean

arrayValues

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

arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;

プロパティ値

Excel.Interfaces.NamedItemArrayValuesLoadOptions

注釈

[ API セット: ExcelApi 1.7 ]

comment

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

comment?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.4 ]

formula

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

formula?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

name

オブジェクトの名前。

name?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

scope

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

scope?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.4 ]

type

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

type?: boolean;

プロパティ値

boolean

注釈

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

value

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

value?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

valueAsJson

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

valueAsJson?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.16 ]

valueAsJsonLocal

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

valueAsJsonLocal?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.16 ]

visible

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

visible?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

worksheet

名前付きのアイテムの対象になるワークシートを返します。 アイテムのスコープがブックの代わりにある場合は、エラーをスローします。

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

プロパティ値

Excel.Interfaces.WorksheetLoadOptions

注釈

[ API セット: ExcelApi 1.4 ]

worksheetOrNullObject

名前付き項目のスコープを設定するワークシートを返します。 アイテムのスコープがブックの場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;

プロパティ値

Excel.Interfaces.WorksheetLoadOptions

注釈

[ API セット: ExcelApi 1.4 ]