Edit

Share via

Excel.Interfaces.RangeAreasLoadOptions interface

  • Reference
Package:
excel

RangeAreas represents a collection of one or more rectangular ranges in the same worksheet. To learn how to use discontiguous ranges, read Work with multiple ranges simultaneously in Excel add-ins.

Remarks

[ API set: ExcelApi 1.9 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
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.
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).
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.
worksheet

Returns the worksheet for the current RangeAreas.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

addressLocal

Returns the RangeAreas reference in the user locale.

addressLocal?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

areaCount

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

areaCount?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

dataValidation

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

dataValidation?: Excel.Interfaces.DataValidationLoadOptions;

Property Value

Excel.Interfaces.DataValidationLoadOptions

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.RangeFormatLoadOptions;

Property Value

Excel.Interfaces.RangeFormatLoadOptions

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

worksheet

Returns the worksheet for the current RangeAreas.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Property Value

Excel.Interfaces.WorksheetLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]