ASP.NET Core MVC Controls | ComponentOne
In This Topic
    WorkbookNote Class
    In This Topic
    File
    wijmo.xlsx.js
    Module
    wijmo.xlsx
    Implements
    IWorkbookNote

    Represents the Workbook Object Model note definition.

    Constructor

    Properties

    Constructor

    constructor

    constructor(): void
    

    Initializes a new instance of the WorkbookNote class.

    Returns
    void

    Properties

    author

    Gets or sets the author of the note. The default value is **undefined**.

    Type
    string

    height

    Gets or sets the height of the note, in pixels. The default value is **undefined**, which causes to use the default height, 79 pixels.

    Type
    number

    offsetX

    Gets or sets the offset in the X coordinate relative to bottom-right corner of the cell, in pixels. The default value is **undefined**, which causes to use the default offset, 15 pixels.

    Type
    number

    offsetY

    Gets or sets the offset in the Y coordinate relative to bottom-right corner of the cell, in pixels. The default value is **undefined**, which causes to use the default offset, 2 pixels if the cell is in the first row, 15 pixels otherwise.

    Type
    number

    text

    Gets or sets the text of the note. The default value is **undefined**.

    Note that on import both this and textRuns properties are filled and this property contains a plain text version of the textRuns content. On export textRuns takes precedence over this property if both are set.

    Type
    string

    textRuns

    Gets or sets the text runs represent the rich text of the note. The default value is **undefined**.

    Note that on import both this and text properties are filled and text contains a plain text version of the content of this property. On export this property takes precedence over text if both are set.

    Type
    WorkbookTextRun[]

    visible

    Indicates whether the note will be displayed when you open an .xlsx file or whether it will be displayed when your hover over the owner's cell. The default value is **undefined**, which means **true**.

    Type
    boolean

    width

    Gets or sets the width of the note, in pixels. The default value is **undefined**, which causes to use the default width, 144 pixels.

    Type
    number