Excel.Interfaces.RangeLoadOptions interface
範囲は、セル、行、列、セルのブロックなど、1 つ以上の連続したセルのセットを表します。 API 全体で範囲がどのように使用されるかの詳細については、まず Excel JavaScript API の範囲を参照してください。
プロパティ
| $all | 読み込みオプションに |
| address | 範囲参照を A1 スタイルで指定します。 アドレスの値にシート参照が含まれています (例: "Sheet1!A1:B4")。 |
| address |
指定した範囲の範囲参照をユーザーの言語で表します。 |
| cell |
範囲内のセルの数を指定します。 セルの数が 2^31-1 (2,147,483,647) を超えると、この API は -1 を返します。 |
| column |
範囲内の列の総数を指定します。 |
| column |
現在の範囲内のすべての列が非表示になっているかどうかを表します。 範囲内のすべての列が非表示の場合、値は |
| column |
範囲内の最初のセルの列番号を指定します。 0 を起点とする番号になります。 |
| data |
dataValidation オブジェクトを返します。 |
| format | Format オブジェクト (範囲のフォント、塗りつぶし、罫線、配置などのプロパティをカプセル化するオブジェクト) を返します。 |
| formulas | A1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりにその値が返されます。 |
| formulas |
ユーザーの言語と数値書式ロケールで、A1 スタイル表記の数式を表します。 たとえば、英語の数式 "=SUM(A1, 1.5)" は、ドイツ語では "=SUMME(A1; 1,5)" になります。 セルに数式がない場合は、代わりにその値が返されます。 |
| formulasR1C1 | R1C1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりにその値が返されます。 |
| height | 100% ズームの場合、範囲の上端から範囲の下端までの距離をポイント単位で返します。 |
| hidden | 現在の範囲内のすべてのセルが非表示になっているかどうかを表します。 値は、範囲内のすべてのセルが非表示になっている場合に |
| hyperlink | 現在の範囲のハイパーリンクを表します。 |
| is |
現在の範囲が列全体であるかどうかを表します。 |
| is |
現在の範囲が行全体であるかどうかを表します。 |
| left | 100% ズームの場合、ワークシートの左端から範囲の左端までの距離をポイント単位で返します。 |
| linked |
各セルのデータ型の状態を表します。 |
| number |
指定された範囲に対する Excel の数値書式コードを表します。 Excel の数値の書式設定の詳細については、「 数値の書式コード」を参照してください。 |
| number |
ユーザーの言語設定に基づいた、指定された範囲に対する Excel の数値書式コードを表します。 Excel は、 |
| row |
範囲に含まれる行の合計数を返します。 |
| row |
現在の範囲内のすべての行が非表示になっているかどうかを表します。 範囲内のすべての行が非表示の場合、値が |
| row |
範囲に含まれる最初のセルの行番号を返します。 0 を起点とする番号になります。 |
| style | 現在の範囲のスタイルを表します。 セルのスタイルに一貫性がない場合は、 |
| text | 指定した範囲のテキスト値。 テキスト値は、セルの幅には依存しません。 Excel UI で行われる数値記号 (#) 置換は、API によって返されるテキスト値には影響しません。 |
| top | 100% ズームの場合、ワークシートの上端から範囲の上端までの距離をポイント単位で返します。 |
| values | 指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値を指定できます。 エラーが含まれているセルは、エラー文字列を返します。 返された値がプラス ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。 ロケール形式の文字列 (たとえば、nl-NL または fr-FR の日付 "19-8-2025"、形式 DD-MM-YYYY) は、日付としてではなくテキストとして保存されます。 日付が日付として格納されるようにするには、 |
| value |
各セルのデータ型を指定します。 |
| width | 100% ズームの場合、範囲の左端から範囲の右端までの距離をポイント単位で返します。 |
| worksheet | 現在の範囲を含んでいるワークシート。 |
プロパティの詳細
$all
読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.address など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。
$all?: boolean;プロパティ値
boolean
address
範囲参照を A1 スタイルで指定します。 アドレスの値にシート参照が含まれています (例: "Sheet1!A1:B4")。
address?: boolean;プロパティ値
boolean
注釈
addressLocal
cellCount
範囲内のセルの数を指定します。 セルの数が 2^31-1 (2,147,483,647) を超えると、この API は -1 を返します。
cellCount?: boolean;プロパティ値
boolean
注釈
columnCount
columnHidden
現在の範囲内のすべての列が非表示になっているかどうかを表します。 範囲内のすべての列が非表示の場合、値は true されます。 値は、範囲内に非表示の列がない場合に false されます。 範囲内の一部の列が非表示になっていて、同じ範囲内の他の列が非表示でない場合、値は null されます。
columnHidden?: boolean;プロパティ値
boolean
注釈
columnIndex
範囲内の最初のセルの列番号を指定します。 0 を起点とする番号になります。
columnIndex?: boolean;プロパティ値
boolean
注釈
dataValidation
dataValidation オブジェクトを返します。
dataValidation?: Excel.Interfaces.DataValidationLoadOptions;プロパティ値
注釈
format
Format オブジェクト (範囲のフォント、塗りつぶし、罫線、配置などのプロパティをカプセル化するオブジェクト) を返します。
format?: Excel.Interfaces.RangeFormatLoadOptions;プロパティ値
注釈
formulas
A1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりにその値が返されます。
formulas?: boolean;プロパティ値
boolean
注釈
formulasLocal
ユーザーの言語と数値書式ロケールで、A1 スタイル表記の数式を表します。 たとえば、英語の数式 "=SUM(A1, 1.5)" は、ドイツ語では "=SUMME(A1; 1,5)" になります。 セルに数式がない場合は、代わりにその値が返されます。
formulasLocal?: boolean;プロパティ値
boolean
注釈
formulasR1C1
R1C1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりにその値が返されます。
formulasR1C1?: boolean;プロパティ値
boolean
注釈
height
100% ズームの場合、範囲の上端から範囲の下端までの距離をポイント単位で返します。
height?: boolean;プロパティ値
boolean
注釈
hidden
現在の範囲内のすべてのセルが非表示になっているかどうかを表します。 値は、範囲内のすべてのセルが非表示になっている場合に true されます。 範囲内の非表示セルがない場合は、値が false されます。 値は、範囲内の一部のセルが非表示になっていて、同じ範囲内の他のセルが非表示でない場合に null されます。
hidden?: boolean;プロパティ値
boolean
注釈
hyperlink
isEntireColumn
isEntireRow
left
100% ズームの場合、ワークシートの左端から範囲の左端までの距離をポイント単位で返します。
left?: boolean;プロパティ値
boolean
注釈
linkedDataTypeState
numberFormat
指定された範囲に対する Excel の数値書式コードを表します。 Excel の数値の書式設定の詳細については、「 数値の書式コード」を参照してください。
numberFormat?: boolean;プロパティ値
boolean
注釈
numberFormatLocal
ユーザーの言語設定に基づいた、指定された範囲に対する Excel の数値書式コードを表します。 Excel は、 numberFormatLocal プロパティを取得または設定するときに、いかなる言語または形式の強制も実行しません。 返されるすべてのテキストは、システム設定で指定された言語に基づいて、ローカルで書式設定された文字列を使用します。
numberFormatLocal?: boolean;プロパティ値
boolean
注釈
rowCount
rowHidden
現在の範囲内のすべての行が非表示になっているかどうかを表します。 範囲内のすべての行が非表示の場合、値が true されます。 値は、範囲内に非表示の行がない場合に false されます。 値 null 範囲内の一部の行が非表示になっていて、同じ範囲内の他の行が非表示でない場合に値がされます。
rowHidden?: boolean;プロパティ値
boolean
注釈
rowIndex
style
現在の範囲のスタイルを表します。 セルのスタイルに一貫性がない場合は、 null が返されます。 カスタム スタイルの場合は、スタイル名が返されます。 組み込みスタイルの場合は、 BuiltInStyle 列挙型の値を表す文字列が返されます。
style?: boolean;プロパティ値
boolean
注釈
text
指定した範囲のテキスト値。 テキスト値は、セルの幅には依存しません。 Excel UI で行われる数値記号 (#) 置換は、API によって返されるテキスト値には影響しません。
text?: boolean;プロパティ値
boolean
注釈
top
100% ズームの場合、ワークシートの上端から範囲の上端までの距離をポイント単位で返します。
top?: boolean;プロパティ値
boolean
注釈
values
指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値を指定できます。 エラーが含まれているセルは、エラー文字列を返します。 返された値がプラス ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。 ロケール形式の文字列 (たとえば、nl-NL または fr-FR の日付 "19-8-2025"、形式 DD-MM-YYYY) は、日付としてではなくテキストとして保存されます。 日付が日付として格納されるようにするには、 formulasLocal などのロケール対応 API を使用するか、ISO (YYYY-MM-DD) または数値日付シリアルなどのロケールに依存しない形式を使用します。
values?: boolean;プロパティ値
boolean
注釈
valueTypes
width
100% ズームの場合、範囲の左端から範囲の右端までの距離をポイント単位で返します。
width?: boolean;プロパティ値
boolean
注釈
worksheet
現在の範囲を含んでいるワークシート。
worksheet?: Excel.Interfaces.WorksheetLoadOptions;