Excel.RangeAreas class

RangeAreas は、同じワークシート内の1つまたは複数の四角形の範囲のコレクションを表します。RangeAreas represents a collection of one or more rectangular ranges in the same worksheet.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

Extends

プロパティ

address

A1 スタイルで RageAreas 参照を返します。Returns the RageAreas reference in A1-style. address 値にはセルの各長方形ブロックのワークシート名が含まれます ("Sheet1!A1:B4, Sheet1!D1:D4" など)。Address value will contain the worksheet name for each rectangular block of cells (e.g. "Sheet1!A1:B4, Sheet1!D1:D4"). 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

addressLocal

ユーザー ロケールで RageAreas 参照を返します。Returns the RageAreas reference in the user locale. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

areaCount

この RangeAreas オブジェクトを構成する長方形範囲の数を返します。Returns the number of rectangular ranges that comprise this RangeAreas object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

areas

この RangeAreas オブジェクトを構成する長方形範囲の集まりを返します。Returns a collection of rectangular ranges that comprise this RangeAreas object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

cellCount

RangeAreas オブジェクトのセル数を返します。すべての個別長方形範囲のセル数が合計されます。Returns the number of cells in the RangeAreas object, summing up the cell counts of all of the individual rectangular ranges. セル数が 2^31-1 (2,147,483,647) を超える場合、-1 を返します。Returns -1 if the cell count exceeds 2^31-1 (2,147,483,647). 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

conditionalFormats

この RangeAreas オブジェクトのセルと交差する ConditionalFormats の集まりを返します。Returns a collection of ConditionalFormats that intersect with any cells in this RangeAreas object. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

dataValidation

RangeAreas の全範囲に対して dataValidation オブジェクトを返します。Returns a dataValidation object for all ranges in the RangeAreas.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

format

rangeFormat オブジェクトを返します。RangeAreas オブジェクトの全範囲を対象にフォント、塗りつぶし、罫線、配置などのプロパティをカプセル化します。Returns a rangeFormat object, encapsulating the the font, fill, borders, alignment, and other properties for all ranges in the RangeAreas object. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

isEntireColumn

この RangeAreas オブジェクトの全範囲が列全体を表すかどうかを示します ("A:C, Q:Z" など)。Indicates whether all the ranges on this RangeAreas object represent entire columns (e.g., "A:C, Q:Z"). 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

isEntireRow

この RangeAreas オブジェクトの全範囲が行全体を表すかどうかを示します ("1:3, 5:7" など)。Indicates whether all the ranges on this RangeAreas object represent entire rows (e.g., "1:3, 5:7"). 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

style

この RangeAreas オブジェクトの全範囲のスタイルを表します。Represents the style for all ranges in this RangeAreas object. セルのスタイルに不整合がある場合は、null が返されます。If the styles of the cells are inconsistent, null will be returned. ユーザー設定のスタイルの場合は、スタイル名が返されます。For custom styles, the style name will be returned. 組み込みのスタイルの場合、BuiltInStyle 列挙内の値を表す文字列が返されます。For built-in styles, a string representing a value in the BuiltInStyle enum will be returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

worksheet

現在の RangeAreas のワークシートを返します。Returns the worksheet for the current RangeAreas. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

メソッド

calculate()

RangeAreas のすべてのセルを計算します。Calculates all cells in the RangeAreas.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

clear(applyTo)

この RangeAreas オブジェクトを構成する各領域で値、フォーマット、塗りつぶし、罫線などを消去します。Clears values, format, fill, border, etc on each of the areas that comprise this RangeAreas object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

clear(applyToString)

この RangeAreas オブジェクトを構成する各領域で値、フォーマット、塗りつぶし、罫線などを消去します。Clears values, format, fill, border, etc on each of the areas that comprise this RangeAreas object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

convertDataTypeToText()

RangeAreas 内でデータ型を含むすべてのセルをテキストに変換します。Converts all cells in the RangeAreas with datatypes into text.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

convertToLinkedDataType(serviceID, languageCulture)

RangeAreas 内のすべてのセルをリンク付きデータ型に変換します。Converts all cells in the RangeAreas into linked datatype.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

copyFrom(sourceRange, copyType, skipBlanks, transpose)

