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
Properties
| $all | Specifying |
| array |
For EACH ITEM in the collection: Returns an object containing values and types of the named item. |
| comment | For EACH ITEM in the collection: Specifies the comment associated with this name. |
| formula | For EACH ITEM in the collection: The formula of the named item. Formulas always start with an equal sign ("="). |
| name | For EACH ITEM in the collection: The name of the object. |
| scope | For EACH ITEM in the collection: Specifies if the name is scoped to the workbook or to a specific worksheet. Possible values are: Worksheet, Workbook. |
| type | For EACH ITEM in the collection: Specifies the type of the value returned by the name's formula. See |
| 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 |
For EACH ITEM in the collection: A JSON representation of the values in this named item. Unlike |
| value |
For EACH ITEM in the collection: A JSON representation of the values in this named item. Unlike |
| visible | For EACH ITEM in the collection: Specifies if the object is visible. |
| worksheet | For EACH ITEM in the collection: Returns the worksheet on which the named item is scoped to. Throws an error if the item is scoped to the workbook instead. |
| worksheet |
For EACH ITEM in the collection: 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 LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
$all?: boolean;Property Value
boolean
arrayValues
For EACH ITEM in the collection: Returns an object containing values and types of the named item.
arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;Property Value
Remarks
comment
For EACH ITEM in the collection: Specifies the comment associated with this name.
comment?: boolean;Property Value
boolean
Remarks
formula
For EACH ITEM in the collection: The formula of the named item. Formulas always start with an equal sign ("=").
formula?: boolean;Property Value
boolean
Remarks
name
For EACH ITEM in the collection: The name of the object.
name?: boolean;Property Value
boolean
Remarks
scope
For EACH ITEM in the collection: 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
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
valueAsJson
For EACH ITEM in the collection: A JSON representation of the values in this named item. Unlike NamedItem.value, NamedItem.valueAsJson supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use NamedItem.valueAsJsonLocal.
valueAsJson?: boolean;Property Value
boolean
Remarks
valueAsJsonLocal
For EACH ITEM in the collection: A JSON representation of the values in this named item. Unlike NamedItem.value, NamedItem.valueAsJsonLocal supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use NamedItem.valueAsJson.
valueAsJsonLocal?: boolean;Property Value
boolean
Remarks
visible
For EACH ITEM in the collection: Specifies if the object is visible.
visible?: boolean;Property Value
boolean
Remarks
worksheet
For EACH ITEM in the collection: 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
For EACH ITEM in the collection: 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
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for