Excel.Interfaces.RangeCollectionLoadOptions interface

注釈

[ API セット: ExcelApi 1.9 ]

プロパティ

$all

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

address

コレクション内の各項目の場合: 範囲参照を A1 スタイルで指定します。 アドレス値にはシート参照が含まれます (例: "Sheet1!A1:B4")。

addressLocal

コレクション内の各項目の場合: ユーザーの言語で指定した範囲の範囲参照を表します。

cellCount

コレクション内の各項目について: 範囲内のセルの数を指定します。 セルの数が 2^31-1 (2,147,483,647) を超えると、この API は -1 を返します。

columnCount

コレクション内の各項目の場合: 範囲内の列の合計数を指定します。

columnHidden

コレクション内の各項目について: 現在の範囲のすべての列が非表示かどうかを表します。 値は、 true 範囲内のすべての列が非表示の場合です。 値は、 false 範囲内の列が非表示でない場合です。 値は、 null 範囲内の一部の列が非表示であり、同じ範囲内の他の列が非表示でない場合です。

columnIndex

コレクション内の各項目の場合: 範囲内の最初のセルの列番号を指定します。 0 を起点とする番号になります。

dataValidation

コレクション内の各項目について: データ検証オブジェクトを返します。

format

コレクション内の各項目について: 範囲のフォント、塗りつぶし、罫線、配置、およびその他のプロパティをカプセル化して、書式オブジェクトを返します。

formulas

コレクション内の各項目の場合: A1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりに値が返されます。

formulasLocal

コレクション内の各項目の場合: ユーザーの言語と数値書式のロケールで、A1 スタイル表記の数式を表します。 たとえば、英語の数式 "=SUM(A1, 1.5)" は、ドイツ語では "=SUMME(A1; 1,5)" になります。 セルに数式がない場合は、代わりに値が返されます。

formulasR1C1

コレクション内の各項目の場合: R1C1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりに値が返されます。

hasSpill

コレクション内の各項目について: すべてのセルにスピル罫線があるかどうかを表します。 trueすべてのセルにスピル罫線がある場合、またはfalseすべてのセルにスピル罫線がない場合は を返します。 範囲内に null スピル境界があるセルとスピル境界のないセルがある場合は、 を返します。

height

コレクション内の各項目について: 範囲の上端から範囲の下端までの 100% ズームの距離をポイント単位で返します。

hidden

コレクション内の各項目について: 現在の範囲内のすべてのセルが非表示かどうかを表します。 値は、 true 範囲内のすべてのセルが非表示の場合です。 値は、 false 範囲内のセルが非表示でない場合です。 値は、 null 範囲内の一部のセルが非表示で、同じ範囲内の他のセルが非表示にならない場合です。

hyperlink

コレクション内の各項目の場合: 現在の範囲のハイパーリンクを表します。

isEntireColumn

コレクション内の各項目について: 現在の範囲が列全体であるかどうかを表します。

isEntireRow

コレクション内の各項目について: 現在の範囲が行全体であるかどうかを表します。

left

コレクション内の各項目について: ワークシートの左端から範囲の左端までの 100% ズームの距離をポイント単位で返します。

linkedDataTypeState

コレクション内の各項目について: 各セルのデータ型の状態を表します。

numberFormat

コレクション内の各項目: 指定された範囲の Excel の数値書式コードを表します。 Excel の数値書式の詳細については、「数値書式 コード」を参照してください。

numberFormatCategories

コレクション内の各項目について: 各セルの数値形式のカテゴリを表します。

numberFormatLocal

コレクション内の各項目について: ユーザーの言語設定に基づいて、指定された範囲の Excel の数値書式コードを表します。 プロパティの取得または設定時に、Excel では言語や書式の強制は numberFormatLocal 実行されません。 返されるテキストは、システム設定で指定された言語に基づいて、ローカル形式の文字列を使用します。

rowCount

コレクション内の各項目について: 範囲内の行の合計数を返します。

rowHidden

コレクション内の各項目について: 現在の範囲のすべての行が非表示かどうかを表します。 値は、 true 範囲内のすべての行が非表示の場合です。 値は、 false 範囲内の行が非表示の場合です。 値は、 null 範囲内の一部の行が非表示で、同じ範囲内の他の行が非表示にならない場合です。

rowIndex

コレクション内の各項目の場合: 範囲内の最初のセルの行番号を返します。 0 を起点とする番号になります。

savedAsArray

コレクション内の各項目について: すべてのセルを配列数式として保存するかどうかを表します。 trueすべてのセルを配列数式として保存する場合、またはfalseすべてのセルを配列数式として保存しない場合は を返します。 一部の null セルが配列数式として保存され、一部が保存されない場合は を返します。

style