ソース範囲または RangeAreas から現在の RangeAreas にセル データまたは書式設定をコピーします。Copies cell data or formatting from the source range or RangeAreas to the current RangeAreas. コピー先の rangeAreas のサイズは、元の範囲または RangeAreas とは異なる場合があります。The destination rangeAreas can be of different size than the source range or RangeAreas. 転送先は、ソースよりも小さい場合は自動的に展開されます。The destination will be expanded automatically if it is smaller than the source.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)

ソース範囲または RangeAreas から現在の RangeAreas にセル データまたは書式設定をコピーします。Copies cell data or formatting from the source range or RangeAreas to the current RangeAreas. コピー先の rangeAreas のサイズは、元の範囲または RangeAreas とは異なる場合があります。The destination rangeAreas can be of different size than the source range or RangeAreas. 転送先は、ソースよりも小さい場合は自動的に展開されます。The destination will be expanded automatically if it is smaller than the source.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getEntireColumn()

RangeAreas の列全体を表す RangeAreas オブジェクトを返します (たとえば、現在の RangeAreas がセル "B4:E11, H2" を表す場合、列 "B:E, H:H" を表す RangeAreas が返されます)。Returns a RangeAreas object that represents the entire columns of the RangeAreas (for example, if the current RangeAreas represents cells "B4:E11, H2", it returns a RangeAreas that represents columns "B:E, H:H").

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getEntireRow()

RangeAreas の行全体を表す RangeAreas オブジェクトを返します (たとえば、現在の RangeAreas がセル "B4:E11" を表す場合、行 "4:11" を表す RangeAreas が返されます)。Returns a RangeAreas object that represents the entire rows of the RangeAreas (for example, if the current RangeAreas represents cells "B4:E11", it returns a RangeAreas that represents rows "4:11").

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getIntersection(anotherRange)

指定した範囲または RangeAreas の交差を表す RangeAreas オブジェクトを返します。Returns the RangeAreas object that represents the intersection of the given ranges or RangeAreas. 交差が見つからない場合、ItemNotFound エラーがスローされます。If no intersection is found, an ItemNotFound error will be thrown.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getIntersectionOrNullObject(anotherRange)

指定した範囲または RangeAreas の交差を表す RangeAreas オブジェクトを返します。Returns the RangeAreas object that represents the intersection of the given ranges or RangeAreas. 交差が見つからない場合、null オブジェクトが返されます。If no intersection is found, a null object is returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getOffsetRangeAreas(rowOffset, columnOffset)

特定の行と列のオフセットによってシフトされる RangeAreas オブジェクトを返します。Returns an RangeAreas object that is shifted by the specific row and column offset. 返される RangeAreas のディメンションは元のオブジェクトと一致します。The dimension of the returned RangeAreas will match the original object. 結果の RangeAreas がワークシート グリッドの境界線の外にはみ出る場合、エラーがスローされます。If the resulting RangeAreas is forced outside the bounds of the worksheet grid, an error will be thrown.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCells(cellType, cellValueType)

指定された型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。Returns a RangeAreas object that represents all the cells that match the specified type and value. 条件に一致する特別なセルが見つからない場合、エラーがスローされます。Throws an error if no special cells are found that match the criteria.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCells(cellTypeString, cellValueType)

指定された型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。Returns a RangeAreas object that represents all the cells that match the specified type and value. 条件に一致する特別なセルが見つからない場合、エラーがスローされます。Throws an error if no special cells are found that match the criteria.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellType, cellValueType)

指定された型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。Returns a RangeAreas object that represents all the cells that match the specified type and value. 条件に一致する特別なセルが見つからない場合、null オブジェクトを返します。Returns a null object if no special cells are found that match the criteria.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellTypeString, cellValueType)

指定された型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。Returns a RangeAreas object that represents all the cells that match the specified type and value. 条件に一致する特別なセルが見つからない場合、null オブジェクトを返します。Returns a null object if no special cells are found that match the criteria.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getTables(fullyContained)

この RangeAreas オブジェクトの範囲と重なるテーブルの集まりを範囲限定で返します。Returns a scoped collection of tables that overlap with any range in this RangeAreas object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getUsedRangeAreas(valuesOnly)

