Excel.Interfaces.RangeUpdateData interface
An interface for updating data on the Range object, for use in range.set({ ... }).
Properties
| column |
Represents if all columns in the current range are hidden. Value is |
| control | Accesses the cell control applied to this range. If the range has multiple cell controls, this returns |
| data |
Returns a data validation object. |
| format | Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. |
| formulas | Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. |
| formulas |
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 | Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. |
| hyperlink | Represents the hyperlink for the current range. |
| number |
Represents Excel's number format code for the given range. For more information about Excel number formatting, see Number format codes. |
| number |
Represents Excel's number format code for the given range, based on the language settings of the user. Excel does not perform any language or format coercion when getting or setting the |
| row |
Represents if all rows in the current range are hidden. Value is |
| style | Represents the style of the current range. If the styles of the cells are inconsistent, |
| values | Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. |
| values |
A JSON representation of the values in the cells in this range. Unlike |
| values |
A JSON representation of the values in the cells in this range. Unlike |
Property Details
columnHidden
Represents if all columns in the current range are hidden. Value is true when all columns in a range are hidden. Value is false when no columns in the range are hidden. Value is null when some columns in a range are hidden and other columns in the same range are not hidden.
columnHidden?: boolean;Property Value
boolean
Remarks
control
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Accesses the cell control applied to this range. If the range has multiple cell controls, this returns EmptyCellControl.
control?: CellControl;Property Value
Remarks
dataValidation
Returns a data validation object.
dataValidation?: Excel.Interfaces.DataValidationUpdateData;Property Value
Remarks
format
Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties.
format?: Excel.Interfaces.RangeFormatUpdateData;Property Value
Remarks
formulas
Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
formulas?: any[][];Property Value
any[][]
Remarks
formulasLocal
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?: any[][];Property Value
any[][]
Remarks
formulasR1C1
Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.
formulasR1C1?: any[][];Property Value
any[][]
Remarks
hyperlink
Represents the hyperlink for the current range.
hyperlink?: Excel.RangeHyperlink;Property Value
Remarks
numberFormat
Represents Excel's number format code for the given range. For more information about Excel number formatting, see Number format codes.
numberFormat?: any[][];Property Value
any[][]
Remarks
numberFormatLocal
Represents Excel's number format code for the given range, based on the language settings of the user. Excel does not perform any language or format coercion when getting or setting the numberFormatLocal property. Any returned text uses the locally-formatted strings based on the language specified in the system settings.
numberFormatLocal?: any[][];Property Value
any[][]
Remarks
rowHidden
Represents if all rows in the current range are hidden. Value is true when all rows in a range are hidden. Value is false when no rows in the range are hidden. Value is null when some rows in a range are hidden and other rows in the same range are not hidden.
rowHidden?: boolean;Property Value
boolean
Remarks
style
Represents the style of the current range. 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?: string;Property Value
string
Remarks
values
Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula.
values?: any[][];Property Value
any[][]
Remarks
valuesAsJson
A JSON representation of the values in the cells in this range. Unlike Range.values, Range.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 Range.valuesAsJsonLocal.
valuesAsJson?: CellValue[][];Property Value
Excel.CellValue[][]
Remarks
valuesAsJsonLocal
A JSON representation of the values in the cells in this range. Unlike Range.values, Range.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 Range.valuesAsJson.
valuesAsJsonLocal?: CellValue[][];Property Value
Excel.CellValue[][]
Remarks
Office Add-ins