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


In This Topic
    Comment Class
    In This Topic
    This class represents a single Comment in a ThreadCommentCollection.
    Syntax
    'Declaration
 

    Public Class Comment 
   Inherits Annotation
    'Usage
 

    Dim instance As Comment
    public class Comment : Annotation
    Example
    using( var workbook = Workbook.Create( "AddComment.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 Comment in Cell B1 and update its text. 
    var comment = annotations.AddComment( "This is the title", "B1" ); 
    comment.Text += " of the document"; 

    // 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

    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 PropertyCellReferenceRepresents the Cell in which the Note or the Comment is inserted. (Inherited from Xceed.Workbooks.NET.Annotation)
    Public PropertyDateTimeReturns the time at which the Comment was first written in the Workbook.  
    Public PropertyIsShownIndicates if the Annotation is visible or not when the Workbook is opened. (Inherited from Xceed.Workbooks.NET.Annotation)
    Public PropertyTextGets or sets the text that is displayed in the Comment.  
    Top
    Public Methods
     NameDescription
    Public MethodGetTypeCode  
    Public MethodReplyInserts a new Comment at the end of the ThreadCommentCollection.  
    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

    Comment Members
    Xceed.Workbooks.NET Namespace

    Send Feedback