RangeAreas オブジェクトの個別の長方形範囲の全使用済み領域を構成する使用済み RangeAreas を返します。Returns the used RangeAreas that comprises all the used areas of individual rectangular ranges in the RangeAreas object. RangeAreas 内に使用されているセルがない場合は、ItemNotFound エラーがスローされます。If there are no used cells within the RangeAreas, the ItemNotFound error will be thrown.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getUsedRangeAreasOrNullObject(valuesOnly)

RangeAreas オブジェクトの個別の長方形範囲の全使用済み領域を構成する使用済み RangeAreas を返します。Returns the used RangeAreas that comprises all the used areas of individual rectangular ranges in the RangeAreas object. RangeAreas 内に使用されているセルがない場合は、null オブジェクトが返されます。If there are no used cells within the RangeAreas, a null object will be returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

setDirty()

次の再計算が発生したときに再計算する RangeAreas を設定します。Sets the RangeAreas to be recalculated when the next recalculation occurs.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の RangeAreas オブジェクトは API オブジェクトであるのに対してtoJSON 、メソッドはプレーンな JavaScript オブジェクト (として型指定されます) を返します。Excel.Interfaces.RangeAreasData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.RangeAreas object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.RangeAreasData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

track()

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。Track the object for automatic adjustment based on surrounding changes in the document. これは context.trackedObjects.add(thisObject) 呼び出しの省略形です。This call is a shorthand for context.trackedObjects.add(thisObject). ".sync" 呼び出し間で、かつ ".run" バッチの連続実行の外でこのオブジェクトを使用しているとき、オブジェクトであるプロパティを設定したか、あるメソッドを呼び出したときに "InvalidObjectPath" エラーが表示される場合、オブジェクトを最初に作成したときに、追跡対象オブジェクトの集まりにそのオブジェクトを追加しておく必要がありました。If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.

untrack()

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。Release the memory associated with this object, if it has previously been tracked. これは context.trackedObjects.remove(thisObject) 呼び出しの省略形です。This call is shorthand for context.trackedObjects.remove(thisObject). 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. メモリ リリースを有効にするには、"context.sync()" を先に呼び出す必要があります。You will need to call "context.sync()" before the memory release takes effect.

プロパティの詳細

address

A1 スタイルで RageAreas 参照を返します。Returns the RageAreas reference in A1-style. address 値にはセルの各長方形ブロックのワークシート名が含まれます ("Sheet1!A1:B4, Sheet1!D1:D4" など)。Address value will contain the worksheet name for each rectangular block of cells (e.g. "Sheet1!A1:B4, Sheet1!D1:D4"). 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly address: string;

プロパティ値

string

addressLocal

ユーザー ロケールで RageAreas 参照を返します。Returns the RageAreas reference in the user locale. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly addressLocal: string;

プロパティ値

string

areaCount

この RangeAreas オブジェクトを構成する長方形範囲の数を返します。Returns the number of rectangular ranges that comprise this RangeAreas object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly areaCount: number;

プロパティ値

number

areas

この RangeAreas オブジェクトを構成する長方形範囲の集まりを返します。Returns a collection of rectangular ranges that comprise this RangeAreas object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly areas: Excel.RangeCollection;

プロパティ値

cellCount

RangeAreas オブジェクトのセル数を返します。すべての個別長方形範囲のセル数が合計されます。Returns the number of cells in the RangeAreas object, summing up the cell counts of all of the individual rectangular ranges. セル数が 2^31-1 (2,147,483,647) を超える場合、-1 を返します。Returns -1 if the cell count exceeds 2^31-1 (2,147,483,647). 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly cellCount: number;

プロパティ値

number

conditionalFormats

この RangeAreas オブジェクトのセルと交差する ConditionalFormats の集まりを返します。Returns a collection of ConditionalFormats that intersect with any cells in this RangeAreas object. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly conditionalFormats: Excel.ConditionalFormatCollection;

プロパティ値

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

dataValidation

RangeAreas の全範囲に対して dataValidation オブジェクトを返します。Returns a dataValidation object for all ranges in the RangeAreas.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly dataValidation: Excel.DataValidation;

プロパティ値

format

rangeFormat オブジェクトを返します。RangeAreas オブジェクトの全範囲を対象にフォント、塗りつぶし、罫線、配置などのプロパティをカプセル化します。Returns a rangeFormat object, encapsulating the the font, fill, borders, alignment, and other properties for all ranges in the RangeAreas object. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly format: Excel.RangeFormat;

