Edit

Share via

Excel.Interfaces.NoteCollectionLoadOptions interface

Package:
excel

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

Remarks

[ API set: ExcelApi 1.18 ]

Properties

$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).
authorName

For EACH ITEM in the collection: Gets the author of the note.
content

For EACH ITEM in the collection: Specifies the text of the note.
height

For EACH ITEM in the collection: Specifies the height of the note.
visible

For EACH ITEM in the collection: Specifies the visibility of the note. A value of true means the note is shown.
width

For EACH ITEM in the collection: Specifies the width of the note.

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

authorName

For EACH ITEM in the collection: Gets the author of the note.

authorName?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.18 ]

content

For EACH ITEM in the collection: Specifies the text of the note.

content?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.18 ]

height

For EACH ITEM in the collection: Specifies the height of the note.

height?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.18 ]

visible

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies the width of the note.

width?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.18 ]