New to Telerik Document ProcessingStart a free 30-day trial

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:

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

Inheritance: objectFilteredShapeCollection<SpreadsheetNote>NoteCollection

Implements: IEnumerableIEnumerable<SpreadsheetNote>

Inherited Members FilteredShapeCollection<SpreadsheetNote>.Remove(SpreadsheetNote)FilteredShapeCollection<SpreadsheetNote>.Contains(SpreadsheetNote)FilteredShapeCollection<SpreadsheetNote>.IndexOf(SpreadsheetNote)FilteredShapeCollection<SpreadsheetNote>.Clear()FilteredShapeCollection<SpreadsheetNote>.GetEnumerator()FilteredShapeCollection<SpreadsheetNote>.GetZIndex(SpreadsheetNote)FilteredShapeCollection<SpreadsheetNote>.Add(SpreadsheetNote)FilteredShapeCollection<SpreadsheetNote>.OnItemAdding(SpreadsheetNote, out ShapeCollectionChangingEventArgs<SpreadsheetNote>)FilteredShapeCollection<SpreadsheetNote>.OnItemRemoving(SpreadsheetNote, out ShapeCollectionChangingEventArgs<SpreadsheetNote>)FilteredShapeCollection<SpreadsheetNote>.OnChanging(ShapeCollectionChangingEventArgs<SpreadsheetNote>)FilteredShapeCollection<SpreadsheetNote>.OnChanged(ShapeCollectionChangedEventArgs<SpreadsheetNote>)FilteredShapeCollection<SpreadsheetNote>.CountFilteredShapeCollection<SpreadsheetNote>.this[int]FilteredShapeCollection<SpreadsheetNote>.WorksheetFilteredShapeCollection<SpreadsheetNote>.ChangingFilteredShapeCollection<SpreadsheetNote>.Changed...

Constructors

Initializes a new note collection for the specified worksheet.

C#
public NoteCollection(Worksheet worksheet)
Parameters:worksheetWorksheet

The worksheet.

Events

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

C#
public event EventHandler NotesVisibilityChanged

Methods

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

C#
public SpreadsheetNote Add(CellIndex relatedCellIndex, CellIndex cellIndex, string author, string text)
Parameters:relatedCellIndexCellIndex

Index of the cell assigned to the note.

cellIndexCellIndex

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

authorstring

The author.

textstring

The text.

Returns:

SpreadsheetNote

The new note.

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

C#
public SpreadsheetNote Add(CellIndex relatedCellIndex, string author, string text)
Parameters:relatedCellIndexCellIndex

Index of the cell assigned to the note.

authorstring

The author.

textstring

The text.

Returns:

SpreadsheetNote

The new note.

Converts all non-fallback notes to threaded SpreadsheetComment instances.

C#
public void ConvertToComments()

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

C#
public void Hide(SpreadsheetNote note)
Parameters:noteSpreadsheetNote

The note.

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

C#
public void HideAll()

Raises the NotesVisibilityChanged event when all notes' visibility changes.

C#
protected virtual void OnNotesVisibilityChanged()

Makes the specified note visible in the worksheet.

C#
public void Show(SpreadsheetNote note)
Parameters:noteSpreadsheetNote

The note.

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

C#
public void ShowAll()

Properties

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

C#
public override FloatingShapeType ShapeType { get; }

Overrides: FilteredShapeCollection<SpreadsheetNote>.ShapeType