Excel.RangeAreas class
RangeAreas は、同じワークシート内の 1 つ以上の四角形の範囲のコレクションを表します。 あいまいでない範囲を使用する方法については、「 Excel アドインで複数の範囲を同時に操作する」を参照してください。
- Extends
注釈
プロパティ
| address | A1 スタイルの |
| address |
ユーザー ロケールの |
| area |
この |
| areas | この |
| cell |
|
| conditional |
この |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| data |
|
| format |
|
| is |
この |
| is |
この |
| style | この |
| worksheet | 現在の |
メソッド
| calculate() |
|
| clear(apply |
この |
| clear(apply |
この |
| clear |
コントロールを含むセルに特に配慮して、範囲内のセルの値をクリアします。 範囲に空白の値のみが含まれており、コントロールが既定値に設定されている場合、値とコントロールの書式設定は削除されます。 それ以外の場合は、コントロールを持つセルを既定値に設定し、範囲内の他のセルの値をクリアします。 |
| convert |
データ型を持つ |
| convert |
|
| copy |
セル データまたは書式設定をソース範囲または |
| copy |
セル データまたは書式設定をソース範囲または |
| get |
|
| get |
|
| get |
指定された範囲または |
| get |
指定された範囲または |
| get |
特定の行と列のオフセットによってシフトされる |
| get |
指定した型と値に一致するすべてのセルを表す |
| get |
指定した型と値に一致するすべてのセルを表す |
| get |
指定した型と値に一致するすべてのセルを表す |
| get |
指定した型と値に一致するすべてのセルを表す |
| get |
この |
| get |
|
| get |
|
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| set |
次の再計算が発生したときに再計算される |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 |
プロパティの詳細
address
A1 スタイルの RangeAreas 参照を返します。 アドレス値には、セルの四角形の各ブロックのワークシート名が含まれます (例: "Sheet1!A1:B4、Sheet1!D1:D4")。
readonly address: string;プロパティ値
string
注釈
addressLocal
ユーザー ロケールの RangeAreas 参照を返します。
readonly addressLocal: string;プロパティ値
string
注釈
areaCount
この RangeAreas オブジェクトを構成する四角形の範囲の数を返します。
readonly areaCount: number;プロパティ値
number
注釈
areas
この RangeAreas オブジェクトを構成する四角形の範囲のコレクションを返します。
readonly areas: Excel.RangeCollection;プロパティ値
注釈
cellCount
RangeAreas オブジェクト内のセルの数を返し、個々のすべての四角形の範囲のセル数を合計します。 セル数が 2^31-1 (2,147,483,647) を超える場合、-1 を返します。
readonly cellCount: number;プロパティ値
number
注釈
conditionalFormats
この RangeAreas オブジェクト内の任意のセルと交差する条件付き形式のコレクションを返します。
readonly conditionalFormats: Excel.ConditionalFormatCollection;プロパティ値
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
dataValidation
RangeAreas
内のすべての範囲のデータ検証オブジェクトを返します。
readonly dataValidation: Excel.DataValidation;プロパティ値
注釈
format
RangeAreas オブジェクト内のすべての範囲のフォント、塗りつぶし、罫線、配置、およびその他のプロパティをカプセル化して、RangeFormat オブジェクトを返します。
readonly format: Excel.RangeFormat;プロパティ値
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();
const usedRange = sheet.getUsedRange();
// Find the ranges with formulas.
const formulaRanges = usedRange.getSpecialCells("Formulas");
formulaRanges.format.fill.color = "lightgreen";
await context.sync();
});
isEntireColumn
この RangeAreas オブジェクトのすべての範囲が列全体を表すかどうかを指定します (例: "A:C, Q:Z")。
readonly isEntireColumn: boolean;プロパティ値
boolean
注釈
isEntireRow
この RangeAreas オブジェクトのすべての範囲が行全体を表すかどうかを指定します (例: "1:3, 5:7")。
readonly isEntireRow: boolean;プロパティ値
boolean
注釈
style
この RangeAreas オブジェクトのすべての範囲のスタイルを表します。 セルのスタイルに一貫性がない場合は、 null が返されます。 カスタム スタイルの場合、スタイル名が返されます。 組み込みのスタイルの場合、 BuiltInStyle 列挙型の値を表す文字列が返されます。
style: string;プロパティ値
string
注釈
worksheet
現在の RangeAreasのワークシートを返します。
readonly worksheet: Excel.Worksheet;プロパティ値
注釈
メソッドの詳細
calculate()
clear(applyTo)
この RangeAreas オブジェクトを構成する各領域の値、書式、塗りつぶし、罫線、およびその他のプロパティをクリアします。
clear(applyTo?: Excel.ClearApplyTo): void;パラメーター
- applyTo
- Excel.ClearApplyTo
省略可能。 クリア操作の種類を決定します。 詳細は「Excel.ClearApplyTo」をご覧ください。 既定値は "All" です。
戻り値
void
注釈
clear(applyToString)
この RangeAreas オブジェクトを構成する各領域の値、書式、塗りつぶし、罫線、およびその他のプロパティをクリアします。
clear(applyToString?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void;パラメーター
- applyToString
-
"All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"
省略可能。 クリア操作の種類を決定します。 詳細は「Excel.ClearApplyTo」をご覧ください。 既定値は "All" です。
戻り値
void
注釈
clearOrResetContents()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
コントロールを含むセルに特に配慮して、範囲内のセルの値をクリアします。 範囲に空白の値のみが含まれており、コントロールが既定値に設定されている場合、値とコントロールの書式設定は削除されます。 それ以外の場合は、コントロールを持つセルを既定値に設定し、範囲内の他のセルの値をクリアします。
clearOrResetContents(): void;戻り値
void
注釈
convertDataTypeToText()
データ型を持つ RangeAreas 内のすべてのセルをテキストに変換します。
convertDataTypeToText(): void;戻り値
void
注釈
convertToLinkedDataType(serviceID, languageCulture)
RangeAreas内のすべてのセルをリンクされたデータ型に変換します。
convertToLinkedDataType(serviceID: number, languageCulture: string): void;パラメーター
- serviceID
-
number
データのクエリに使用されるサービス ID。
- languageCulture
-
string
サービスのクエリを実行する言語カルチャ。
戻り値
void
注釈
copyFrom(sourceRange, copyType, skipBlanks, transpose)
セル データまたは書式設定をソース範囲または RangeAreas から現在の RangeAreasにコピーします。 変換先の RangeAreas は、ソース範囲または RangeAreasとは異なるサイズにすることができます。 コピー先がソースより小さい場合は、自動的に展開されます。
copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void;パラメーター
- sourceRange
-
Excel.Range | Excel.RangeAreas | string
コピー元の範囲またはコピー元の RangeAreas 。 ソース RangeAreas に複数の範囲がある場合は、四角形の範囲から完全な行または列を削除してフォームを作成できる必要があります。
- copyType
- Excel.RangeCopyType
コピーするセル データまたは書式設定の種類。 既定値は "All" です。
- skipBlanks
-
boolean
True の場合は、ソース範囲または RangeAreasの空白のセルをスキップします。 既定値は false です。
- transpose
-
boolean
True の場合は、変換先の RangeAreas内のセルを入れ替えます。 既定値は false です。
戻り値
void
注釈
copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)
セル データまたは書式設定をソース範囲または RangeAreas から現在の RangeAreasにコピーします。 変換先の RangeAreas は、ソース範囲または RangeAreasとは異なるサイズにすることができます。 コピー先がソースより小さい場合は、自動的に展開されます。
copyFrom(sourceRange: Range | RangeAreas | string, copyTypeString?: "All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths", skipBlanks?: boolean, transpose?: boolean): void;パラメーター
- sourceRange
-
Excel.Range | Excel.RangeAreas | string
コピー元の範囲またはコピー元の RangeAreas 。 ソース RangeAreas に複数の範囲がある場合は、四角形の範囲から完全な行または列を削除してフォームを作成できる必要があります。
- copyTypeString
-
"All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths"
コピーするセル データまたは書式設定の種類。 既定値は "All" です。
- skipBlanks
-
boolean
True の場合は、ソース範囲または RangeAreasの空白のセルをスキップします。 既定値は false です。
- transpose
-
boolean
True の場合は、変換先の RangeAreas内のセルを入れ替えます。 既定値は false です。
戻り値
void
注釈
getEntireColumn()
RangeAreasの列全体を表すRangeAreas オブジェクトを返します (たとえば、現在のRangeAreasがセル "B4:E11, H2" を表している場合、列 "B:E, H:H" を表すRangeAreasを返します)。
getEntireColumn(): Excel.RangeAreas;戻り値
注釈
getEntireRow()
RangeAreasの行全体を表すRangeAreas オブジェクトを返します (たとえば、現在のRangeAreasがセル "B4:E11" を表している場合は、行 "4:11" を表すRangeAreasを返します)。
getEntireRow(): Excel.RangeAreas;戻り値
注釈
getIntersection(anotherRange)
指定された範囲またはRangeAreasの積集合を表すRangeAreas オブジェクトを返します。 積集合が見つからない場合は、 ItemNotFound エラーがスローされます。
getIntersection(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;パラメーター
- anotherRange
-
Excel.Range | Excel.RangeAreas | string
範囲、 RangeAreas オブジェクト、または範囲アドレス。交差部分の決定に使用されます。
戻り値
注釈
getIntersectionOrNullObject(anotherRange)
指定された範囲またはRangeAreasの積集合を表すRangeAreas オブジェクトを返します。 積集合が見つからない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getIntersectionOrNullObject(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;パラメーター
- anotherRange
-
Excel.Range | Excel.RangeAreas | string
範囲、 RangeAreas オブジェクト、または交差部分を決定するために使用されるアドレス。
戻り値
注釈
getOffsetRangeAreas(rowOffset, columnOffset)
特定の行と列のオフセットによってシフトされる RangeAreas オブジェクトを返します。 返された RangeAreas の次元は、元のオブジェクトと一致します。 結果の RangeAreas がワークシート グリッドの範囲外に強制された場合、エラーがスローされます。
getOffsetRangeAreas(rowOffset: number, columnOffset: number): Excel.RangeAreas;パラメーター
- rowOffset
-
number
RangeAreasをオフセットする行数 (正、負、または 0)。 正の値は下方向、負の値は上方向のオフセットを表します。
- columnOffset
-
number
RangeAreasをオフセットする列の数 (正、負、または 0)。 正の値は右方向、負の値は左方向のオフセットを表します。
戻り値
注釈
getSpecialCells(cellType, cellValueType)
指定した型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。 条件に一致する特別なセルが見つからない場合、エラーがスローされます。
getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;パラメーター
- cellType
- Excel.SpecialCellType
含めるセルの種類。
- cellValueType
- Excel.SpecialCellValueType
cellTypeがconstantsまたはformulasの場合、この引数を使用して、結果に含めるセルの種類を決定します。 これらの値を組み合わせて、複数の型を返すことができます。 この引数を省略すると、すべての定数および数式が対象になります。
戻り値
注釈
getSpecialCells(cellTypeString, cellValueTypeString)
指定した型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。 条件に一致する特別なセルが見つからない場合、エラーがスローされます。
getSpecialCells(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueTypeString?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;パラメーター
- cellTypeString
-
"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"
含めるセルの種類。
- cellValueTypeString
-
"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"
cellTypeがconstantsまたはformulasの場合、この引数を使用して、結果に含めるセルの種類を決定します。 これらの値を組み合わせて、複数の型を返すことができます。 この引数を省略すると、すべての定数および数式が対象になります。
戻り値
注釈
getSpecialCellsOrNullObject(cellType, cellValueType)
指定した型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。 条件に一致する特殊なセルが見つからない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;パラメーター
- cellType
- Excel.SpecialCellType
含めるセルの種類。
- cellValueType
- Excel.SpecialCellValueType
cellTypeがconstantsまたはformulasの場合、この引数を使用して、結果に含めるセルの種類を決定します。 これらの値を組み合わせて、複数の型を返すことができます。 この引数を省略すると、すべての定数および数式が対象になります。
戻り値
注釈
getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)
指定した型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。 条件に一致する特殊なセルが見つからない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getSpecialCellsOrNullObject(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueTypeString?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;パラメーター
- cellTypeString
-
"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"
含めるセルの種類。
- cellValueTypeString
-
"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"
cellTypeがconstantsまたはformulasの場合、この引数を使用して、結果に含めるセルの種類を決定します。 これらの値を組み合わせて、複数の型を返すことができます。 この引数を省略すると、すべての定数および数式が対象になります。
戻り値
注釈
getTables(fullyContained)
この RangeAreas オブジェクト内の任意の範囲と重複するテーブルのスコープ付きコレクションを返します。
getTables(fullyContained?: boolean): Excel.TableScopedCollection;パラメーター
- fullyContained
-
boolean
true
場合は、範囲内に完全に含まれるテーブルのみを返します。 既定値は falseです。
戻り値
注釈
getUsedRangeAreas(valuesOnly)
RangeAreas オブジェクト内の個々の四角形の範囲のすべての使用領域を構成する使用RangeAreasを返します。
RangeAreas
内に使用されているセルがない場合は、ItemNotFound エラーがスローされます。
getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas;パラメーター
- valuesOnly
-
boolean
値を持つセルのみを使用セルと見なすかどうか。 既定値は falseです。
戻り値
注釈
getUsedRangeAreasOrNullObject(valuesOnly)
RangeAreas オブジェクト内の個々の四角形の範囲のすべての使用領域を構成する使用RangeAreasを返します。
RangeAreas
内に使用されているセルがない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getUsedRangeAreasOrNullObject(valuesOnly?: boolean): Excel.RangeAreas;パラメーター
- valuesOnly
-
boolean
値を持つセルのみを使用セルと見なすかどうか。
戻り値
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.RangeAreasLoadOptions): Excel.RangeAreas;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.RangeAreas;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.RangeAreas;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.RangeAreasUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.RangeAreasUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.RangeAreas): void;パラメーター
- properties
- Excel.RangeAreas
戻り値
void
setDirty()
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.RangeAreas オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.RangeAreasData として型指定) を返します。
toJSON(): Excel.Interfaces.RangeAreasData;戻り値
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。
track(): Excel.RangeAreas;戻り値
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。
untrack(): Excel.RangeAreas;戻り値
Office Add-ins