Excel.NoteCollection class
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Represents a collection of note objects that are part of the workbook.
- Extends
Remarks
[ API set: ExcelApi BETA (PREVIEW ONLY) ]
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| items | Gets the loaded child items in this collection. |
Methods
| add(cell |
Adds a new note with the given content on the given cell. |
| get |
Gets the number of notes in the collection. |
| get |
Gets a note object by its index in the collection. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
Property Details
context
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
items
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets the loaded child items in this collection.
readonly items: Excel.Note[];Property Value
Method Details
add(cellAddress, content)
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Adds a new note with the given content on the given cell.
add(cellAddress: Range | string, content: any): Excel.Note;Parameters
- cellAddress
-
Excel.Range | string
The cell to which the note is added. This can be a Range object or a string such as "A1". If the string is invalid, or the range is not a single cell, an InvalidCellAddress error is thrown.
- content
-
any
The text of the note.
Returns
Remarks
getCount()
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets the number of notes in the collection.
getCount(): OfficeExtension.ClientResult<number>;Returns
OfficeExtension.ClientResult<number>
Remarks
getItemAt(index)
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets a note object by its index in the collection.
getItemAt(index: number): Excel.Note;Parameters
- index
-
number
The index value of the note to be retrieved. Zero-indexed.
Returns
Remarks
load(options)
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Excel.Interfaces.NoteCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NoteCollection;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.NoteCollection;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NoteCollection;Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
toJSON()
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.NoteCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.NoteCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Excel.Interfaces.NoteCollectionData;Returns
Office Add-ins