Excel.Interfaces.NamedItemLoadOptions interface
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
Properties
| $all | Specifying |
| array |
Returns an object containing values and types of the named item. |
| comment | Specifies the comment associated with this name. |
| formula | The formula of the named item. Formulas always start with an equal sign ("="). |
| 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. |
| worksheet | Returns the worksheet on which the named item is scoped to. Throws an error if the item is scoped to the workbook instead. |
| worksheet |
Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this method returns an object with its |
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
arrayValues
Returns an object containing values and types of the named item.
arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;Property Value
Remarks
comment
Specifies the comment associated with this name.
comment?: boolean;Property Value
boolean
Remarks
formula
The formula of the named item. Formulas always start with an equal sign ("=").
formula?: boolean;Property Value
boolean
Remarks
name
scope
Specifies if the name is scoped to the workbook or to a specific worksheet. Possible values are: Worksheet, Workbook.
scope?: boolean;Property Value
boolean
Remarks
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
visible
Specifies if the object is visible.
visible?: boolean;Property Value
boolean
Remarks
worksheet
Returns the worksheet on which the named item is scoped to. Throws an error if the item is scoped to the workbook instead.
worksheet?: Excel.Interfaces.WorksheetLoadOptions;Property Value
Remarks
worksheetOrNullObject
Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;Property Value
Remarks
Office Add-ins