Documentation

Class NoteCollection

Represents a collection of notes.

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 instance of the NoteCollection class.

Declaration
public NoteCollection(Worksheet worksheet)
Parameters
Worksheet worksheet

The worksheet.

Properties

ShapeType

Gets the type of the shape.

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 new note to the collection with a default topLeftCellIndex.

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 new note to the collection.

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 notes in the collection to SpreadsheetComment.

Declaration
public void ConvertToComments()

Hide(SpreadsheetNote)

Hides the specified note from the collection.

Declaration
public void Hide(SpreadsheetNote note)
Parameters
SpreadsheetNote note

The note.

HideAll()

Hides all notes in the collection.

Declaration
public void HideAll()

OnNotesVisibilityChanged()

Called when [changed].

Declaration
protected virtual void OnNotesVisibilityChanged()

Show(SpreadsheetNote)

Shows the specified note from the collection.

Declaration
public void Show(SpreadsheetNote note)
Parameters
SpreadsheetNote note

The note.

ShowAll()

Shows all notes in the collection.

Declaration
public void ShowAll()

Events

NotesVisibilityChanged

Occurs when the visibility of all notes has been changed in the same time.

Declaration
public event EventHandler NotesVisibilityChanged
Event Type
System.EventHandler

Extension Methods