Represents a comment for a cell.

Constructors

Section titled "Constructors"

WorksheetCellComment 

new WorksheetCellComment(): WorksheetCellComment

Returns WorksheetCellComment

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

author

Section titled "author"

Gets or sets the author of the comment.

 
get author(): string

Returns string 

set author(a: string): void

Parameters

  • a: string

Returns void

bottomRightCornerCell

Section titled "bottomRightCornerCell"

Inherited from: WorksheetShape

Gets or sets the cell where the bottom-right corner of the shape resides.

 
get bottomRightCornerCell(): WorksheetCell

Returns WorksheetCell 

set bottomRightCornerCell(a: WorksheetCell): void

Parameters

Returns void

bottomRightCornerPosition

Section titled "bottomRightCornerPosition"

Inherited from: WorksheetShape

Gets or sets the position in the [[bottomRightCornerCell]] of the shape's bottom-right corner, expressed in percentages.

 
get bottomRightCornerPosition(): IgPoint

Returns IgPoint 

set bottomRightCornerPosition(a: IgPoint): void

Parameters

  • a: IgPoint

Returns void

cell

Section titled "cell"

Gets the cell to which the comment is applied. The cell to which the comment is applied.

 
get cell(): WorksheetCell

Returns WorksheetCell 

set cell(a: WorksheetCell): void

Parameters

Returns void

fill

Section titled "fill"

Inherited from: WorksheetShape

Gets or sets the fill to use in the background of the shape.

 
get fill(): ShapeFill

Returns ShapeFill 

set fill(a: ShapeFill): void

Parameters

Returns void

flippedHorizontally

Section titled "flippedHorizontally"

Inherited from: WorksheetShape

Gets or sets the value which indicates whether the shape is flipped horizontally along the vertical center line.

 
get flippedHorizontally(): boolean

Returns boolean 

set flippedHorizontally(a: boolean): void

Parameters

  • a: boolean

Returns void

flippedVertically

Section titled "flippedVertically"

Inherited from: WorksheetShape

Gets or sets the value which indicates whether the shape is flipped vertically along the horizontal center line.

 
get flippedVertically(): boolean

Returns boolean 

set flippedVertically(a: boolean): void

Parameters

  • a: boolean

Returns void

outline

Section titled "outline"

Inherited from: WorksheetShape

Gets or sets the outline to use for the shape.

 
get outline(): ShapeOutline

Returns ShapeOutline 

set outline(a: ShapeOutline): void

Parameters

Returns void

positioningMode

Section titled "positioningMode"

Inherited from: WorksheetShape

Gets or sets the way shapes will be repositioned in excel when cells before or within the shape are resized.

 
get positioningMode(): ShapePositioningMode

Returns ShapePositioningMode 

set positioningMode(a: ShapePositioningMode): void

Parameters

Returns void

sheet

Section titled "sheet"

Inherited from: WorksheetShape

Gets the worksheet on which the shape resides. The worksheet on which the shape resides.

 
get sheet(): Sheet

Returns Sheet

text

Section titled "text"

Gets or sets the formatted text of the comment.

 
get text(): FormattedString

Returns FormattedString 

set text(a: FormattedString): void

Parameters

Returns void

topLeftCornerCell

Section titled "topLeftCornerCell"

Inherited from: WorksheetShape

Gets or sets the cell where the top-left corner of the shape resides.

 
get topLeftCornerCell(): WorksheetCell

Returns WorksheetCell 

set topLeftCornerCell(a: WorksheetCell): void

Parameters

Returns void

topLeftCornerPosition

Section titled "topLeftCornerPosition"

Inherited from: WorksheetShape

Gets or sets the position in the [[topLeftCornerCell]] of the shape's top-left corner, expressed in percentages.

 
get topLeftCornerPosition(): IgPoint

Returns IgPoint 

set topLeftCornerPosition(a: IgPoint): void

Parameters

  • a: IgPoint

Returns void

visible

Section titled "visible"

Inherited from: WorksheetShape

Gets or sets the value indicating whether the shape is visible on the worksheet. The value indicating whether the shape is visible on the worksheet.

 
get visible(): boolean

Returns boolean 

set visible(a: boolean): void

Parameters

  • a: boolean

Returns void

worksheet

Section titled "worksheet"

Inherited from: WorksheetShape

Gets the worksheet on which the shape resides. The worksheet on which the shape resides.

 
get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

clearUnknownData

Section titled "clearUnknownData"

Inherited from: WorksheetShape

Clears the cached unknown shape data which was read in from a parsed excel file.

 
clearUnknownData(): void

Returns void

getBoundsInTwips

Section titled "getBoundsInTwips"

Inherited from: WorksheetShape

Gets the bounds of the shape in twips (1/20th of a point).

 
getBoundsInTwips(): IgRect

Returns IgRect

setBoundsInTwips

Section titled "setBoundsInTwips"

Inherited from: WorksheetShape

Sets the bounds of the shape in twips (1/20th of a point).

 
setBoundsInTwips(sheet: Sheet, bounds: IgRect): void

Parameters

  • sheet: Sheet

    The worksheet on which the shape should be placed.
  • bounds: IgRect

    The new bounds where the shape should be placed.

Returns void

createPredefinedShape

Section titled "createPredefinedShape"

Inherited from: WorksheetShape

Creates a shape which is predefined in Microsoft Excel.

 
createPredefinedShape(shapeType: PredefinedShapeType): WorksheetShape

Parameters

Returns WorksheetShape

staticInit

Section titled "staticInit"

Inherited from: WorksheetShape 

staticInit(): void

Returns void