workbookRangeFormat 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.
A format object encapsulating the range's font, fill, borders, alignment, and other properties.
Methods
Method | Return Type | Description |
---|---|---|
Get workbookRangeFormat | workbookRangeFormat | Read properties and relationships of rangeFormat object. |
Create workbookRangeBorder | workbookRangeBorder | Create a new RangeBorder by posting to the borders collection. |
List borders | workbookRangeBorder collection | Get a RangeBorder object collection. |
Update | workbookRangeFormat | Update RangeFormat object. |
Autofitcolumns | None | Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. |
Autofitrows | None | Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. |
Properties
Property | Type | Description |
---|---|---|
columnWidth | double | Gets or sets the width of all columns within the range. If the column widths aren't uniform, null will be returned. |
horizontalAlignment | string | Represents the horizontal alignment for the specified object. Possible values are: General , Left , Center , Right , Fill , Justify , CenterAcrossSelection , Distributed . |
rowHeight | double | Gets or sets the height of all rows in the range. If the row heights aren't uniform null will be returned. |
verticalAlignment | string | Represents the vertical alignment for the specified object. Possible values are: Top , Center , Bottom , Justify , Distributed . |
wrapText | boolean | Indicates if Excel wraps the text in the object. A null value indicates that the entire range doesn't have uniform wrap setting |
Relationships
Relationship | Type | Description |
---|---|---|
borders | workbookRangeBorder collection | Collection of border objects that apply to the overall range selected Read-only. |
fill | workbookRangeFill | Returns the fill object defined on the overall range. Read-only. |
font | workbookRangeFont | Returns the font object defined on the overall range selected Read-only. |
protection | formatProtection | Returns the format protection object for a range. Read-only. |
JSON representation
The following JSON representation shows the resource type.
{
"columnWidth": 1024,
"horizontalAlignment": "string",
"rowHeight": 1024,
"verticalAlignment": "string",
"wrapText": true
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for