ExcelScript.RangeAreas interface
RangeAreas
は、同じワークシート内の 1 つ以上の四角形の範囲のコレクションを表します。
注釈
例
/**
* This script clears all the cells in the current worksheet that are displaying errors.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the used range on the current sheet.
const currentSheet = workbook.getActiveWorksheet();
const usedRange = currentSheet.getUsedRange();
// Get the RangeAreas object for each cell with a formula error.
const errorCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas, ExcelScript.SpecialCellValueType.errors);
// If there are any error cells, clear them.
if (errorCells) {
errorCells.clear();
}
}
メソッド
add |
コレクションに新しい条件付き書式を最初または最優先事項で追加します。 |
calculate() |
|
clear(apply |
この |
clear |
現在指定している範囲でアクティブなすべての条件付き書式をクリアする。 |
convert |
データ型を持つ |
copy |
セル データまたは書式設定をソース範囲または |
get |
A1 スタイルの |
get |
ユーザー ロケールの |
get |
この |
get |
この |
get |
|
get |
ID で識別される条件付き形式を返します。 条件付き書式オブジェクトが存在しない場合、このメソッドは |
get |
この |
get |
|
get |
|
get |
|
get |
|
get |
指定された範囲または |
get |
この |
get |
この |
get |
特定の行と列のオフセットによってシフトされる |
get |
この |
get |
指定した型と値に一致するすべてのセルを表す |
get |
この |
get |
|
get |
現在の |
set |
次の再計算が発生したときに再計算される |
set |
この |
メソッドの詳細
addConditionalFormat(type)
コレクションに新しい条件付き書式を最初または最優先事項で追加します。
addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;
パラメーター
追加される条件付き書式の種類。 詳細は「ExcelScript.ConditionalFormatType
」をご覧ください。
戻り値
calculate()
RangeAreas
内のすべてのセルを計算します。
calculate(): void;
戻り値
void
clear(applyTo)
この RangeAreas
オブジェクトを構成する各領域の値、書式、塗りつぶし、罫線、およびその他のプロパティをクリアします。
clear(applyTo?: ClearApplyTo): void;
パラメーター
- applyTo
- ExcelScript.ClearApplyTo
省略可能。 クリア操作の種類を決定します。 詳細は「ExcelScript.ClearApplyTo
」をご覧ください。 既定値は "All" です。
戻り値
void
例
/**
* This script clears all the cells in the current worksheet that are displaying errors.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the used range on the current sheet.
const currentSheet = workbook.getActiveWorksheet();
const usedRange = currentSheet.getUsedRange();
// Get the RangeAreas object for each cell with a formula error.
const errorCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas, ExcelScript.SpecialCellValueType.errors);
// If there are any error cells, clear them.
if (errorCells) {
errorCells.clear();
}
}
clearAllConditionalFormats()
現在指定している範囲でアクティブなすべての条件付き書式をクリアする。
clearAllConditionalFormats(): void;
戻り値
void
convertDataTypeToText()
データ型を持つ RangeAreas
内のすべてのセルをテキストに変換します。
convertDataTypeToText(): void;
戻り値
void
copyFrom(sourceRange, copyType, skipBlanks, transpose)
セル データまたは書式設定をソース範囲または RangeAreas
から現在の RangeAreas
にコピーします。 変換先の RangeAreas
は、ソース範囲または RangeAreas
とは異なるサイズにすることができます。 コピー先がソースより小さい場合は、自動的に展開されます。
copyFrom(
sourceRange: Range | RangeAreas | string,
copyType?: RangeCopyType,
skipBlanks?: boolean,
transpose?: boolean
): void;
パラメーター
- sourceRange
-
ExcelScript.Range | ExcelScript.RangeAreas | string
コピー元の範囲またはコピー元の RangeAreas
。 ソース RangeAreas
に複数の範囲がある場合は、四角形の範囲から完全な行または列を削除してフォームを作成できる必要があります。
- copyType
- ExcelScript.RangeCopyType
コピーするセル データまたは書式設定の種類。 既定値は "All" です。
- skipBlanks
-
boolean
True の場合は、ソース範囲または RangeAreas
の空白のセルをスキップします。 既定値は false です。
- transpose
-
boolean
True の場合は、変換先の RangeAreas
内のセルを入れ替えます。 既定値は false です。
戻り値
void
getAddress()
A1 スタイルの RangeAreas
参照を返します。 アドレス値には、セルの四角形の各ブロックのワークシート名が含まれます (例: "Sheet1!A1:B4、Sheet1!D1:D4")。
getAddress(): string;
戻り値
string
getAddressLocal()
ユーザー ロケールの RangeAreas
参照を返します。
getAddressLocal(): string;
戻り値
string
getAreaCount()
この RangeAreas
オブジェクトを構成する四角形の範囲の数を返します。
getAreaCount(): number;
戻り値
number
getAreas()
getCellCount()
RangeAreas
オブジェクト内のセルの数を返し、個々のすべての四角形の範囲のセル数を合計します。 セル数が 2^31-1 (2,147,483,647) を超える場合、-1 を返します。
getCellCount(): number;
戻り値
number
getConditionalFormat(id)
ID で識別される条件付き形式を返します。 条件付き書式オブジェクトが存在しない場合、このメソッドは undefined
を返します。
getConditionalFormat(id: string): ConditionalFormat | undefined;
パラメーター
- id
-
string
条件付き書式の ID。
戻り値
ExcelScript.ConditionalFormat | undefined
getConditionalFormats()
この RangeAreas
オブジェクト内の任意のセルと交差する条件付き形式のコレクションを返します。
getConditionalFormats(): ConditionalFormat[];
戻り値
getDataValidation()
RangeAreas
内のすべての範囲のデータ検証オブジェクトを返します。
getDataValidation(): DataValidation;
戻り値
getEntireColumn()
RangeAreas
の列全体を表すRangeAreas
オブジェクトを返します (たとえば、現在のRangeAreas
がセル "B4:E11, H2" を表している場合、列 "B:E, H:H" を表すRangeAreas
を返します)。
getEntireColumn(): RangeAreas;
戻り値
getEntireRow()
RangeAreas
の行全体を表すRangeAreas
オブジェクトを返します (たとえば、現在のRangeAreas
がセル "B4:E11" を表している場合は、行 "4:11" を表すRangeAreas
を返します)。
getEntireRow(): RangeAreas;
戻り値
getFormat()
RangeAreas
オブジェクト内のすべての範囲のフォント、塗りつぶし、罫線、配置、およびその他のプロパティをカプセル化して、RangeFormat
オブジェクトを返します。
getFormat(): RangeFormat;
戻り値
例
/**
* This script finds and highlights all the cells in the current worksheet that contain a formula.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the used range on the current sheet.
const currentSheet = workbook.getActiveWorksheet();
const usedRange = currentSheet.getUsedRange();
// Get the RangeAreas object for each cell with a formula.
const formulaCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas);
// Add a light blue background to the cells containing formulas.
formulaCells.getFormat().getFill().setColor("#ADD8E6");
}
getIntersection(anotherRange)
指定された範囲またはRangeAreas
の積集合を表すRangeAreas
オブジェクトを返します。 積集合が見つからない場合、このメソッドは undefined
を返します。
getIntersection(anotherRange: Range | RangeAreas | string): RangeAreas;
パラメーター
- anotherRange
-
ExcelScript.Range | ExcelScript.RangeAreas | string
範囲、 RangeAreas
オブジェクト、または交差部分を決定するために使用されるアドレス。
戻り値
getIsEntireColumn()
この RangeAreas
オブジェクトのすべての範囲が列全体を表すかどうかを指定します (例: "A:C, Q:Z")。
getIsEntireColumn(): boolean;
戻り値
boolean
getIsEntireRow()
この RangeAreas
オブジェクトのすべての範囲が行全体を表すかどうかを指定します (例: "1:3, 5:7")。
getIsEntireRow(): boolean;
戻り値
boolean
getOffsetRangeAreas(rowOffset, columnOffset)
特定の行と列のオフセットによってシフトされる RangeAreas
オブジェクトを返します。 返された RangeAreas
の次元は、元のオブジェクトと一致します。 結果の RangeAreas
がワークシート グリッドの範囲外に強制された場合、エラーがスローされます。
getOffsetRangeAreas(
rowOffset: number,
columnOffset: number
): RangeAreas;
パラメーター
- rowOffset
-
number
RangeAreas
をオフセットする行数 (正、負、または 0)。 正の値は下方向、負の値は上方向のオフセットを表します。
- columnOffset
-
number
RangeAreas
をオフセットする列の数 (正、負、または 0)。 正の値は右方向、負の値は左方向のオフセットを表します。
戻り値
getPredefinedCellStyle()
この RangeAreas
オブジェクトのすべての範囲のスタイルを表します。 セルのスタイルに一貫性がない場合は、 null
が返されます。 カスタム スタイルの場合、スタイル名が返されます。 組み込みのスタイルの場合、 BuiltInStyle
列挙型の値を表す文字列が返されます。
getPredefinedCellStyle(): string;
戻り値
string
getSpecialCells(cellType, cellValueType)
指定した型と値に一致するすべてのセルを表す RangeAreas
オブジェクトを返します。 条件に一致する特殊なセルが見つからない場合、このメソッドは undefined
を返します。
getSpecialCells(
cellType: SpecialCellType,
cellValueType?: SpecialCellValueType
): RangeAreas;
パラメーター
- cellType
- ExcelScript.SpecialCellType
含めるセルの種類。
- cellValueType
- ExcelScript.SpecialCellValueType
cellType
がconstants
またはformulas
の場合、この引数を使用して、結果に含めるセルの種類を決定します。 これらの値を組み合わせて、複数の型を返すことができます。 この引数を省略すると、すべての定数および数式が対象になります。
戻り値
getTables(fullyContained)
この RangeAreas
オブジェクト内の任意の範囲と重複するテーブルのスコープ付きコレクションを返します。
getTables(fullyContained?: boolean): Table[];
パラメーター
- fullyContained
-
boolean
true
場合は、範囲内に完全に含まれるテーブルのみを返します。 既定値は false
です。
戻り値
getUsedRangeAreas(valuesOnly)
RangeAreas
オブジェクト内の個々の四角形の範囲のすべての使用領域を構成する使用RangeAreas
を返します。
RangeAreas
内に使用されているセルがない場合、このメソッドはundefined
を返します。
getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;
パラメーター
- valuesOnly
-
boolean
値を持つセルのみを使用セルと見なすかどうか。
戻り値
getWorksheet()
setDirty()
次の再計算が発生したときに再計算される RangeAreas
を設定します。
setDirty(): void;
戻り値
void
setPredefinedCellStyle(predefinedCellStyle)
この RangeAreas
オブジェクトのすべての範囲のスタイルを表します。 セルのスタイルに一貫性がない場合は、 null
が返されます。 カスタム スタイルの場合、スタイル名が返されます。 組み込みのスタイルの場合、 BuiltInStyle
列挙型の値を表す文字列が返されます。
setPredefinedCellStyle(predefinedCellStyle: string): void;
パラメーター
- predefinedCellStyle
-
string
戻り値
void
例
/**
* This script sets the cell style to "warning text"
* on every cell with a formula error.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the used range in the current worksheet.
const sheet = workbook.getActiveWorksheet();
const usedRange = sheet.getUsedRange();
// Get any cells that are displaying errors.
const errorCells = usedRange.getSpecialCells(
ExcelScript.SpecialCellType.formulas,
ExcelScript.SpecialCellValueType.errors
);
// Check if there are error cells before proceeding.
if (errorCells) {
// Use the built-in warning text style on the error cells.
errorCells.setPredefinedCellStyle(
ExcelScript.BuiltInStyle.warningText.toString()
);
} else {
console.log("No formula errors in the worksheet.");
}
}
Office Scripts