# workbookRange resource type

Namespace: microsoft.graph

Important

APIs under the `/beta`

version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the **Version** selector.

Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc.

## Methods

Method | Return Type | Description |
---|---|---|

Get Range | workbookRange | Read properties and relationships of range object. |

Update | workbookRange | Update Range object. |

Boundingrect | workbookRange | Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E16". |

Cell | workbookRange | Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range. |

Column | workbookRange | Gets a column contained in the range. |

Columnsafter | workbookRangeView | Gets a certain number of columns to the right of the given range. |

Columnsbefore | workbookRangeView | Gets a certain number of columns to the left of the given range. |

Entirecolumn | workbookRange | Gets an object that represents the entire column of the range. |

Entirerow | workbookRange | Gets an object that represents the entire row of the range. |

Intersection | workbookRange | Gets the range object that represents the rectangular intersection of the given ranges. |

Lastcell | Range | Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5". |

Lastcolumn | workbookRange | Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5". |

Lastrow | Range | Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5". |

Offsetrange | workbookRange | Gets an object which represents a range that's offset from the specified range. The dimension of the returned range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an exception will be thrown. |

Row | Range | Gets a row contained in the range. |

Rowsabove | workbookRangeView | Gets a certain number of rows above a given range. |

Rowsbelow | workbookRangeView | Gets a certain number of rows below a given range. |

Usedrange | workbookRange | Returns the used range of the given range object. |

Clear | None | Clear range values, format, fill, border, etc. |

Delete | None | Deletes the cells associated with the range. |

Insert | workbookRange | Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. Returns a new Range object at the now blank space. |

Merge | None | Merge the range cells into one region in the worksheet. |

Resizedrange | workbookRangeView | Gets a range object similar to the current range object, but with its bottom-right corner expanded (or contracted) by some number of rows and columns. |

Unmerge | None | Unmerge the range cells into separate cells. |

Visibleview | workbookRangeView | Get the range visible from a filtered range. |

## Properties

Property | Type | Description |
---|---|---|

address | string | Represents the range reference in A1-style. Address value will contain the Sheet reference (e.g. Sheet1!A1:B4). Read-only. |

addressLocal | string | Represents range reference for the specified range in the language of the user. Read-only. |

cellCount | int | Number of cells in the range. Read-only. |

columnCount | int | Represents the total number of columns in the range. Read-only. |

columnHidden | boolean | Represents if all columns of the current range are hidden. |

columnIndex | int | Represents the column number of the first cell in the range. Zero-indexed. Read-only. |

formulas | Json | Represents the formula in A1-style notation. |

formulasLocal | Json | 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. |

formulasR1C1 | Json | Represents the formula in R1C1-style notation. |

hidden | boolean | Represents if all cells of the current range are hidden. Read-only. |

numberFormat | Json | Represents Excel's number format code for the given cell. |

rowCount | int | Returns the total number of rows in the range. Read-only. |

rowHidden | boolean | Represents if all rows of the current range are hidden. |

rowIndex | int | Returns the row number of the first cell in the range. Zero-indexed. Read-only. |

text | Json | 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. Read-only. |

valueTypes | string | Represents the type of data of each cell. Possible values are: `Unknown` , `Empty` , `String` , `Integer` , `Double` , `Boolean` , `Error` . Read-only. |

values | Json | Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. |

## Relationships

Relationship | Type | Description |
---|---|---|

format | workbookRangeFormat | Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. Read-only. |

sort | workbookRangeSort | The worksheet containing the current range. Read-only. |

worksheet | workbookWorksheet | The worksheet containing the current range. Read-only. |

## JSON representation

Here is a JSON representation of the resource.

```
{
"id": "string",
"address": "string",
"addressLocal": "string",
"cellCount": 1024,
"columnCount": 1024,
"columnHidden": true,
"columnIndex": 1024,
"formulas": "Json",
"formulasLocal": "Json",
"formulasR1C1": "Json",
"hidden": true,
"numberFormat": "Json",
"rowCount": 1024,
"rowHidden": true,
"rowIndex": 1024,
"text": "Json",
"valueTypes": "string",
"values": "json"
}
```