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 |
この |
| 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 オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
| 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
オブジェクト内 RangeFormat のすべての範囲のフォント、塗りつぶし、罫線、配置、およびその他のプロパティをカプセル化して、オブジェクトを RangeAreas 返します。
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"): void;パラメーター
- applyToString
-
"All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"
オプション。 クリア操作の種類を決定します。 詳細は「Excel.ClearApplyTo」をご覧ください。 既定値は "All" です。
戻り値
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の積集合を表す オブジェクトを返します。 積集合が見つからない場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *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
オフセットする行数 (正、負、または 0 RangeAreas )。 正の値は下方向、負の値は上方向のオフセットを表します。
- columnOffset
-
number
オフセットする列の数 (正、負、または 0 RangeAreas )。 正の値は右方向、負の値は左方向のオフセットを表します。
戻り値
注釈
getSpecialCells(cellType, cellValueType)
指定した型と値に RangeAreas 一致するすべてのセルを表す オブジェクトを返します。 条件に一致する特別なセルが見つからない場合、エラーがスローされます。
getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;パラメーター
- cellType
- Excel.SpecialCellType
含めるセルの種類。
- cellValueType
- Excel.SpecialCellValueType
が または formulasのconstants場合cellType、この引数を使用して、結果に含めるセルの種類を決定します。 これらの値を組み合わせて、複数の型を返すことができます。 この引数を省略すると、すべての定数および数式が対象になります。
戻り値
注釈
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"
が または formulasのconstants場合cellType、この引数を使用して、結果に含めるセルの種類を決定します。 これらの値を組み合わせて、複数の型を返すことができます。 この引数を省略すると、すべての定数および数式が対象になります。
戻り値
注釈
getSpecialCellsOrNullObject(cellType, cellValueType)
指定した型と値に RangeAreas 一致するすべてのセルを表す オブジェクトを返します。 条件に一致する特殊なセルが見つからない場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;パラメーター
- cellType
- Excel.SpecialCellType
含めるセルの種類。
- cellValueType
- Excel.SpecialCellValueType
が または formulasのconstants場合cellType、この引数を使用して、結果に含めるセルの種類を決定します。 これらの値を組み合わせて、複数の型を返すことができます。 この引数を省略すると、すべての定数および数式が対象になります。
戻り値
注釈
getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)
指定した型と値に RangeAreas 一致するすべてのセルを表す オブジェクトを返します。 条件に一致する特殊なセルが見つからない場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *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"
が または formulasのconstants場合cellType、この引数を使用して、結果に含めるセルの種類を決定します。 これらの値を組み合わせて、複数の型を返すことができます。 この引数を省略すると、すべての定数および数式が対象になります。
戻り値
注釈
getTables(fullyContained)
この RangeAreas オブジェクト内の任意の範囲と重複するテーブルのスコープ付きコレクションを返します。
getTables(fullyContained?: boolean): Excel.TableScopedCollection;パラメーター
- fullyContained
-
boolean
の場合 trueは、範囲の境界内に完全に含まれるテーブルのみが返されます。 既定値は です false。
戻り値
注釈
getUsedRangeAreas(valuesOnly)
オブジェクト内の個々の RangeAreas 四角形の範囲のすべての使用領域を構成する used を RangeAreas 返します。 内 RangeAreasに使用されたセルがない場合、 ItemNotFound エラーがスローされます。
getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas;パラメーター
- valuesOnly
-
boolean
値を持つセルのみを使用セルと見なすかどうか。 既定値は です false。
戻り値
注釈
getUsedRangeAreasOrNullObject(valuesOnly)
オブジェクト内の個々の RangeAreas 四角形の範囲のすべての使用領域を構成する used を RangeAreas 返します。 内RangeAreasに使用されているセルがない場合、このメソッドは、 プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *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 オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (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
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示