Edit

Share via

Excel.Interfaces.NamedItemLoadOptions interface

Package:
excel

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

Remarks

[ API set: ExcelApi 1.1 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
name

The name of the object.
type

Specifies the type of the value returned by the name's formula. See Excel.NamedItemType for details.
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

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

name

The name of the object.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

type

Specifies the type of the value returned by the name's formula. See Excel.NamedItemType for details.

type?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

visible

Specifies if the object is visible.

visible?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]