Excel.Interfaces.RangeViewCollectionLoadOptions interface

Package:

excel

Represents a collection of RangeView objects.

Remarks

[ API set: ExcelApi 1.3 ]

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).
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.
valuesAsJson	For EACH ITEM in the collection: A JSON representation of the values in the cells in this range. Unlike RangeView.values, RangeView.valuesAsJson supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use RangeView.valuesAsJsonLocal.
valuesAsJsonLocal	For EACH ITEM in the collection: A JSON representation of the values in the cells in this range. Unlike RangeView.values, RangeView.valuesAsJsonLocal supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use RangeView.valuesAsJson.
valueTypes	For EACH ITEM in the collection: Represents the type of data of each cell.

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

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 ]

valuesAsJson

For EACH ITEM in the collection: A JSON representation of the values in the cells in this range. Unlike RangeView.values, RangeView.valuesAsJson supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use RangeView.valuesAsJsonLocal.

valuesAsJson?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.16 ]

valuesAsJsonLocal

For EACH ITEM in the collection: A JSON representation of the values in the cells in this range. Unlike RangeView.values, RangeView.valuesAsJsonLocal supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use RangeView.valuesAsJson.

valuesAsJsonLocal?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.16 ]

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 ]