Edit

Excel.Interfaces.RangeAreasData interface

  • Reference
Package:
excel

An interface describing the data returned by calling rangeAreas.toJSON().

Properties

address

Returns the RangeAreas reference in A1-style. Address value will contain the worksheet name for each rectangular block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4").
addressLocal

Returns the RangeAreas reference in the user locale.
areaCount

Returns the number of rectangular ranges that comprise this RangeAreas object.
areas

Returns a collection of rectangular ranges that comprise this RangeAreas object.
cellCount

Returns the number of cells in the RangeAreas object, summing up the cell counts of all of the individual rectangular ranges. Returns -1 if the cell count exceeds 2^31-1 (2,147,483,647).
conditionalFormats

Returns a collection of conditional formats that intersect with any cells in this RangeAreas object.
dataValidation

Returns a data validation object for all ranges in the RangeAreas.
format

Returns a RangeFormat object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the RangeAreas object.
isEntireColumn

Specifies if all the ranges on this RangeAreas object represent entire columns (e.g., "A:C, Q:Z").
isEntireRow

Specifies if all the ranges on this RangeAreas object represent entire rows (e.g., "1:3, 5:7").
style

Represents the style for all ranges in this RangeAreas object. If the styles of the cells are inconsistent, null will be returned. For custom styles, the style name will be returned. For built-in styles, a string representing a value in the BuiltInStyle enum will be returned.

Property Details

address

Returns the RangeAreas reference in A1-style. Address value will contain the worksheet name for each rectangular block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4").

address?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]

addressLocal

Returns the RangeAreas reference in the user locale.

addressLocal?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]

areaCount

Returns the number of rectangular ranges that comprise this RangeAreas object.

areaCount?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

areas

Returns a collection of rectangular ranges that comprise this RangeAreas object.

areas?: Excel.Interfaces.RangeData[];

Property Value

Excel.Interfaces.RangeData[]

Remarks

[ API set: ExcelApi 1.9 ]

cellCount

Returns the number of cells in the RangeAreas object, summing up the cell counts of all of the individual rectangular ranges. Returns -1 if the cell count exceeds 2^31-1 (2,147,483,647).

cellCount?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

conditionalFormats

Returns a collection of conditional formats that intersect with any cells in this RangeAreas object.

conditionalFormats?: Excel.Interfaces.ConditionalFormatData[];

Property Value

Excel.Interfaces.ConditionalFormatData[]

Remarks

[ API set: ExcelApi 1.9 ]

dataValidation

Returns a data validation object for all ranges in the RangeAreas.

dataValidation?: Excel.Interfaces.DataValidationData;

Property Value

Excel.Interfaces.DataValidationData

Remarks

[ API set: ExcelApi 1.9 ]

format

Returns a RangeFormat object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the RangeAreas object.

format?: Excel.Interfaces.RangeFormatData;

Property Value

Excel.Interfaces.RangeFormatData

Remarks

[ API set: ExcelApi 1.9 ]

isEntireColumn

Specifies if all the ranges on this RangeAreas object represent entire columns (e.g., "A:C, Q:Z").

isEntireColumn?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

isEntireRow

Specifies if all the ranges on this RangeAreas object represent entire rows (e.g., "1:3, 5:7").

isEntireRow?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

style

Represents the style for all ranges in this RangeAreas object. If the styles of the cells are inconsistent, null will be returned. For custom styles, the style name will be returned. For built-in styles, a string representing a value in the BuiltInStyle enum will be returned.

style?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]