Excel.NoteCollection class

Package:

excel

Represents a collection of note objects that are part of the workbook.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.18 ]

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(cellAddress, content)	Adds a new note with the given content on the given cell.
getCount()	Gets the number of notes in the collection.
getItem(key)	Gets a note by its cell address.
getItemAt(index)	Gets a note from the collection based on its position.
getItemOrNullObject(key)	Gets a note by its cell address. If the note object does not exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
toJSON()	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.

Property Details

context

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

Excel.RequestContext

items

Gets the loaded child items in this collection.

readonly items: Excel.Note[];

Property Value

Excel.Note[]

Method Details

add(cellAddress, content)

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

Excel.Note

Remarks

[ API set: ExcelApi 1.18 ]

getCount()

Gets the number of notes in the collection.

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

Remarks

[ API set: ExcelApi 1.18 ]

getItem(key)

Gets a note by its cell address.

getItem(key: string): Excel.Note;

Parameters

key

string

The cell address of the note.

Returns

Excel.Note

The note with the given cell address. If there is no note with the given cell address, then the ItemNotFound error is thrown.

Remarks

[ API set: ExcelApi 1.18 ]

getItemAt(index)

Gets a note from the collection based on its position.

getItemAt(index: number): Excel.Note;

Parameters

index

number

The index value of the note to be retrieved. Zero-indexed.

Returns

Excel.Note

Remarks

[ API set: ExcelApi 1.18 ]

getItemOrNullObject(key)

Gets a note by its cell address. If the note object does not exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

getItemOrNullObject(key: string): Excel.Note;

Parameters

key

string

The cell address of the note.

Returns

Excel.Note

The note with the given cell address or null object.

Remarks

[ API set: ExcelApi 1.18 ]

load(options)

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

options

Excel.Interfaces.NoteCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.NoteCollection

load(propertyNames)

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

Excel.NoteCollection

load(propertyNamesAndPaths)

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

Excel.NoteCollection

toJSON()

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

Excel.Interfaces.NoteCollectionData