Excel.Interfaces.RangeViewCollectionLoadOptions interface

Represents a collection of RangeView objects.

Remarks

[ API set: ExcelApi 1.3 ]

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).

cellAddresses

For EACH ITEM in the collection: Represents the cell addresses of the RangeView.

columnCount

For EACH ITEM in the collection: The number of visible columns.

formulas

For EACH ITEM in the collection: Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.

formulasLocal

For EACH ITEM in the collection: Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is returned instead.

formulasR1C1

For EACH ITEM in the collection: Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.

index

For EACH ITEM in the collection: Returns a value that represents the index of the RangeView.

numberFormat

For EACH ITEM in the collection: Represents Excel's number format code for the given cell.

rowCount

For EACH ITEM in the collection: The number of visible rows.

text

For EACH ITEM in the collection: Text values of the specified range. The text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API.

values

For EACH ITEM in the collection: Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cells that contain an error will return the error string.

valueTypes

For EACH ITEM in the collection: Represents the type of data of each cell.

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

cellAddresses

For EACH ITEM in the collection: Represents the cell addresses of the RangeView.

cellAddresses?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

columnCount

For EACH ITEM in the collection: The number of visible columns.

columnCount?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

formulas

For EACH ITEM in the collection: Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.

formulas?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

formulasLocal

For EACH ITEM in the collection: Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is returned instead.

formulasLocal?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

formulasR1C1

For EACH ITEM in the collection: Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.

formulasR1C1?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

index

For EACH ITEM in the collection: Returns a value that represents the index of the RangeView.

index?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

numberFormat

For EACH ITEM in the collection: Represents Excel's number format code for the given cell.

numberFormat?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

rowCount

For EACH ITEM in the collection: The number of visible rows.

rowCount?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

text

For EACH ITEM in the collection: Text values of the specified range. The text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API.

text?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

values

For EACH ITEM in the collection: Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cells that contain an error will return the error string.

values?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

valueTypes

For EACH ITEM in the collection: Represents the type of data of each cell.

valueTypes?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]