Skip to content

rangefont-update.md

Latest commit

 

History

History
119 lines (100 loc) · 4.17 KB

rangefont-update.md

File metadata and controls

119 lines (100 loc) · 4.17 KB
title Update rangeFont
description Update the properties of rangeFont object.
author lumine2008
ms.localizationpriority medium
ms.subservice excel
doc_type apiPageType
ms.date 08/21/2024

Update rangeFont

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Update the properties of rangeFont object.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

PATCH /me/drive/items/{id}/workbook/names/{name}/range/format/font
PATCH /me/drive/root:/{item-path}:/workbook/names/{name}/range/format/font
PATCH /me/drive/items/{id}/workbook/worksheets/{id|name}/range(address='<address>')/format/font
PATCH /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/range(address='<address>')/format/font
PATCH /me/drive/items/{id}/workbook/tables/{id|name}/columns/{id|name}/range/format/font
PATCH /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/range/format/font

Optional request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Workbook-Session-ID Workbook session ID that determines if changes are persisted or not. Optional.

Request body

In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, don't include existing values that didn't change.

Property Type Description
bold Boolean Represents the bold status of font.
color string HTML color code representation of the text color. for example, #FF0000 represents Red.
italic Boolean Represents the italic status of the font.
name string Font name (for example "Calibri")
size double Font size.
underline string Type of underline applied to the font. The possible values are: None, Single, Double, SingleAccountant, DoubleAccountant.

Response

If successful, this method returns a 200 OK response code and updated workbookRangeFont object in the response body.

Example

Request

The following example shows a request.

HTTP

PATCH https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/format/font
Content-type: application/json

{
  "bold": true,
  "color": "color-value",
  "italic": true,
  "name": "name-value",
  "size": 99,
  "underline": "underline-value"
}

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response. Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "bold": true,
  "color": "color-value",
  "italic": true,
  "name": "name-value",
  "size": 99,
  "underline": "underline-value"
}