プロパティ値

Examples

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" など)。Indicates whether all the ranges on this RangeAreas object represent entire columns (e.g., "A:C, Q:Z"). 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly isEntireColumn: boolean;

プロパティ値

boolean

isEntireRow

この RangeAreas オブジェクトの全範囲が行全体を表すかどうかを示します ("1:3, 5:7" など)。Indicates whether all the ranges on this RangeAreas object represent entire rows (e.g., "1:3, 5:7"). 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly isEntireRow: boolean;

プロパティ値

boolean

style

この RangeAreas オブジェクトの全範囲のスタイルを表します。Represents the style for all ranges in this RangeAreas object. セルのスタイルに不整合がある場合は、null が返されます。If the styles of the cells are inconsistent, null will be returned. ユーザー設定のスタイルの場合は、スタイル名が返されます。For custom styles, the style name will be returned. 組み込みのスタイルの場合、BuiltInStyle 列挙内の値を表す文字列が返されます。For built-in styles, a string representing a value in the BuiltInStyle enum will be returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

style: string;

プロパティ値

string

worksheet

現在の RangeAreas のワークシートを返します。Returns the worksheet for the current RangeAreas. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly worksheet: Excel.Worksheet;

プロパティ値

メソッドの詳細

calculate()

RangeAreas のすべてのセルを計算します。Calculates all cells in the RangeAreas.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

calculate(): void;

戻り値

void

clear(applyTo)

この RangeAreas オブジェクトを構成する各領域で値、フォーマット、塗りつぶし、罫線などを消去します。Clears values, format, fill, border, etc on each of the areas that comprise this RangeAreas object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

clear(applyTo?: Excel.ClearApplyTo): void;

パラメーター

applyTo
Excel.ClearApplyTo

省略可能。Optional. クリア操作の種類を決定します。Determines the type of clear action. 詳細については、「Excel. ClearApplyTo」を参照してください。See Excel.ClearApplyTo for details. 既定値は "すべて" です。Default is "All".

戻り値

void

clear(applyToString)

この RangeAreas オブジェクトを構成する各領域で値、フォーマット、塗りつぶし、罫線などを消去します。Clears values, format, fill, border, etc on each of the areas that comprise this RangeAreas object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

clear(applyToString?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"): void;

パラメーター

applyToString
"All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"

省略可能。Optional. クリア操作の種類を決定します。Determines the type of clear action. 詳細については、「Excel. ClearApplyTo」を参照してください。See Excel.ClearApplyTo for details. 既定値は "すべて" です。Default is "All".

戻り値

void

convertDataTypeToText()

RangeAreas 内でデータ型を含むすべてのセルをテキストに変換します。Converts all cells in the RangeAreas with datatypes into text.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

convertDataTypeToText(): void;

戻り値

void

convertToLinkedDataType(serviceID, languageCulture)

RangeAreas 内のすべてのセルをリンク付きデータ型に変換します。Converts all cells in the RangeAreas into linked datatype.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

convertToLinkedDataType(serviceID: number, languageCulture: string): void;

パラメーター

serviceID
number

データのクエリに使用されるサービス ID。The Service ID which will be used to query the data.

languageCulture
string

サービスを照会する言語カルチャ。Language Culture to query the service for.

戻り値

void

copyFrom(sourceRange, copyType, skipBlanks, transpose)

ソース範囲または RangeAreas から現在の RangeAreas にセル データまたは書式設定をコピーします。Copies cell data or formatting from the source range or RangeAreas to the current RangeAreas. コピー先の rangeAreas のサイズは、元の範囲または RangeAreas とは異なる場合があります。The destination rangeAreas can be of different size than the source range or RangeAreas. 転送先は、ソースよりも小さい場合は自動的に展開されます。The destination will be expanded automatically if it is smaller than the source.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void;

パラメーター

sourceRange
Range | RangeAreas | string

コピー元の範囲または RangeAreas を指定します。The source range or RangeAreas to copy from. ソース範囲に複数の範囲がある場合は、四角形の範囲から完全な行または列を削除することによって作成できるアウトライン形式である必要があります。When the source RangeAreas has multiple ranges, it must be in the outline form which can be created by removing full rows or columns from a rectangular range.

copyType
Excel.RangeCopyType

コピーするセルのデータまたは書式の種類を指定します。The type of cell data or formatting to copy over. 既定値は "すべて" です。Default is "All".

skipBlanks
boolean

True の場合は、元の範囲または RangeAreas の空白セルをスキップします。True if to skip blank cells in the source range or RangeAreas. 既定値は false です。Default is false.

transpose
boolean

True を指定すると、移動先の範囲内のセルが転置されます。True if to transpose the cells in the destination RangeAreas. 既定値は false です。Default is false.

戻り値

void

copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)

