Xceed Logo
Shop
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

    Public Properties
     NameDescription
    Public PropertyAnnotationTypeOverridden. Gets the AnnotationType.  
    Public PropertyAuthorObject that represents the person who wrote the Note or the Comment. (Inherited from Xceed.Workbooks.NET.Annotation)
    Public PropertyBackgroundColorGets or sets the color used for the Note's background.  
    Public PropertyCellReferenceRepresents the Cell in which the Note or the Comment is inserted. (Inherited from Xceed.Workbooks.NET.Annotation)
    Public PropertyHeightGets or sets the Note's height.  
    Public PropertyIsAutoFitGets or sets if the Note uses the AutoFit option.  
    Public PropertyIsShownIndicates if the Annotation is visible or not when the Workbook is opened. (Inherited from Xceed.Workbooks.NET.Annotation)
    Public PropertyItemGets a specific block of FormattedText contained in the Note.  
    Public PropertyLengthRepresents the cumulative length of all the blocks of FormattedText in the current Note.  
    Public PropertyMeasureUnitGets or sets the Unit used to define Width & Height.  
    Public PropertyProtectionGets or sets the NoteProtection.  
    Public PropertyTextAlignmentRepresents the Note's HorizontalAlignement and VerticalAlignment.    
    Public PropertyWidthGets or sets the Note's width.  
    Top
    Public Methods
     NameDescription
    Public MethodAddTextAdds a new FormattedText object at the end of the Note's current FormattedTextList.  
    Public MethodAddTextsAdds multiple FormattedText objects at the end of the Note's current FormattedTextList.  
    Public MethodGetEnumerator  
    Public MethodGetTypeCode  
    Public MethodToBoolean  
    Public MethodToByte  
    Public MethodToChar  
    Public MethodToDateTime  
    Public MethodToDecimal  
    Public MethodToDouble  
    Public MethodToInt16  
    Public MethodToInt32  
    Public MethodToInt64  
    Public MethodToSByte  
    Public MethodToSingle  
    Public MethodToStringOverloaded.   
    Public MethodToType  
    Public MethodToUInt16  
    Public MethodToUInt32  
    Public MethodToUInt64  
    Top
    Protected Methods
     NameDescription
    Protected Internal MethodIsDirtyOverridden.   
    Protected MethodOnPropertyChanged (Inherited from Xceed.Workbooks.NET.Annotation)
    Protected Internal MethodSetIsDirtyOverridden.   
    Top
    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

    Reference

    Note Members
    Xceed.Workbooks.NET Namespace

    Send Feedback