ClassSpreadsheetNote
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:
public class SpreadsheetNote : FloatingResizableShapeBase, IFloatingCommentMutable, IFloatingComment
Inheritance: objectFloatingShapeBaseFloatingResizableShapeBaseSpreadsheetNote
Implements:
Inherited Members
Properties
AlternateText
Alternate text description for accessibility; setting a new value pushes the change to the undo stack.
Declaration
public string AlternateText { get; set; }
Property Value
The alternate text value.
Author
Name of the note's author; setting a new value pushes the change to the undo stack.
Declaration
public string Author { get; set; }
Property Value
The author.
Implements
FloatingShapeType
Returns FloatingShapeType.Note to identify this shape as a note.
Declaration
public override FloatingShapeType FloatingShapeType { get; }
Property Value
Overrides
IsFallback
Indicates whether this note is a fallback representation of a threaded comment for compatibility with older Excel versions.
Declaration
public bool IsFallback { get; }
Property Value
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
public bool IsVisible { get; set; }
Property Value
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
public bool MoveWithCells { get; set; }
Property Value
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
public CellIndex RelatedCellIndex { get; set; }
Property Value
The cell index.
Implements
SizeWithCells
Controls whether the note resizes when its underlying cells are resized; setting a new value pushes the change to the undo stack.
Declaration
public bool SizeWithCells { get; set; }
Property Value
true if resize with cells; otherwise, false.
Methods
Equals(object)
Determines whether the specified object is equal to this note by comparing base properties, author, and alternate text.
GetHashCode()
Computes a hash code combining base properties, author name, and alternate text.