ソース範囲または RangeAreas から現在の RangeAreas にセル データまたは書式設定をコピーします。Copies cell data or formatting from the source range or RangeAreas to the current RangeAreas. コピー先の rangeAreas のサイズは、元の範囲または RangeAreas とは異なる場合があります。The destination rangeAreas can be of different size than the source range or RangeAreas. 転送先は、ソースよりも小さい場合は自動的に展開されます。The destination will be expanded automatically if it is smaller than the source.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

copyFrom(sourceRange: Range | RangeAreas | string, copyTypeString?: "All" | "Formulas" | "Values" | "Formats", skipBlanks?: boolean, transpose?: boolean): void;

パラメーター

sourceRange
Range | RangeAreas | string

コピー元の範囲または RangeAreas を指定します。The source range or RangeAreas to copy from. ソース範囲に複数の範囲がある場合は、四角形の範囲から完全な行または列を削除することによって作成できるアウトライン形式である必要があります。When the source RangeAreas has multiple ranges, it must be in the outline form which can be created by removing full rows or columns from a rectangular range.

copyTypeString
"All" | "Formulas" | "Values" | "Formats"

コピーするセルのデータまたは書式の種類を指定します。The type of cell data or formatting to copy over. 既定値は "すべて" です。Default is "All".

skipBlanks
boolean

True の場合は、元の範囲または RangeAreas の空白セルをスキップします。True if to skip blank cells in the source range or RangeAreas. 既定値は false です。Default is false.

transpose
boolean

True を指定すると、移動先の範囲内のセルが転置されます。True if to transpose the cells in the destination RangeAreas. 既定値は false です。Default is false.

戻り値

void

getEntireColumn()

RangeAreas の列全体を表す RangeAreas オブジェクトを返します (たとえば、現在の RangeAreas がセル "B4:E11, H2" を表す場合、列 "B:E, H:H" を表す RangeAreas が返されます)。Returns a RangeAreas object that represents the entire columns of the RangeAreas (for example, if the current RangeAreas represents cells "B4:E11, H2", it returns a RangeAreas that represents columns "B:E, H:H").

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getEntireColumn(): Excel.RangeAreas;

戻り値

getEntireRow()

RangeAreas の行全体を表す RangeAreas オブジェクトを返します (たとえば、現在の RangeAreas がセル "B4:E11" を表す場合、行 "4:11" を表す RangeAreas が返されます)。Returns a RangeAreas object that represents the entire rows of the RangeAreas (for example, if the current RangeAreas represents cells "B4:E11", it returns a RangeAreas that represents rows "4:11").

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getEntireRow(): Excel.RangeAreas;

戻り値

getIntersection(anotherRange)

