Excel.Interfaces.NamedItemCollectionLoadOptions interface

A collection of all the NamedItem objects that are part of the workbook or worksheet, depending on how it was reached.

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

For EACH ITEM in the collection: The name of the object.

type

For EACH ITEM in the collection: Specifies the type of the value returned by the name's formula. See Excel.NamedItemType for details.

value

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: The name of the object.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

type

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies if the object is visible.

visible?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]