ClassNoteCollection
Collection of notes attached to worksheet cells, supporting visibility control and conversion to threaded comments.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.Model
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public class NoteCollection : FilteredShapeCollection<SpreadsheetNote>, IEnumerable<SpreadsheetNote>, IEnumerableInheritance: objectFilteredShapeCollection<SpreadsheetNote>NoteCollection
Implements:
Inherited Members
Constructors
NoteCollection(Worksheet)
Initializes a new note collection for the specified worksheet.
Declaration
public NoteCollection(Worksheet worksheet)Parameters
worksheet
The worksheet.
Properties
ShapeType
Returns FloatingShapeType.Note to identify notes within the shape collection.
Declaration
public override FloatingShapeType ShapeType { get; }Property Value
Overrides
Methods
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
relatedCellIndex
Index of the cell assigned to the note.
cellIndex
Index of the cell where the top left corner of the note is visualized.
author
The author.
text
The text.
Returns
The new note.
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
relatedCellIndex
Index of the cell assigned to the note.
author
The author.
text
The text.
Returns
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
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
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 NotesVisibilityChangedEvent Value