Excel.Interfaces.NamedItemCollectionLoadOptions interface

ブックまたはワークシートの一部であるすべての NamedItem オブジェクトのコレクション。到達方法に応じて異なります。

プロパティ

$all

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

arrayValues

コレクション内の各項目の場合: 名前付き項目の値と型を含むオブジェクトを返します。

comment

コレクション内の各項目について: この名前に関連付けられているコメントを指定します。

formula

コレクション内の各項目の場合: 名前付き項目の数式。 数式は常に等号 ("=") で始まります。

name

コレクション内の各項目の場合: オブジェクトの名前。

scope

コレクション内の各項目の場合: 名前の範囲をブックまたは特定のワークシートに指定するかどうかを指定します。 使用可能な値は、ワークシート、ブックです。

type

コレクション内の各項目の場合: 名前の数式によって返される値の型を指定します。 詳細は「Excel.NamedItemType」をご覧ください。

value

コレクション内の各項目について: 名前の数式によって計算された値を表します。 名前付き範囲の場合、範囲アドレスが返されます。 この API は、#VALUE を返します。 ユーザー定義関数を参照している場合は、Excel UI でエラーが発生します。

visible

コレクション内の各項目に対して: オブジェクトが表示されるかどうかを指定します。

worksheet

コレクション内の各項目について: 名前付き項目のスコープが設定されているワークシートを返します。 アイテムのスコープがブックの代わりにある場合は、エラーをスローします。

worksheetOrNullObject

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

プロパティの詳細

$all

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

$all?: boolean;

プロパティ値

boolean

arrayValues

コレクション内の各項目の場合: 名前付き項目の値と型を含むオブジェクトを返します。

arrayValues?: 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 セット: 文字列、Integer、Double、Boolean、Range、Error の ExcelApi 1.1。配列の場合は 1.7

value

コレクション内の各項目について: 名前の数式によって計算された値を表します。 名前付き範囲の場合、範囲アドレスが返されます。 この API は、#VALUE を返します。 ユーザー定義関数を参照している場合は、Excel UI でエラーが発生します。

value?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

visible

コレクション内の各項目に対して: オブジェクトが表示されるかどうかを指定します。

visible?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

worksheet

コレクション内の各項目について: 名前付き項目のスコープが設定されているワークシートを返します。 アイテムのスコープがブックの代わりにある場合は、エラーをスローします。

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.4

worksheetOrNullObject

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

worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.4