workbookNamedItem 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.

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
Add	workbookNamedItem	Add a new name to the collection of the given scope.
AddFormulaLocal	workbookNamedItem	Add a new name to the collection of the given scope using the user's locale for the formula.
Get NamedItem	workbookNamedItem	Read properties and relationships of namedItem object.
Update	workbookNamedItem	Update a namedItem object.
Range	workbookRange	Return the range object that is associated with the name. Throw an exception if the named item's type is not a range.
List	workbookNamedItem collection	Get a collection of namedItem objects.
Delete	None	Delete a workbookNamedItem object.

Properties

Property	Type	Description
comment	String	Represents 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	Indicates what type of reference is associated with the name. Possible values are: String, Integer, Double, Boolean, Range. Read-only.
value	String	Represents the formula that the name is defined to refer to. For example, =Sheet14!$B$2:$H$12 and =4.75. Read-only.
visible	Boolean	Specifies whether the object is visible or not.

Relationships

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

JSON representation

The following is a JSON representation of the resource.

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