Excel.Interfaces.RangeAreasCollectionLoadOptions interface
Contains the collection of cross-workbook level ranges.
Remarks
Properties
$all | Specifying |
address | For EACH ITEM in the collection: Returns the |
address |
For EACH ITEM in the collection: Returns the |
area |
For EACH ITEM in the collection: Returns the number of rectangular ranges that comprise this |
cell |
For EACH ITEM in the collection: Returns the number of cells in the |
data |
For EACH ITEM in the collection: Returns a data validation object for all ranges in the |
format | For EACH ITEM in the collection: Returns a |
is |
For EACH ITEM in the collection: Specifies if all the ranges on this |
is |
For EACH ITEM in the collection: Specifies if all the ranges on this |
style | For EACH ITEM in the collection: Represents the style for all ranges in this |
worksheet | For EACH ITEM in the collection: Returns the worksheet for the current |
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
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
addressLocal
For EACH ITEM in the collection: Returns the RangeAreas
reference in the user locale.
addressLocal?: boolean;
Property Value
boolean
Remarks
areaCount
For EACH ITEM in the collection: Returns the number of rectangular ranges that comprise this RangeAreas
object.
areaCount?: boolean;
Property Value
boolean
Remarks
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
dataValidation
For EACH ITEM in the collection: Returns a data validation object for all ranges in the RangeAreas
.
dataValidation?: Excel.Interfaces.DataValidationLoadOptions;
Property Value
Remarks
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
Remarks
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
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
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
worksheet
For EACH ITEM in the collection: Returns the worksheet for the current RangeAreas
.
worksheet?: Excel.Interfaces.WorksheetLoadOptions;
Property Value
Remarks
Office Add-ins