Class Comment
Represents a comment on a sheet cell.
Inherited Members
Namespace: DRIT.Spreadsheet
Assembly: DRIT.Spreadsheet.dll
Syntax
public class Comment : IWorksheetDrawingObject, ISheetDrawingObject, IDrawingObjectConstructors
Comment(Worksheet)
Initializes a new Comment for the supplied workbook data.
Declaration
public Comment(Worksheet worksheet)Parameters
| Type | Name | Description |
|---|---|---|
| Worksheet | worksheet |
Properties
AnchoredCell
Gets the top left cell where the comment is displayed.
Declaration
public Cell AnchoredCell { get; set; }Property Value
| Type | Description |
|---|---|
| Cell |
Author
Specifies the author of the comment.
Declaration
public string Author { get; set; }Property Value
| Type | Description |
|---|---|
| string |
BottomRightCell
Gets the bottom-right cell of the comment's anchor range.
Declaration
public Cell BottomRightCell { get; }Property Value
| Type | Description |
|---|---|
| Cell |
Cell
Gets the cell the comment is associated with.
Declaration
public Cell Cell { get; }Property Value
| Type | Description |
|---|---|
| Cell |
DateTime
Specifies the date and time when this comment was created.
Declaration
public DateTime DateTime { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime |
Fill
Gets the fill formatting of the comment.
Declaration
public CommentFill Fill { get; }Property Value
| Type | Description |
|---|---|
| CommentFill |
Line
Gets the line formatting of the comment.
Declaration
public CommentLine Line { get; }Property Value
| Type | Description |
|---|---|
| CommentLine |
Margin
Specifies the margin around the comment content.
Declaration
public Margin Margin { get; set; }Property Value
| Type | Description |
|---|---|
| Margin |
ParentGroup
Gets or sets the parent Group used by this spreadsheet object.
Declaration
public GroupShape ParentGroup { get; }Property Value
| Type | Description |
|---|---|
| GroupShape | Null. Comments cannot be placed into groups therefore ParentGroup is always null. |
PatternType
Specifies the pattern type for the comment fill.
Declaration
public PatternType PatternType { get; set; }Property Value
| Type | Description |
|---|---|
| PatternType |
Position
Gets the position of the comment.
Declaration
public Position Position { get; }Property Value
| Type | Description |
|---|---|
| Position |
Positioning
Specifies the anchor properties for positioning.
Declaration
public AnchorProperties Positioning { get; set; }Property Value
| Type | Description |
|---|---|
| AnchorProperties |
RichText
Exposes the rich text associated with Comment.
Declaration
public RichTextParagraph RichText { get; set; }Property Value
| Type | Description |
|---|---|
| RichTextParagraph | The rich text returned by the operation. |
Sheet
Gets the sheet containing this comment.
Declaration
public Sheet Sheet { get; }Property Value
| Type | Description |
|---|---|
| Sheet |
Size
Gets the size of the comment.
Declaration
public Size Size { get; }Property Value
| Type | Description |
|---|---|
| Size |
Text
Specifies the text content of the comment.
Declaration
public string Text { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Visible
Gets or sets whether the comment is visible.
Declaration
public bool Visible { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Worksheet
Specifies the worksheet containing this comment.
Declaration
public Worksheet Worksheet { get; }Property Value
| Type | Description |
|---|---|
| Worksheet |
Methods
SetImage(string)
Updates the image held by the Comment.
Declaration
public void SetImage(string path)Parameters
| Type | Name | Description |
|---|---|---|
| string | path | The path used by the operation. |