Excel.Interfaces.RangeAreasCollectionLoadOptions interface

Package:

excel

Contains the collection of cross-workbook level ranges.

Remarks

[ API set: ExcelApi 1.12 ]

Properties

$all	Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
address	For EACH ITEM in the collection: 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	For EACH ITEM in the collection: Returns the RangeAreas reference in the user locale.
areaCount	For EACH ITEM in the collection: Returns the number of rectangular ranges that comprise this RangeAreas object.
cellCount	For EACH ITEM in the collection: 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	For EACH ITEM in the collection: Returns a data validation object for all ranges in the RangeAreas.
format	For EACH ITEM in the collection: Returns a RangeFormat object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the RangeAreas object.
isEntireColumn	For EACH ITEM in the collection: Specifies if all the ranges on this RangeAreas object represent entire columns (e.g., "A:C, Q:Z").
isEntireRow	For EACH ITEM in the collection: Specifies if all the ranges on this RangeAreas object represent entire rows (e.g., "1:3, 5:7").
style	For EACH ITEM in the collection: 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	For EACH ITEM in the collection: Returns the worksheet for the current RangeAreas.

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

address

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Returns the RangeAreas reference in the user locale.

addressLocal?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

areaCount

For EACH ITEM in the collection: Returns the number of rectangular ranges that comprise this RangeAreas object.

areaCount?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

cellCount

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Returns the worksheet for the current RangeAreas.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Property Value

Excel.Interfaces.WorksheetLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]