Excel.RangeAreas class

A1 スタイルの RangeAreas 参照を返します。 アドレス値には、セルの四角形の各ブロックのワークシート名が含まれます (例: "Sheet1!A1:B4、Sheet1!D1:D4")。

readonly address: string;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

ユーザー ロケールの RangeAreas 参照を返します。

readonly addressLocal: string;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

この RangeAreas オブジェクトを構成する四角形の範囲の数を返します。

readonly areaCount: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

この RangeAreas オブジェクトを構成する四角形の範囲のコレクションを返します。

readonly areas: Excel.RangeCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

RangeAreas オブジェクト内のセルの数を返し、個々のすべての四角形の範囲のセル数を合計します。 セル数が 2^31-1 (2,147,483,647) を超える場合、-1 を返します。

readonly cellCount: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

この RangeAreas オブジェクト内の任意のセルと交差する条件付き形式のコレクションを返します。

readonly conditionalFormats: Excel.ConditionalFormatCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

RangeAreas 内のすべての範囲のデータ検証オブジェクトを返します。

readonly dataValidation: Excel.DataValidation;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

RangeAreas オブジェクト内のすべての範囲のフォント、塗りつぶし、罫線、配置、およびその他のプロパティをカプセル化して、RangeFormat オブジェクトを返します。

readonly format: Excel.RangeFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

例

// 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();
});

この RangeAreas オブジェクトのすべての範囲が列全体を表すかどうかを指定します (例: "A:C, Q:Z")。

readonly isEntireColumn: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

この RangeAreas オブジェクトのすべての範囲が行全体を表すかどうかを指定します (例: "1:3, 5:7")。

readonly isEntireRow: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

この RangeAreas オブジェクトのすべての範囲のスタイルを表します。 セルのスタイルに一貫性がない場合は、 null が返されます。 カスタム スタイルの場合、スタイル名が返されます。 組み込みのスタイルの場合、 BuiltInStyle 列挙型の値を表す文字列が返されます。

style: string;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

現在の RangeAreasのワークシートを返します。

readonly worksheet: Excel.Worksheet;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

RangeAreas 内のすべてのセルを計算します。

calculate(): void;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

この RangeAreas オブジェクトを構成する各領域の値、書式、塗りつぶし、罫線、およびその他のプロパティをクリアします。

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

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

この RangeAreas オブジェクトを構成する各領域の値、書式、塗りつぶし、罫線、およびその他のプロパティをクリアします。

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

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

データ型を持つ RangeAreas 内のすべてのセルをテキストに変換します。

convertDataTypeToText(): void;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

RangeAreas内のすべてのセルをリンクされたデータ型に変換します。

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

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

セル データまたは書式設定をソース範囲または RangeAreas から現在の RangeAreasにコピーします。 変換先の RangeAreas は、ソース範囲または RangeAreasとは異なるサイズにすることができます。 コピー先がソースより小さい場合は、自動的に展開されます。

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

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

セル データまたは書式設定をソース範囲または RangeAreas から現在の RangeAreasにコピーします。 変換先の RangeAreas は、ソース範囲または RangeAreasとは異なるサイズにすることができます。 コピー先がソースより小さい場合は、自動的に展開されます。

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

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

RangeAreasの列全体を表すRangeAreas オブジェクトを返します (たとえば、現在のRangeAreasがセル "B4:E11, H2" を表している場合、列 "B:E, H:H" を表すRangeAreasを返します)。

getEntireColumn(): Excel.RangeAreas;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

RangeAreasの行全体を表すRangeAreas オブジェクトを返します (たとえば、現在のRangeAreasがセル "B4:E11" を表している場合は、行 "4:11" を表すRangeAreasを返します)。

getEntireRow(): Excel.RangeAreas;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

指定された範囲またはRangeAreasの積集合を表すRangeAreas オブジェクトを返します。 積集合が見つからない場合は、 ItemNotFound エラーがスローされます。

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

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

指定された範囲またはRangeAreasの積集合を表すRangeAreas オブジェクトを返します。 積集合が見つからない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

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

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

特定の行と列のオフセットによってシフトされる RangeAreas オブジェクトを返します。 返された RangeAreas の次元は、元のオブジェクトと一致します。 結果の RangeAreas がワークシート グリッドの範囲外に強制された場合、エラーがスローされます。

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

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

指定した型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。 条件に一致する特別なセルが見つからない場合、エラーがスローされます。

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

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

指定した型と値に一致するすべてのセルを表す 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;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

指定した型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。 条件に一致する特殊なセルが見つからない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

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

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

指定した型と値に一致するすべてのセルを表す 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;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

この RangeAreas オブジェクト内の任意の範囲と重複するテーブルのスコープ付きコレクションを返します。

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

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

RangeAreas オブジェクト内の個々の四角形の範囲のすべての使用領域を構成する使用RangeAreasを返します。 RangeAreas 内に使用されているセルがない場合は、ItemNotFound エラーがスローされます。

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

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

RangeAreas オブジェクト内の個々の四角形の範囲のすべての使用領域を構成する使用RangeAreasを返します。 RangeAreas 内に使用されているセルがない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

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

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

戻り値

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

戻り値

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

戻り値

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

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

パラメーター

戻り値

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.RangeAreas): void;

パラメーター

戻り値

次の再計算が発生したときに再計算される RangeAreas を設定します。

setDirty(): void;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.RangeAreas オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.RangeAreasData として型指定) を返します。

toJSON(): Excel.Interfaces.RangeAreasData;

戻り値

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。

track(): Excel.RangeAreas;

戻り値

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。

untrack(): Excel.RangeAreas;

戻り値