Excel.Interfaces.NamedItemData interface
An interface describing the data returned by calling namedItem.toJSON().
Properties
| comment | Specifies the comment associated with this name. |
| name | The name of the object. |
| scope | Specifies if the name is scoped to the workbook or to a specific worksheet. Possible values are: Worksheet, Workbook. |
| type | Specifies the type of the value returned by the name's formula. See |
| value | Represents the value computed by the name's formula. For a named range, it will return the range address. This API returns the #VALUE! error in the Excel UI if it refers to a user-defined function. |
| visible | Specifies if the object is visible. |
Property Details
comment
Specifies the comment associated with this name.
comment?: string;Property Value
string
Remarks
name
scope
Specifies if the name is scoped to the workbook or to a specific worksheet. Possible values are: Worksheet, Workbook.
scope?: Excel.NamedItemScope | "Worksheet" | "Workbook";Property Value
Excel.NamedItemScope | "Worksheet" | "Workbook"
Remarks
type
Specifies the type of the value returned by the name's formula. See Excel.NamedItemType for details.
type?: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";Property Value
Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array"
Remarks
API set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 for Array
value
Represents the value computed by the name's formula. For a named range, it will return the range address. This API returns the #VALUE! error in the Excel UI if it refers to a user-defined function.
value?: any;Property Value
any
Remarks
visible
Specifies if the object is visible.
visible?: boolean;Property Value
boolean