Excel.Interfaces.NamedItemData interface

An interface describing the data returned by calling "namedItem.toJSON()".

Properties

arrayValues

Returns an object containing values and types of the named item. Read-only.

[ API set: ExcelApi 1.7 ]

comment

Represents the comment associated with this name.

[ API set: ExcelApi 1.4 ]

formula

Gets or sets the formula of the named item. Formula always starts with a '=' sign.

[ API set: ExcelApi 1.7 ]

name

The name of the object. Read-only.

[ API set: ExcelApi 1.1 ]

scope

Indicates whether the name is scoped to the workbook or to a specific worksheet. Possible values are: Worksheet, Workbook. Read-only.

[ API set: ExcelApi 1.4 ]

type

Indicates the type of the value returned by the name's formula. See Excel.NamedItemType for details. Read-only.

[ 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, will return the range address. Read-only.

[ API set: ExcelApi 1.1 ]

visible

Specifies whether the object is visible or not.

[ API set: ExcelApi 1.1 ]

Property Details

arrayValues

Returns an object containing values and types of the named item. Read-only.

[ API set: ExcelApi 1.7 ]

arrayValues?: Excel.Interfaces.NamedItemArrayValuesData;

Property Value

comment

Represents the comment associated with this name.

[ API set: ExcelApi 1.4 ]

comment?: string;

Property Value

string

formula

Gets or sets the formula of the named item. Formula always starts with a '=' sign.

[ API set: ExcelApi 1.7 ]

formula?: any;

Property Value

any

name

The name of the object. Read-only.

[ API set: ExcelApi 1.1 ]

name?: string;

Property Value

string

scope

Indicates whether the name is scoped to the workbook or to a specific worksheet. Possible values are: Worksheet, Workbook. Read-only.

[ API set: ExcelApi 1.4 ]

scope?: Excel.NamedItemScope | "Worksheet" | "Workbook";

Property Value

Excel.NamedItemScope | "Worksheet" | "Workbook"

type

Indicates the type of the value returned by the name's formula. See Excel.NamedItemType for details. Read-only.

[ API set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 for Array ]

type?: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";

Property Value

Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array"

value

Represents the value computed by the name's formula. For a named range, will return the range address. Read-only.

[ API set: ExcelApi 1.1 ]

value?: any;

Property Value

any

visible

Specifies whether the object is visible or not.

[ API set: ExcelApi 1.1 ]

visible?: boolean;

Property Value

boolean