指定した範囲または RangeAreas の交差を表す RangeAreas オブジェクトを返します。Returns the RangeAreas object that represents the intersection of the given ranges or RangeAreas. 交差が見つからない場合、ItemNotFound エラーがスローされます。If no intersection is found, an ItemNotFound error will be thrown.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getIntersection(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;

パラメーター

anotherRange
Range | RangeAreas | string

積集合を決定するために使用される範囲、RangeAreas オブジェクト、または範囲アドレス。The range, RangeAreas object or range address that will be used to determine the intersection.

戻り値

getIntersectionOrNullObject(anotherRange)

指定した範囲または RangeAreas の交差を表す RangeAreas オブジェクトを返します。Returns the RangeAreas object that represents the intersection of the given ranges or RangeAreas. 交差が見つからない場合、null オブジェクトが返されます。If no intersection is found, a null object is returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getIntersectionOrNullObject(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;

パラメーター

anotherRange
Range | RangeAreas | string

積集合を決定するために使用される範囲、RangeAreas、または address。The range, RangeAreas, or address that will be used to determine the intersection.

戻り値

getOffsetRangeAreas(rowOffset, columnOffset)

特定の行と列のオフセットによってシフトされる RangeAreas オブジェクトを返します。Returns an RangeAreas object that is shifted by the specific row and column offset. 返される RangeAreas のディメンションは元のオブジェクトと一致します。The dimension of the returned RangeAreas will match the original object. 結果の RangeAreas がワークシート グリッドの境界線の外にはみ出る場合、エラーがスローされます。If the resulting RangeAreas is forced outside the bounds of the worksheet grid, an error will be thrown.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getOffsetRangeAreas(rowOffset: number, columnOffset: number): Excel.RangeAreas;

パラメーター

rowOffset
number

RangeAreas がオフセットされる行の数 (正、負、または 0)。The number of rows (positive, negative, or 0) by which the RangeAreas is to be offset. 正の値は下方向、負の値は上方向のオフセットを表します。Positive values are offset downward, and negative values are offset upward.

columnOffset
number

RangeAreas がオフセットされる列の数 (正、負、または 0)。The number of columns (positive, negative, or 0) by which the RangeAreas is to be offset. 正の値は右方向、負の値は左方向のオフセットを表します。Positive values are offset to the right, and negative values are offset to the left.

戻り値

getSpecialCells(cellType, cellValueType)

指定された型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。Returns a RangeAreas object that represents all the cells that match the specified type and value. 条件に一致する特別なセルが見つからない場合、エラーがスローされます。Throws an error if no special cells are found that match the criteria.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

パラメーター

cellType
Excel.SpecialCellType

含めるセルの種類を指定します。The type of cells to include.

cellValueType
Excel.SpecialCellValueType

CellType が定数または数式の場合は、この引数を使用して、結果に含めるセルの種類を決定します。If cellType is either Constants or Formulas, this argument is used to determine which types of cells to include in the result. これらの値は、組み合わせて複数の型を返すことができます。These values can be combined together to return more than one type. この引数を省略すると、すべての定数および数式が対象になります。The default is to select all constants or formulas, no matter what the type.

戻り値

getSpecialCells(cellTypeString, cellValueType)

指定された型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。Returns a RangeAreas object that represents all the cells that match the specified type and value. 条件に一致する特別なセルが見つからない場合、エラーがスローされます。Throws an error if no special cells are found that match the criteria.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCells(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "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"

含めるセルの種類を指定します。The type of cells to include.

cellValueType
"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

CellType が定数または数式の場合は、この引数を使用して、結果に含めるセルの種類を決定します。If cellType is either Constants or Formulas, this argument is used to determine which types of cells to include in the result. これらの値は、組み合わせて複数の型を返すことができます。These values can be combined together to return more than one type. この引数を省略すると、すべての定数および数式が対象になります。The default is to select all constants or formulas, no matter what the type.

戻り値

getSpecialCellsOrNullObject(cellType, cellValueType)

指定された型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。Returns a RangeAreas object that represents all the cells that match the specified type and value. 条件に一致する特別なセルが見つからない場合、null オブジェクトを返します。Returns a null object if no special cells are found that match the criteria.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

パラメーター

cellType
Excel.SpecialCellType

含めるセルの種類を指定します。The type of cells to include.

cellValueType
Excel.SpecialCellValueType

CellType が定数または数式の場合は、この引数を使用して、結果に含めるセルの種類を決定します。If cellType is either Constants or Formulas, this argument is used to determine which types of cells to include in the result. これらの値は、組み合わせて複数の型を返すことができます。These values can be combined together to return more than one type. この引数を省略すると、すべての定数および数式が対象になります。The default is to select all constants or formulas, no matter what the type.

戻り値

getSpecialCellsOrNullObject(cellTypeString, cellValueType)

指定された型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。Returns a RangeAreas object that represents all the cells that match the specified type and value. 条件に一致する特別なセルが見つからない場合、null オブジェクトを返します。Returns a null object if no special cells are found that match the criteria.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "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"

含めるセルの種類を指定します。The type of cells to include.

cellValueType
"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

CellType が定数または数式の場合は、この引数を使用して、結果に含めるセルの種類を決定します。If cellType is either Constants or Formulas, this argument is used to determine which types of cells to include in the result. これらの値は、組み合わせて複数の型を返すことができます。These values can be combined together to return more than one type. この引数を省略すると、すべての定数および数式が対象になります。The default is to select all constants or formulas, no matter what the type.

戻り値

getTables(fullyContained)

この RangeAreas オブジェクトの範囲と重なるテーブルの集まりを範囲限定で返します。Returns a scoped collection of tables that overlap with any range in this RangeAreas object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getTables(fullyContained?: boolean): Excel.TableScopedCollection;

パラメーター

fullyContained
boolean

True の場合は、範囲範囲内に完全に含まれるテーブルのみを返します。If true, returns only tables that are fully contained within the range bounds. 既定値は false です。Default is false.

戻り値

getUsedRangeAreas(valuesOnly)

RangeAreas オブジェクトの個別の長方形範囲の全使用済み領域を構成する使用済み RangeAreas を返します。Returns the used RangeAreas that comprises all the used areas of individual rectangular ranges in the RangeAreas object. RangeAreas 内に使用されているセルがない場合は、ItemNotFound エラーがスローされます。If there are no used cells within the RangeAreas, the ItemNotFound error will be thrown.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas;

パラメーター

valuesOnly
boolean

値が指定されたセルのみを使用しているセルとしてのみを考慮するかどうか。Whether to only consider cells with values as used cells. 既定値は false です。Default is false.

戻り値

getUsedRangeAreasOrNullObject(valuesOnly)

RangeAreas オブジェクトの個別の長方形範囲の全使用済み領域を構成する使用済み RangeAreas を返します。Returns the used RangeAreas that comprises all the used areas of individual rectangular ranges in the RangeAreas object. RangeAreas 内に使用されているセルがない場合は、null オブジェクトが返されます。If there are no used cells within the RangeAreas, a null object will be returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getUsedRangeAreasOrNullObject(valuesOnly?: boolean): Excel.RangeAreas;

パラメーター

valuesOnly
boolean

値が指定されたセルのみを使用しているセルとしてのみを考慮するかどうか。Whether to only consider cells with values as used cells.

戻り値

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.RangeAreasLoadOptions): Excel.RangeAreas;

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.RangeAreas-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.RangeAreas - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.RangeAreas-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.RangeAreas - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeAreas-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeAreas - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.RangeAreas;

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RangeAreas;

パラメーター

propertyNamesAndPaths
{ select?: string; expand?: string; }

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.RangeAreasUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties
Interfaces.RangeAreasUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.RangeAreas): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.RangeAreas): void;

