Excel.Interfaces.NamedItemCollectionLoadOptions interface
ブックまたはワークシートの一部であるすべての NamedItem オブジェクトのコレクション。到達方法に応じて異なります。
注釈
プロパティ
| $all | 読み込みオプションに |
| array |
コレクション内の各項目の場合: 名前付き項目の値と型を含むオブジェクトを返します。 |
| comment | コレクション内の各項目について: この名前に関連付けられているコメントを指定します。 |
| formula | コレクション内の各項目の場合: 名前付き項目の数式。 数式は常に等号 ("=") で始まります。 |
| name | コレクション内の各項目の場合: オブジェクトの名前。 |
| scope | コレクション内の各項目の場合: 名前の範囲をブックまたは特定のワークシートに指定するかどうかを指定します。 使用可能な値は、ワークシート、ブックです。 |
| 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
コレクション内の各項目について: この名前に関連付けられているコメントを指定します。
comment?: boolean;プロパティ値
boolean
注釈
formula
コレクション内の各項目の場合: 名前付き項目の数式。 数式は常に等号 ("=") で始まります。
formula?: boolean;プロパティ値
boolean
注釈
name
scope
コレクション内の各項目の場合: 名前の範囲をブックまたは特定のワークシートに指定するかどうかを指定します。 使用可能な値は、ワークシート、ブックです。
scope?: boolean;プロパティ値
boolean
注釈
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
注釈
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
コレクション内の各項目に対して: オブジェクトが表示されるかどうかを指定します。
visible?: boolean;プロパティ値
boolean
注釈
worksheet
コレクション内の各項目について: 名前付き項目のスコープが設定されているワークシートを返します。 アイテムのスコープがブックの代わりにある場合は、エラーをスローします。
worksheet?: Excel.Interfaces.WorksheetLoadOptions;プロパティ値
注釈
worksheetOrNullObject
コレクション内の各項目について: 名前付き項目のスコープが設定されているワークシートを返します。 アイテムのスコープがブックの場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;