Class NoteCollection

Collection of notes attached to worksheet cells, supporting visibility control and conversion to threaded comments.

Inheritance
System.Object
FilteredShapeCollection<SpreadsheetNote>
NoteCollection
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class NoteCollection : FilteredShapeCollection<SpreadsheetNote>, IEnumerable<SpreadsheetNote>, IEnumerable

Constructors

NoteCollection(Worksheet)

Initializes a new note collection for the specified worksheet.

Declaration
public NoteCollection(Worksheet worksheet)
Parameters
Worksheet worksheet

The worksheet.

Properties

ShapeType

Returns FloatingShapeType.Note to identify notes within the shape collection.

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

Overrides
Telerik.Windows.Documents.Spreadsheet.Model.FilteredShapeCollection<Telerik.Windows.Documents.Spreadsheet.Model.Comments.SpreadsheetNote>.ShapeType

Methods

Add(CellIndex, String, String)

Adds a note to the specified cell with default positioning and returns the created note.

Declaration
public SpreadsheetNote Add(CellIndex relatedCellIndex, string author, string text)
Parameters
CellIndex relatedCellIndex

Index of the cell assigned to the note.
System.String author

The author.
System.String text

The text.
Returns
SpreadsheetNote

The new note.

Add(CellIndex, CellIndex, String, String)

Adds a note to the specified cell with custom positioning and returns the created note.

Declaration
public SpreadsheetNote Add(CellIndex relatedCellIndex, CellIndex cellIndex, string author, string text)
Parameters
CellIndex relatedCellIndex

Index of the cell assigned to the note.
CellIndex cellIndex

Index of the cell where the top left corner of the note is visualized.
System.String author

The author.
System.String text

The text.
Returns
SpreadsheetNote

The new note.

ConvertToComments()

Converts all non-fallback notes to threaded SpreadsheetComment instances.

Declaration
public void ConvertToComments()

Hide(SpreadsheetNote)

Hides the specified note from view without removing it from the collection.

Declaration
public void Hide(SpreadsheetNote note)
Parameters
SpreadsheetNote note

The note.

HideAll()

Hides all notes in the collection from view as a single operation.

Declaration
public void HideAll()

OnNotesVisibilityChanged()

Raises the NotesVisibilityChanged event when all notes' visibility changes.

Declaration
protected virtual void OnNotesVisibilityChanged()

Show(SpreadsheetNote)

Makes the specified note visible in the worksheet.

Declaration
public void Show(SpreadsheetNote note)
Parameters
SpreadsheetNote note

The note.

ShowAll()

Makes all notes in the collection visible as a single operation.

Declaration
public void ShowAll()

Events

NotesVisibilityChanged

Raised when the visibility of all notes is changed together via ShowAll or HideAll.

Declaration
public event EventHandler NotesVisibilityChanged
Event Type
System.EventHandler