workbookNamedItem resource type

  • Article

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.

Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the following type), range object, reference to a range. This object can be used to obtain range object associated with names.

Methods

Method Return Type Description
List workbookNamedItem collection Get the list of workbookNamedItem objects.
Add workbookNamedItem Add a new workbookNamedItem object to the collection of the given scope.
Get workbookNamedItem Read the properties and relationships of a workbookNamedItem object.
Update workbookNamedItem Update a workbookNamedItem object.
Delete None Delete a workbookNamedItem object.
Add named item to collection workbookNamedItem Add a new workbookNamedItem object to the collection of the given scope. Uses the user's locale for the formula.
List range workbookRange Return the range object that is associated with the workbookNamedItem object. Throw an exception if the workbookNamedItem object's type is not a range.

Properties

Property Type Description
comment String The comment associated with this name.
name String The name of the object. Read-only.
scope String Indicates whether the name is scoped to the workbook or to a specific worksheet. Read-only.
type String The type of reference is associated with the name. Possible values are: String, Integer, Double, Boolean, Range. Read-only.
value String The formula that the name is defined to refer to. For example, =Sheet14!$B$2:$H$12 and =4.75. Read-only.
visible Boolean Indicates whether the object is visible.

Relationships

Relationship Type Description
worksheet workbookWorksheet Return the worksheet to which the named item is scoped. Available only if the item is scoped to the worksheet. Read-only.

JSON representation

The following JSON representation shows the resource type.

{
  "comment": "String",
  "name": "String",
  "scope": "String",
  "type": "String",
  "value": "String",
  "visible": "Boolean"
}