Add(Int32,Int32,String,String,Boolean) Method

Creates an XLComment object and appends it to the collection.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function Add( _
   ByVal rowIndex As System.Integer, _
   ByVal colIndex As System.Integer, _
   ByVal author As System.String, _
   ByVal text As System.String, _
   ByVal toRtf As System.Boolean _
) As XLComment

'Usage
 
Dim instance As XLCommentCollection
Dim rowIndex As System.Integer
Dim colIndex As System.Integer
Dim author As System.String
Dim text As System.String
Dim toRtf As System.Boolean
Dim value As XLComment
 
value = instance.Add(rowIndex, colIndex, author, text, toRtf)

public XLComment Add( 
   System.int rowIndex,
   System.int colIndex,
   System.string author,
   System.string text,
   System.bool toRtf
)

Parameters

rowIndex: Index of the top row in the comment.
colIndex: Index of the left column in the comment.
author: The author of the comment.
text: The text of the comment.
toRtf: Flag indicating whether to convert author and text to RTF format.

Return Value

A reference to the object if it was successfully added to the collection, or null if the object could not be added to the collection (usually because it overlaps another comment already in the collection).

Reference

XLCommentCollection Class
XLCommentCollection Members
Overload List