Excel.Note class

Package:

excel

Represents a note in the workbook or worksheet.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.18 ]

Properties

authorName	Gets the author of the note.
content	Gets or sets the text of the note.
context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
height	Specifies the height of the note.
visible	Specifies the visibility of the note. A value of true means the note is shown.
width	Specifies the width of the note.

Methods

delete()	Deletes the note.
getLocation()	Gets the cell where this note is located.
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.
set(properties, options)	Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties)	Sets multiple properties on the object at the same time, based on an existing loaded object.
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.Note object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.NoteData) that contains shallow copies of any loaded child properties from the original object.

Property Details

authorName

Gets the author of the note.

readonly authorName: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.18 ]

content

Gets or sets the text of the note.

content: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.18 ]

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

height

Specifies the height of the note.

height: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.18 ]

visible

Specifies the visibility of the note. A value of true means the note is shown.

visible: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.18 ]

width

Specifies the width of the note.

width: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.18 ]

Method Details

delete()

Deletes the note.

delete(): void;

Returns

void

Remarks

[ API set: ExcelApi 1.18 ]

getLocation()

Gets the cell where this note is located.

getLocation(): Excel.Range;

Returns

Excel.Range

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.NoteLoadOptions): Excel.Note;

Parameters

options

Excel.Interfaces.NoteLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.Note

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.Note;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.Note

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?: {
            select?: string;
            expand?: string;
        }): Excel.Note;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

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.Note

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.NoteUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties

Excel.Interfaces.NoteUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options

OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.Note): void;

Parameters

properties

Excel.Note

Returns

void

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.Note object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.NoteData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.NoteData;

Returns

Excel.Interfaces.NoteData