Documentation

Class SpreadsheetNote

Represents a note element in the RadSpreadsheet.

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

Gets or sets the alternate text. Setting it will push the change in the undo stack.

Declaration
public string AlternateText { get; set; }
Property Value
System.String

The alternate text value.

Author

Gets or sets the author assigned to the note. Setting it will push the change in the undo stack.

Declaration
public string Author { get; set; }
Property Value
System.String

The author.
Implements

FloatingShapeType

Gets the type of the shape.

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

Overrides

IsFallback

Gets a value indicating whether this SpreadsheetNote is a comment-related fallback note.

Declaration
public bool IsFallback { get; }
Property Value
System.Boolean

true if visible; otherwise, false.

IsVisible

Gets or sets a value indicating whether this SpreadsheetNote is visible. Setting it will push the change in the undo stack.

Declaration
public bool IsVisible { get; set; }
Property Value
System.Boolean

true if visible; otherwise, false.

MoveWithCells

Gets or sets a value indicating whether this SpreadsheetNote moves with its underlying cells. Setting it will push the change in the undo stack.

Declaration
public bool MoveWithCells { get; set; }
Property Value
System.Boolean

true if move with cells; otherwise, false.

RelatedCellIndex

Gets or sets the cell index assigned to the comment. Setting it will push the change in the undo stack.

Declaration
public CellIndex RelatedCellIndex { get; set; }
Property Value
CellIndex

The cell index.
Implements

SizeWithCells

Gets or sets a value indicating whether this SpreadsheetNote resizes with its underlying cells. Setting it will push the change in the undo stack.

Declaration
public bool SizeWithCells { get; set; }
Property Value
System.Boolean

true if resize with cells; otherwise, false.

Text

Gets or sets the text. Setting it will push the change in 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 the current System.Object.

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()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
System.Int32

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