コレクション内の各項目の場合: 現在の範囲のスタイルを表します。 セルのスタイルに一貫性がない場合は、 null が返されます。 カスタム スタイルの場合、スタイル名が返されます。 組み込みのスタイルの場合、列挙型の BuiltInStyle 値を表す文字列が返されます。

text

コレクション内の各項目の場合: 指定した範囲のテキスト値。 テキスト値は、セルの幅には依存しません。 Excel UI で発生する数値記号 (#) の置換は、API によって返されるテキスト値には影響しません。

top

コレクション内の各項目について: ワークシートの上端から範囲の上端までの 100% ズームの距離をポイント単位で返します。

values

コレクション内の各項目について: 指定した範囲の生の値を表します。 返されるデータは、文字列、数値、またはブール値のいずれかです。 エラーが含まれているセルは、エラー文字列を返します。 返される値が正符号 ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。

valuesAsJson

コレクション内の各項目の場合: この範囲内のセル内の値の JSON 表現。 Range.valuesAsJsonとは異なりRange.values、セルに含めることができるすべてのデータ型がサポートされています。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常に en-US ロケールと一致します。 ユーザーの表示ロケールでデータを取得するには、 を使用 Range.valuesAsJsonLocalします。

valuesAsJsonLocal

コレクション内の各項目の場合: この範囲内のセル内の値の JSON 表現。 Range.valuesAsJsonLocalとは異なりRange.values、セルに含めることができるすべてのデータ型がサポートされています。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常にユーザーの表示ロケールと一致します。 ロケールに依存しないデータを取得するには、 を使用します Range.valuesAsJson

valueTypes

コレクション内の各項目について: 各セル内のデータの種類を指定します。

width

コレクション内の各項目について: 範囲の左端から範囲の右端までの 100% ズームの距離をポイント単位で返します。

worksheet

コレクション内の各項目: 現在の範囲を含むワークシート。

プロパティの詳細

$all

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

$all?: boolean;

プロパティ値

boolean

address

コレクション内の各項目の場合: 範囲参照を A1 スタイルで指定します。 アドレス値にはシート参照が含まれます (例: "Sheet1!A1:B4")。

address?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

addressLocal

コレクション内の各項目の場合: ユーザーの言語で指定した範囲の範囲参照を表します。

addressLocal?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

cellCount

コレクション内の各項目について: 範囲内のセルの数を指定します。 セルの数が 2^31-1 (2,147,483,647) を超えると、この API は -1 を返します。

cellCount?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

columnCount

コレクション内の各項目の場合: 範囲内の列の合計数を指定します。

columnCount?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

columnHidden

コレクション内の各項目について: 現在の範囲のすべての列が非表示かどうかを表します。 値は、 true 範囲内のすべての列が非表示の場合です。 値は、 false 範囲内の列が非表示でない場合です。 値は、 null 範囲内の一部の列が非表示であり、同じ範囲内の他の列が非表示でない場合です。

columnHidden?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.2 ]

columnIndex

コレクション内の各項目の場合: 範囲内の最初のセルの列番号を指定します。 0 を起点とする番号になります。

columnIndex?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

dataValidation

コレクション内の各項目について: データ検証オブジェクトを返します。

dataValidation?: Excel.Interfaces.DataValidationLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

format

コレクション内の各項目について: 範囲のフォント、塗りつぶし、罫線、配置、およびその他のプロパティをカプセル化して、書式オブジェクトを返します。

format?: Excel.Interfaces.RangeFormatLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

formulas

コレクション内の各項目の場合: A1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりに値が返されます。

formulas?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

formulasLocal

コレクション内の各項目の場合: ユーザーの言語と数値書式のロケールで、A1 スタイル表記の数式を表します。 たとえば、英語の数式 "=SUM(A1, 1.5)" は、ドイツ語では "=SUMME(A1; 1,5)" になります。 セルに数式がない場合は、代わりに値が返されます。

formulasLocal?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

formulasR1C1

コレクション内の各項目の場合: R1C1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりに値が返されます。

formulasR1C1?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.2 ]

hasSpill

コレクション内の各項目について: すべてのセルにスピル罫線があるかどうかを表します。 trueすべてのセルにスピル罫線がある場合、またはfalseすべてのセルにスピル罫線がない場合は を返します。 範囲内に null スピル境界があるセルとスピル境界のないセルがある場合は、 を返します。

hasSpill?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.12 ]

height

コレクション内の各項目について: 範囲の上端から範囲の下端までの 100% ズームの距離をポイント単位で返します。

height?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.10 ]

hidden

