Excel.Interfaces.RangeLoadOptions interface

範囲は、セル、行、列、セルのブロックなど、1 つ以上の連続したセルのセットを表します。 API 全体で範囲がどのように使用されるかの詳細については、まず Excel JavaScript API の範囲を参照してください。

プロパティ

$all

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

address

範囲参照を A1 スタイルで指定します。 アドレスの値にシート参照が含まれています (例: "Sheet1!A1:B4")。

addressLocal

指定した範囲の範囲参照をユーザーの言語で表します。

cellCount

範囲内のセルの数を指定します。 セルの数が 2^31-1 (2,147,483,647) を超えると、この API は -1 を返します。

columnCount

範囲内の列の総数を指定します。

columnIndex

範囲内の最初のセルの列番号を指定します。 0 を起点とする番号になります。

format

Format オブジェクト (範囲のフォント、塗りつぶし、罫線、配置などのプロパティをカプセル化するオブジェクト) を返します。

formulas

A1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりにその値が返されます。

formulasLocal

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

numberFormat

指定された範囲に対する Excel の数値書式コードを表します。 Excel の数値の書式設定の詳細については、「 数値の書式コード」を参照してください。

rowCount

範囲に含まれる行の合計数を返します。

rowIndex

範囲に含まれる最初のセルの行番号を返します。 0 を起点とする番号になります。

text

指定した範囲のテキスト値。 テキスト値は、セルの幅には依存しません。 Excel UI で行われる数値記号 (#) 置換は、API によって返されるテキスト値には影響しません。

values

指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値を指定できます。 エラーが含まれているセルは、エラー文字列を返します。 返された値がプラス ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。 ロケール形式の文字列 (たとえば、nl-NL または fr-FR の日付 "19-8-2025"、形式 DD-MM-YYYY) は、日付としてではなくテキストとして保存されます。 日付が日付として格納されるようにするには、 formulasLocal などのロケール対応 API を使用するか、ISO (YYYY-MM-DD) または数値日付シリアルなどのロケールに依存しない形式を使用します。

valueTypes

各セルのデータ型を指定します。

worksheet

現在の範囲を含んでいるワークシート。

プロパティの詳細

$all

読み込みオプションに $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

columnIndex

範囲内の最初のセルの列番号を指定します。 0 を起点とする番号になります。

columnIndex?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

format

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

numberFormat

指定された範囲に対する Excel の数値書式コードを表します。 Excel の数値の書式設定の詳細については、「 数値の書式コード」を参照してください。

numberFormat?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

rowCount

範囲に含まれる行の合計数を返します。

rowCount?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

rowIndex

範囲に含まれる最初のセルの行番号を返します。 0 を起点とする番号になります。

rowIndex?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

text

指定した範囲のテキスト値。 テキスト値は、セルの幅には依存しません。 Excel UI で行われる数値記号 (#) 置換は、API によって返されるテキスト値には影響しません。

text?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

values

指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値を指定できます。 エラーが含まれているセルは、エラー文字列を返します。 返された値がプラス ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。 ロケール形式の文字列 (たとえば、nl-NL または fr-FR の日付 "19-8-2025"、形式 DD-MM-YYYY) は、日付としてではなくテキストとして保存されます。 日付が日付として格納されるようにするには、 formulasLocal などのロケール対応 API を使用するか、ISO (YYYY-MM-DD) または数値日付シリアルなどのロケールに依存しない形式を使用します。

values?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

valueTypes

各セルのデータ型を指定します。

valueTypes?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

worksheet

現在の範囲を含んでいるワークシート。

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.1