Excel.Interfaces.RangeLoadOptions interface

パッケージ:

excel

範囲は、セル、行、列、セルのブロックなど、1 つ以上の連続したセルのセットを表します。 API 全体での範囲の使用方法の詳細については、 Excel JavaScript API の範囲から始めます。

注釈

[ API セット: ExcelApi 1.1 ]

プロパティ

$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	dataValidation オブジェクトを返します。
format	Format オブジェクト (範囲のフォント、塗りつぶし、罫線、配置などのプロパティをカプセル化するオブジェクト) を返します。
formulas	A1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりに値が返されます。
formulasLocal	ユーザーの言語と数値書式ロケールで、A1 スタイル表記の数式を表します。 たとえば、英語の数式 "=SUM(A1, 1.5)" は、ドイツ語では "=SUMME(A1; 1,5)" になります。 セルに数式がない場合は、代わりに値が返されます。
formulasR1C1	R1C1 スタイル表記の数式を表します。 セルに数式がない場合は、代わりに値が返されます。
hidden	現在の範囲内のすべてのセルが非表示かどうかを表します。 値は、範囲内のすべてのセルが非表示の場合に true されます。 値は、範囲内のセルが非表示でない場合に false されます。 値は、範囲内の一部のセルが非表示で、同じ範囲内の他のセルが非表示でない場合に null されます。
hyperlink	現在の範囲のハイパーリンクを表します。
isEntireColumn	現在の範囲が列全体であるかどうかを表します。
isEntireRow	現在の範囲が行全体であるかどうかを表します。
numberFormat	指定した範囲の Excel の数値書式コードを表します。 Excel の数値書式の詳細については、「数値書式 コード」を参照してください。
numberFormatLocal	ユーザーの言語設定に基づいて、指定した範囲の Excel の数値書式コードを表します。 excel では、 numberFormatLocal プロパティを取得または設定するときに、言語や書式の強制は実行されません。 返されるテキストは、システム設定で指定された言語に基づいて、ローカル形式の文字列を使用します。
rowCount	範囲に含まれる行の合計数を返します。
rowHidden	現在の範囲内のすべての行が非表示になっているかどうかを表します。 値は、範囲内のすべての行が非表示の場合に true されます。 値は、範囲内の行が非表示でない場合に false されます。 値は、範囲内の一部の行が非表示で、同じ範囲内の他の行が非表示でない場合に null されます。
rowIndex	範囲に含まれる最初のセルの行番号を返します。 0 を起点とする番号になります。
style	現在の範囲のスタイルを表します。 セルのスタイルに一貫性がない場合は、 null が返されます。 カスタム スタイルの場合、スタイル名が返されます。 組み込みのスタイルの場合、 BuiltInStyle 列挙型の値を表す文字列が返されます。
text	指定した範囲のテキスト値。 テキスト値は、セルの幅には依存しません。 Excel UI で発生する数値記号 (#) の置換は、API によって返されるテキスト値には影響しません。
values	指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値のいずれかです。 エラーが含まれているセルは、エラー文字列を返します。 返される値が正符号 ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。
valueTypes	各セル内のデータの種類を指定します。
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 オブジェクトを返します。

dataValidation?: Excel.Interfaces.DataValidationLoadOptions;

プロパティ値

Excel.Interfaces.DataValidationLoadOptions

注釈

[ API セット: ExcelApi 1.8 ]

format

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

format?: Excel.Interfaces.RangeFormatLoadOptions;

プロパティ値

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 ]

hidden

現在の範囲内のすべてのセルが非表示かどうかを表します。 値は、範囲内のすべてのセルが非表示の場合に true されます。 値は、範囲内のセルが非表示でない場合に false されます。 値は、範囲内の一部のセルが非表示で、同じ範囲内の他のセルが非表示でない場合に null されます。

hidden?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.2 ]

hyperlink

現在の範囲のハイパーリンクを表します。

hyperlink?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

isEntireColumn

現在の範囲が列全体であるかどうかを表します。

isEntireColumn?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

isEntireRow

現在の範囲が行全体であるかどうかを表します。

isEntireRow?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

numberFormat

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

numberFormat?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

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 ]

style

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

style?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

text

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

text?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

values

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

values?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

valueTypes

各セル内のデータの種類を指定します。

valueTypes?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

worksheet

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

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

プロパティ値

Excel.Interfaces.WorksheetLoadOptions

注釈

[ API セット: ExcelApi 1.1 ]