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


In This Topic
    Annotation Class
    In This Topic
    Base class that contains the basic components for Notes & Comments.
    Object Model
    Annotation ClassPerson ClassCell Class
    Syntax
    'Declaration
 

    Public MustInherit Class Annotation 
   Inherits WorksheetElement
    'Usage
 

    Dim instance As Annotation
    public abstract class Annotation : WorksheetElement
    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. 
    var note = annotations.AddNote( new FormattedText( "This is the title of the document" ), "B1" ); 
    note.BackgroundColor = Color.Gray; 
    note.IsShown = true; 

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

    System.Object
       Xceed.Workbooks.NET.WorkbookElement
          Xceed.Workbooks.NET.WorksheetElement
             Xceed.Workbooks.NET.Annotation
                Xceed.Workbooks.NET.Comment
                Xceed.Workbooks.NET.Note

    Public Properties
     NameDescription
    Public PropertyAnnotationTypeReturns the AnnotationType.  
    Public PropertyAuthorObject that represents the person who wrote the Note or the Comment.  
    Public PropertyCellReferenceRepresents the Cell in which the Note or the Comment is inserted.  
    Public PropertyIsShownIndicates if the Annotation is visible or not when the Workbook is opened.  
    Top
    Protected Methods
     NameDescription
    Protected Internal MethodIsDirty  
    Protected MethodOnPropertyChanged  
    Protected Internal MethodSetIsDirty  
    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

    Annotation Members
    Xceed.Workbooks.NET Namespace

    Send Feedback