Xceed Logo
Shop
Xceed Workbooks for .NET v3.0 Documentation
Xceed.Workbooks.NET Assembly / Xceed.Workbooks.NET Namespace / AnnotationCollection Class
Example


In This Topic
    AnnotationCollection Class
    In This Topic
    Represents a collection of all the Notes and ThreadCommentCollections in the Worksheet.
    Object Model
    AnnotationCollection ClassAnnotation Class
    Syntax
    'Declaration
 

    <DefaultMemberAttribute("Item")>
Public Class AnnotationCollection 
   Inherits WorksheetElement
    'Usage
 

    Dim instance As AnnotationCollection
    [DefaultMember("Item")]
public class AnnotationCollection : WorksheetElement
    Remarks
    This class also serves as the general access point to add and edit Comments in the Worksheet.
    Example
    using( var workbook = Workbook.Create( "AddNote.xlsx" ) ) 
  { 
    // Gets the first Worksheet; a Workbook always contains at least 1 Worksheet. 
    var worksheet = workbook.Worksheets[ 0 ];   

    // Gets the annotations collection. 
    var annotations = worksheet.Annotations; 
  
    // Adds a Note in Cell B1 with the name of the person who wrote it. 
    annotations.AddNote( new FormattedText( "This is the title of the document" ), "B1" ); 
    var annotationCount = annotations.Count; 

    // Saves Workbook to disk; 
    workbook.Save(); 
  }
    Inheritance Hierarchy

    System.Object
       Xceed.Workbooks.NET.WorkbookElement
          Xceed.Workbooks.NET.WorksheetElement
             Xceed.Workbooks.NET.AnnotationCollection

    Public Properties
     NameDescription
    Public PropertyCommentsGets the ThreadCommentCollection associated with the current Worksheet.  
    Public PropertyCountReturns the number of Annotations in the Worksheet.  
    Public PropertyItemOverloaded. Gets a specific Annotation.  
    Top
    Public Methods
     NameDescription
    Public MethodAddCommentOverloaded. Adds a Comment in the current Worksheet.  
    Public MethodAddNoteOverloaded. Adds a Note in the current Worksheet.  
    Public MethodGetEnumerator  
    Public MethodRemoveOverloaded. Removes an Annotation (Note or Comment) from the AnnotationCollection.  
    Top
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    AnnotationCollection Members
    Xceed.Workbooks.NET Namespace

    Send Feedback