パラメーター

properties
Excel.RangeAreas

戻り値

void

setDirty()

次の再計算が発生したときに再計算する RangeAreas を設定します。Sets the RangeAreas to be recalculated when the next recalculation occurs.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setDirty(): void;

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の RangeAreas オブジェクトは API オブジェクトであるのに対してtoJSON 、メソッドはプレーンな JavaScript オブジェクト (として型指定されます) を返します。Excel.Interfaces.RangeAreasData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.RangeAreas object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.RangeAreasData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.RangeAreasData;

戻り値

track()

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。Track the object for automatic adjustment based on surrounding changes in the document. これは context.trackedObjects.add(thisObject) 呼び出しの省略形です。This call is a shorthand for context.trackedObjects.add(thisObject). ".sync" 呼び出し間で、かつ ".run" バッチの連続実行の外でこのオブジェクトを使用しているとき、オブジェクトであるプロパティを設定したか、あるメソッドを呼び出したときに "InvalidObjectPath" エラーが表示される場合、オブジェクトを最初に作成したときに、追跡対象オブジェクトの集まりにそのオブジェクトを追加しておく必要がありました。If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.

track(): Excel.RangeAreas;

戻り値

untrack()

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。Release the memory associated with this object, if it has previously been tracked. これは context.trackedObjects.remove(thisObject) 呼び出しの省略形です。This call is shorthand for context.trackedObjects.remove(thisObject). 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. メモリ リリースを有効にするには、"context.sync()" を先に呼び出す必要があります。You will need to call "context.sync()" before the memory release takes effect.

untrack(): Excel.RangeAreas;

戻り値