コレクション内の各項目について: 現在の範囲内のすべてのセルが非表示かどうかを表します。 値は、 true 範囲内のすべてのセルが非表示の場合です。 値は、 false 範囲内のセルが非表示でない場合です。 値は、 null 範囲内の一部のセルが非表示で、同じ範囲内の他のセルが非表示にならない場合です。

hidden?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.2 ]

コレクション内の各項目の場合: 現在の範囲のハイパーリンクを表します。

hyperlink?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

isEntireColumn

コレクション内の各項目について: 現在の範囲が列全体であるかどうかを表します。

isEntireColumn?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

isEntireRow

コレクション内の各項目について: 現在の範囲が行全体であるかどうかを表します。

isEntireRow?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

left

コレクション内の各項目について: ワークシートの左端から範囲の左端までの 100% ズームの距離をポイント単位で返します。

left?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.10 ]

linkedDataTypeState

コレクション内の各項目について: 各セルのデータ型の状態を表します。

linkedDataTypeState?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

numberFormat

コレクション内の各項目: 指定された範囲の Excel の数値書式コードを表します。 Excel の数値書式の詳細については、「数値書式 コード」を参照してください。

numberFormat?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

numberFormatCategories

コレクション内の各項目について: 各セルの数値形式のカテゴリを表します。

numberFormatCategories?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.12 ]

numberFormatLocal

コレクション内の各項目について: ユーザーの言語設定に基づいて、指定された範囲の Excel の数値書式コードを表します。 プロパティの取得または設定時に、Excel では言語や書式の強制は numberFormatLocal 実行されません。 返されるテキストは、システム設定で指定された言語に基づいて、ローカル形式の文字列を使用します。

numberFormatLocal?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

rowCount

コレクション内の各項目について: 範囲内の行の合計数を返します。

rowCount?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

rowHidden

コレクション内の各項目について: 現在の範囲のすべての行が非表示かどうかを表します。 値は、 true 範囲内のすべての行が非表示の場合です。 値は、 false 範囲内の行が非表示の場合です。 値は、 null 範囲内の一部の行が非表示で、同じ範囲内の他の行が非表示にならない場合です。

rowHidden?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.2 ]

rowIndex

コレクション内の各項目の場合: 範囲内の最初のセルの行番号を返します。 0 を起点とする番号になります。

rowIndex?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

savedAsArray

コレクション内の各項目について: すべてのセルを配列数式として保存するかどうかを表します。 trueすべてのセルを配列数式として保存する場合、またはfalseすべてのセルを配列数式として保存しない場合は を返します。 一部の null セルが配列数式として保存され、一部が保存されない場合は を返します。

savedAsArray?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.12 ]

style

コレクション内の各項目の場合: 現在の範囲のスタイルを表します。 セルのスタイルに一貫性がない場合は、 null が返されます。 カスタム スタイルの場合、スタイル名が返されます。 組み込みのスタイルの場合、列挙型の BuiltInStyle 値を表す文字列が返されます。

style?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

text

コレクション内の各項目の場合: 指定した範囲のテキスト値。 テキスト値は、セルの幅には依存しません。 Excel UI で発生する数値記号 (#) の置換は、API によって返されるテキスト値には影響しません。

text?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

top

コレクション内の各項目について: ワークシートの上端から範囲の上端までの 100% ズームの距離をポイント単位で返します。

top?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.10 ]

values

コレクション内の各項目について: 指定した範囲の生の値を表します。 返されるデータは、文字列、数値、またはブール値のいずれかです。 エラーが含まれているセルは、エラー文字列を返します。 返される値が正符号 ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。

values?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

valuesAsJson

コレクション内の各項目の場合: この範囲内のセル内の値の JSON 表現。 Range.valuesAsJsonとは異なりRange.values、セルに含めることができるすべてのデータ型がサポートされています。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常に en-US ロケールと一致します。 ユーザーの表示ロケールでデータを取得するには、 を使用 Range.valuesAsJsonLocalします。

valuesAsJson?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.16 ]

valuesAsJsonLocal

コレクション内の各項目の場合: この範囲内のセル内の値の JSON 表現。 Range.valuesAsJsonLocalとは異なりRange.values、セルに含めることができるすべてのデータ型がサポートされています。 たとえば、標準のブール値、数値、および文字列値に加えて、書式設定された数値と Web イメージが含まれます。 この API から返されるデータは、常にユーザーの表示ロケールと一致します。 ロケールに依存しないデータを取得するには、 を使用します Range.valuesAsJson

valuesAsJsonLocal?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.16 ]

valueTypes

コレクション内の各項目について: 各セル内のデータの種類を指定します。

valueTypes?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

width

コレクション内の各項目について: 範囲の左端から範囲の右端までの 100% ズームの距離をポイント単位で返します。

width?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.10 ]

worksheet

コレクション内の各項目: 現在の範囲を含むワークシート。

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]