Excel.RangeAreas class

RangeAreas参照を A1 スタイルで返します。 アドレスの値には、セルの各長方形ブロックのワークシート名が含まれます (例: "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(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void;

パラメーター

返品

注釈

API セット: ExcelApi 1.9

範囲内のセルの値をクリアします。コントロールを含むセルに特に注意を払います。 範囲に空白の値のみが含まれていて、コントロールが既定値に設定されている場合、値とコントロールの書式設定は削除されます。 それ以外の場合、これにより、コントロールのあるセルが既定値に設定され、範囲内の他のセルの値がクリアされます。

clearOrResetContents(): void;

返品

注釈

API セット: ExcelApi 1.18

データ型を持つ 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, copyType?: "All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths", 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(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible" | "DirtyFormulas", cellValueType?: "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(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible" | "DirtyFormulas", cellValueType?: "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;

パラメーター

返品

Excel UI で指定した範囲領域を選択します。

select(): void;

返品

注釈

API セット: ExcelApi 1.18

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の 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;

返品