Class SpreadsheetNote

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

Inheritance
System.Object
FloatingShapeBase
FloatingResizableShapeBase
SpreadsheetNote
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model.Comments
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class SpreadsheetNote : FloatingResizableShapeBase, ICopyable<FloatingShapeBase>, IFloatingCommentMutable, IFloatingComment, ITextObject

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
System.String

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
System.String

The author.
Implements

FloatingShapeType

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

Declaration
public override FloatingShapeType FloatingShapeType { get; }
Property Value
FloatingShapeType

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
System.Boolean

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
System.Boolean

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
System.Boolean

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
CellIndex

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
System.Boolean

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
public string Text { get; set; }
Property Value
System.String

The text value.
Implements

Methods

Equals(Object)

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

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The System.Object to compare with the current System.Object.
Returns
System.Boolean

True if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

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

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()

Extension Methods