Xceed Workbooks for .NET v3.0 Documentation
Xceed.Workbooks.NET Assembly / Xceed.Workbooks.NET Namespace / Note Class
Members Example


In This Topic
    Note Class
    In This Topic
    Represents a Note, which is made of multiple blocks of FormattedText that are added one after the other.
    Object Model
    Note ClassFormattedText Class
    Syntax
    'Declaration
     
    
    <DefaultMemberAttribute("Item")>
    Public Class Note 
       Inherits Annotation
    'Usage
     
    
    Dim instance As Note
    [DefaultMember("Item")]
    public class Note : Annotation 
    Remarks
    Note that line breaks are supported in a Note.
    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.Note

    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also