Excel.Interfaces.NamedItemLoadOptions interface
セルまたは値の範囲の定義済みの名前を表します。 名前には、プリミティブの名前付きオブジェクト (次の型を参照)、範囲オブジェクト、または範囲への参照を指定できます。 このオブジェクトを使用して、名前に関連付けられた範囲オブジェクトを取得することができます。
プロパティ
| $all | 読み込みオプションに |
| array |
名前付きアイテムの値と型を含むオブジェクトを返します。 |
| comment | この名前に関連付けられているコメントを指定します。 |
| formula | 名前付きアイテムの数式。 数式は常に等号 ("=") で始まります。 |
| name | オブジェクトの名前。 |
| scope | 名前をブックまたは特定のワークシートのどちらにスコープするかを指定します。 指定可能な値は Worksheet、Workbook です。 |
| type | 名前の数式によって返される値の型を指定します。 詳細は「 |
| value | 名前の数式で計算された値を表します。 名前付き範囲の場合は、範囲アドレスが返されます。 この API は #VALUE! を返します。 ユーザー定義の関数を参照する場合は、エラーが Excel UI に表示されます。 |
| value |
この名前付きアイテムの値の JSON 表現。
|
| value |
この名前付きアイテムの値の JSON 表現。
|
| visible | オブジェクトが表示されるかどうかを指定します。 |
| worksheet | 名前付きのアイテムの対象になるワークシートを返します。 アイテムのスコープがブックに対して設定されている場合は、エラーをスローします。 |
| worksheet |
名前付きアイテムのスコープが設定されているワークシートを返します。 アイテムのスコープがブックに設定されている場合、このメソッドは |
プロパティの詳細
$all
読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.address など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。
$all?: boolean;プロパティ値
boolean
arrayValues
名前付きアイテムの値と型を含むオブジェクトを返します。
arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;プロパティ値
注釈
comment
formula
name
scope
名前をブックまたは特定のワークシートのどちらにスコープするかを指定します。 指定可能な値は Worksheet、Workbook です。
scope?: boolean;プロパティ値
boolean
注釈
type
名前の数式によって返される値の型を指定します。 詳細は「Excel.NamedItemType」をご覧ください。
type?: boolean;プロパティ値
boolean
注釈
API セット: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error;1.7 for Array
value
名前の数式で計算された値を表します。 名前付き範囲の場合は、範囲アドレスが返されます。 この API は #VALUE! を返します。 ユーザー定義の関数を参照する場合は、エラーが Excel UI に表示されます。
value?: boolean;プロパティ値
boolean
注釈
valueAsJson
この名前付きアイテムの値の JSON 表現。
NamedItem.value
とは異なり、NamedItem.valueAsJson はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常に en-US ロケールに合わせて調整されます。 ユーザーの表示ロケールでデータを取得するには、 NamedItem.valueAsJsonLocal を使用します。
valueAsJson?: boolean;プロパティ値
boolean
注釈
valueAsJsonLocal
この名前付きアイテムの値の JSON 表現。
NamedItem.value
とは異なり、NamedItem.valueAsJsonLocal はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常にユーザーの表示ロケールに合わせて調整されます。 ロケールに関係なくデータを取得するには、 NamedItem.valueAsJson を使用します。
valueAsJsonLocal?: boolean;プロパティ値
boolean
注釈
visible
worksheet
名前付きのアイテムの対象になるワークシートを返します。 アイテムのスコープがブックに対して設定されている場合は、エラーをスローします。
worksheet?: Excel.Interfaces.WorksheetLoadOptions;プロパティ値
注釈
worksheetOrNullObject
名前付きアイテムのスコープが設定されているワークシートを返します。 アイテムのスコープがブックに設定されている場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。
worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;