ig.excel.WorksheetCellComment

Represents a comment for a cell.

Remarks

Comments cannot be added to a worksheet's or a shape group's shapes collection. Instead, they must be set directly on the cell with the cell's WorksheetCell.comment property.

It is not required that the anchors of this shape be initialized before setting it as the comment of a cell. If the WorksheetShape.topLeftCornerCell and WorksheetShape.bottomRightCornerCell anchors are both null when the comment is applied to a cell, default anchor cells will be used based on the cell.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.

  • ig.excel.WorksheetCellComment
    Constructor

    new $.ig.excel.WorksheetCellComment( );

    Creates a new instance of the WorksheetCellComment class.

  • author

    .author( );
    Return Type:
    string
    Return Type Description:
    The author of the comment.

    Gets the author of the comment.

    Remarks

    This information is not displayed in the Microsoft Excel UI and is for informational purposes only.

  • author

    .author( value:string );
    Return Type:
    string
    Return Type Description:
    The author of the comment.

    Sets the author of the comment.

    • value
    • Type:string

    Remarks

    This information is not displayed in the Microsoft Excel UI and is for informational purposes only.

  • cell

    .cell( );
    Return Type:
    ig.excel.WorksheetCell
    Return Type Description:
    The cell to which the comment is applied.

    Gets the cell to which the comment is applied.

    See Also

  • text

    .text( );
    Return Type:
    ig.excel.FormattedString
    Return Type Description:
    The formatted text of the comment.

    Gets the formatted text of the comment.

    Remarks

    Getting the value of this property will always return a non-null value. If null is set on the property, it will subsequently return an empty formatted string.

  • text

    .text( value:ig.excel.FormattedString );
    Return Type:
    ig.excel.FormattedString
    Return Type Description:
    The formatted text of the comment.

    Sets the formatted text of the comment.

    • value
    • Type:ig.excel.FormattedString

    Remarks

    Getting the value of this property will always return a non-null value. If null is set on the property, it will subsequently return an empty formatted string.

  • worksheet

    .worksheet( );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    The worksheet on which the shape resides.

    Gets the worksheet on which the shape resides.

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.