Class
SpreadsheetNote

Note attached to a worksheet cell with text content, author, visibility, and positioning behavior for cell operations.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model.Comments

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition
public class SpreadsheetNote : FloatingResizableShapeBase, IFloatingCommentMutable, IFloatingComment

Inheritance: objectFloatingShapeBaseFloatingResizableShapeBaseSpreadsheetNote

Implements: IFloatingCommentIFloatingCommentMutable

Inherited Members FloatingResizableShapeBase.CellIndexFloatingResizableShapeBase.OffsetXFloatingResizableShapeBase.OffsetYFloatingResizableShapeBase.WidthFloatingResizableShapeBase.HeightFloatingShapeBase.SetWidth(bool, double, bool)FloatingShapeBase.SetHeight(bool, double, bool)FloatingShapeBase.OnShapeChanged()FloatingShapeBase.WorksheetFloatingShapeBase.IdFloatingShapeBase.NameFloatingShapeBase.DescriptionFloatingShapeBase.LockAspectRatioFloatingShapeBase.ShapeChanged

Properties

AlternateText

Alternate text description for accessibility; setting a new value pushes the change to the undo stack.

Declaration

cs-api-definition
public string AlternateText { get; set; }

Property Value

string

The alternate text value.

Author

Name of the note's author; setting a new value pushes the change to the undo stack.

Declaration

cs-api-definition
public string Author { get; set; }

Property Value

string

The author.

Implements IFloatingComment.Author

FloatingShapeType

Returns FloatingShapeType.Note to identify this shape as a note.

Declaration

cs-api-definition
public override FloatingShapeType FloatingShapeType { get; }

Property Value

FloatingShapeType

Overrides FloatingShapeBase.FloatingShapeType

IsFallback

Indicates whether this note is a fallback representation of a threaded comment for compatibility with older Excel versions.

Declaration

cs-api-definition
public bool IsFallback { get; }

Property Value

bool

true if visible; otherwise, false.

IsVisible

Controls whether the note is displayed on the worksheet; setting a new value pushes the change to the undo stack.

Declaration

cs-api-definition
public bool IsVisible { get; set; }

Property Value

bool

true if visible; otherwise, false.

MoveWithCells

Controls whether the note relocates when its underlying cells are inserted or deleted; setting a new value pushes the change to the undo stack.

Declaration

cs-api-definition
public bool MoveWithCells { get; set; }

Property Value

bool

true if move with cells; otherwise, false.

RelatedCellIndex

Cell index to which this note is attached; setting a new value pushes the change to the undo stack.

Declaration

cs-api-definition
public CellIndex RelatedCellIndex { get; set; }

Property Value

CellIndex

The cell index.

Implements IFloatingCommentMutable.RelatedCellIndexIFloatingComment.RelatedCellIndex

SizeWithCells

Controls whether the note resizes when its underlying cells are resized; setting a new value pushes the change to the undo stack.

Declaration

cs-api-definition
public bool SizeWithCells { get; set; }

Property Value

bool

true if resize with cells; otherwise, false.

Text

Text content of the note; setting a new value pushes the change to the undo stack.

Declaration

cs-api-definition
public string Text { get; set; }

Property Value

string

The text value.

Implements IFloatingComment.Text

Methods

Equals(object)

Determines whether the specified object is equal to this note by comparing base properties, author, and alternate text.

Declaration

cs-api-definition
public override bool Equals(object obj)

Parameters

obj

object

The object to compare with the current object.

Returns

bool

True if the specified object is equal to the current object; otherwise, false.

Overrides object.Equals(object)

GetHashCode()

Computes a hash code combining base properties, author name, and alternate text.

Declaration

cs-api-definition
public override int GetHashCode()

Returns

int

A hash code for the current object.

Overrides object.GetHashCode()