XlsComment Class |
Represents a comment within an Excel worksheet. This class is designed to encapsulate the properties and behaviors of a comment, such as the author, the text content, and the cell to which it is associated.
Inheritance Hierarchy
System
Object
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet.Shapes XlsShape
Spire.Xls.Core.Spreadsheet.Shapes XlsComment
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet.Shapes XlsShape
Spire.Xls.Core.Spreadsheet.Shapes XlsComment
Namespace: Spire.Xls.Core.Spreadsheet.Shapes
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
The XlsComment type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
|
AlternativeText |
Returns or sets the descriptive (alternative) text string for a Shape object when the object is saved to a Web page. Read/write String
(Inherited from
XlsShape
.)
|
|
|
AlternativeTextTitle |
Returns or sets the descriptive (alternative) text title string for a Shape object when the object is saved to a Web page. Read/write String
(Inherited from
XlsShape
.)
|
|
|
Author |
Comment's author.
|
|
|
AutoSize |
Gets or sets a value indicating whether the control automatically adjusts its size to fit its contents.
|
|
|
BottomRow |
Bottom row.
(Inherited from
XlsShape
.)
|
|
|
BottomRowOffset |
Bottom row offset.
(Inherited from
XlsShape
.)
|
|
|
Column |
Column of the commented cell.
|
|
|
Fill |
Gets the fill style of the shape.
|
|
|
Glow |
Gets the glow properties.
(Inherited from
XlsShape
.)
|
|
|
HAlignment |
Gets or sets the horizontal alignment of the comment.
|
|
|
HasFill |
Indicates whether XlsFill item was created. Read-only.
(Inherited from
XlsShape
.)
|
|
|
HasLineFormat |
Indicates whether line item was created. Read-only.
(Inherited from
XlsShape
.)
|
|
|
Height |
Height of object.
(Inherited from
XlsShape
.)
|
|
|
HtmlString |
Gets and sets the html string which contains data and some formattings in this shape.
(Inherited from
XlsShape
.)
|
|
|
ID |
ID of object.
(Inherited from
XlsShape
.)
|
|
|
Instance |
Obsolete.
Returns instance value. Read-only.
(Inherited from
XlsShape
.)
|
|
|
IsFlipH |
Returns or sets if the shape flips Horizontal.false is default;
(Inherited from
XlsShape
.)
|
|
|
IsFlipV |
Returns or sets if the shape flips Vertical.false is default;
(Inherited from
XlsShape
.)
|
|
|
IsGroup |
This shape is group shape.
(Inherited from
XlsShape
.)
|
|
|
IsInGroup |
This shape is child shape of group shape.
(Inherited from
XlsShape
.)
|
|
|
IsLockAspectRatio |
True means that don't allow changes in aspect ratio.
(Inherited from
XlsShape
.)
|
|
|
IsLocked |
Gets or sets a value indicating whether the shape is locked.
(Inherited from
XlsShape
.)
|
|
IsMoveWithCell |
Determines whether the object moves with the cell it is associated with.
(Inherited from
XlsShape
.)
|
|
|
IsPrintable |
Gets or sets a value indicating whether the shape is printable.
(Inherited from
XlsShape
.)
|
|
|
IsRelative |
Gets or sets a value indicating whether the shape is relative.
(Inherited from
XlsShape
.)
|
|
|
IsRelativeResize |
True means that is relative to original size of picture.
(Inherited from
XlsShape
.)
|
|
|
IsShortVersion |
Obsolete.
Indiicates whether it is short version of the shape
(without obj and maybe some other properties).
(Inherited from
XlsShape
.)
|
|
|
IsSizeWithCell |
Determines whether the size is calculated based on the cell dimensions.
(Inherited from
XlsShape
.)
|
|
|
IsSmartArt |
Determines whether the shape is a SmartArt graphic based on the presence of a linked drawing.
(Inherited from
XlsShape
.)
|
|
|
IsTextLocked |
Gets or sets a value indicating whether the text is locked.
|
|
|
IsVisible |
Indicates whether comment is visible.
|
|
|
Left |
X of object
(Inherited from
XlsShape
.)
|
|
|
LeftColumn |
Left column.
(Inherited from
XlsShape
.)
|
|
|
LeftColumnOffset |
Left column offset. 1024 means whole column offset
(Inherited from
XlsShape
.)
|
|
|
Line |
Represents line format properties. Read only.
(Inherited from
XlsShape
.)
|
|
|
LinkedCell |
Gets or sets the linked cell for the shape.
(Inherited from
XlsShape
.)
|
|
|
Name |
Name of object.
(Inherited from
XlsShape
.)
|
|
|
OnAction |
Gets or sets macro-command that is called when action happens.
(Inherited from
XlsShape
.)
|
|
|
Parent |
Reference to Parent object. Read-only.
(Inherited from
XlsObject
.)
|
|
|
ReferenceCount |
Get quantity of instance references.
(Inherited from
XlsObject
.)
|
|
|
Reflection |
Gets the reflection effect applied to the shape.
(Inherited from
XlsShape
.)
|
|
|
ResizeBehave |
Specifies all possible settings for how drawing object shall be resized when the rows and columns between its start and ending anchor are resized or inserted(ComboBoxShape and CheckBoxShape and RadioButtonShape set MoveAndResize type value is invalid)
(Inherited from
XlsShape
.)
|
|
|
RichText |
Gets the rich text string associated with the object.
If the rich text string has not been initialized, it creates a new instance of RichTextShape.
|
|
|
RightColumn |
Right column.
(Inherited from
XlsShape
.)
|
|
|
RightColumnOffset |
Right column offset.
(Inherited from
XlsShape
.)
|
|
|
Rotation |
Returns or sets the rotation of the shape, in degrees.
(Inherited from
XlsShape
.)
|
|
|
Row |
Row of the commented cell.
|
|
|
Shadow |
Gets the shadow properties.
(Inherited from
XlsShape
.)
|
|
|
ShapeCount |
Obsolete.
Returns number of shapes contained by this shape (1 means no sub shapes). Read-only.
(Inherited from
XlsShape
.)
|
|
|
ShapeId |
Gets / sets shape id.
(Inherited from
XlsShape
.)
|
|
|
ShapeType |
Gets the type of the shape, which is always Comment in this implementation.
|
|
|
Text |
Gets or sets the text of the comment.
|
|
|
TextFrame |
Gets the text frame associated with the shape.
(Inherited from
XlsShape
.)
|
|
|
TextRotation |
Gets or sets the rotation type of the text.
|
|
|
TextVerticalAlignment |
Get or set Text Vertical Alignment in shape.
(Inherited from
XlsShape
.)
|
|
|
ThreeD |
Gets the chart3 D properties.
(Inherited from
XlsShape
.)
|
|
|
Top |
Top of object.
(Inherited from
XlsShape
.)
|
|
|
TopRow |
Top row.
(Inherited from
XlsShape
.)
|
|
|
TopRowOffset |
Top row offset.256 means whole row offset
(Inherited from
XlsShape
.)
|
|
|
UpdatePositions |
Indicates whether we have to update absolute positions after setting TopRow,
BottomRow, LeftColumn, RightColumn.
(Inherited from
XlsShape
.)
|
|
|
VAlignment |
Gets or sets the vertical alignment of the comment.
|
|
|
Visible |
Gets or sets the visibility of the shape. When set to true, the shape is visible; when set to false, the shape is hidden.
(Inherited from
XlsShape
.)
|
|
|
VmlShape |
Indicates whether this is vml shape or not.
(Inherited from
XlsShape
.)
|
|
|
Width |
Width of object.
(Inherited from
XlsShape
.)
|
Methods
| Name | Description | |
|---|---|---|
|
AddReference |
Increase the quantity of reference. User must use this method when
new wrapper on object is created or reference on object stored.
(Inherited from
XlsObject
.)
|
|
ChangeLayer |
Changes the layer position of a shape within a group based on the specified change type.
(Inherited from
XlsShape
.)
|
|
|
CheckDisposed |
Checks whether object was disposed and throws exception if it was.
(Inherited from
XlsObject
.)
|
|
|
Clone(Object) |
Creates a clone of the current shape.
(Inherited from
XlsShape
.)
|
|
|
Clone(Object, Dictionary String, String , Dictionary Int32, Int32 , Boolean) |
Obsolete.
Creates a clone of the current shape.
(Overrides
XlsShape
Clone(Object, Dictionary
String, String
, Dictionary
Int32, Int32
, Boolean)
.)
|
|
|
Dispose |
Dispose object and free resources.
(Inherited from
XlsObject
.)
|
|
|
Equals |
Determines whether the specified object is equal to the current object.
(Inherited from
Object
.)
|
|
|
Finalize |
Destructor. Call dispose method of current object.
(Inherited from
XlsObject
.)
|
|
|
FindParent(Type) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
|
|
FindParent( Type ) |
Find parent of object.
(Inherited from
XlsObject
.)
|
|
|
FindParent(Type, Boolean) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
|
|
FindParents |
Finds parent objects.
(Inherited from
XlsObject
.)
|
|
|
GetHashCode |
Serves as the default hash function.
(Inherited from
Object
.)
|
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
|
|
MemberwiseClone |
Creates a shallow copy of the current
Object
.
(Inherited from
Object
.)
|
|
|
OnDispose |
Method which can be overriden by users to take any specific actions when
object is disposed.
(Inherited from
XlsObject
.)
|
|
|
ReleaseReference |
Decrease quantity of Reference. User must call this method
when freeing resources.
(Inherited from
XlsObject
.)
|
|
|
Remove |
Removes the current comment from the worksheet's comments collection.
|
|
|
SaveToImage |
Save shape to image.
(Inherited from
XlsShape
.)
|
|
|
SaveToImage(Stream) |
Save shape to image.
(Inherited from
XlsShape
.)
|
|
|
SaveToImage(String) |
Save shape to image.
(Inherited from
XlsShape
.)
|
|
|
SaveToImage(Stream, ImageFormat) |
Save shape to image.
(Inherited from
XlsShape
.)
|
|
|
SaveToImage(String, ImageFormat) |
Save shape to image.
(Inherited from
XlsShape
.)
|
|
|
Scale |
Scales the shape.
(Inherited from
XlsShape
.)
|
|
|
SetName |
Sets object name
(Inherited from
XlsShape
.)
|
|
|
SetParent |
Sets parent of the object.
(Inherited from
XlsObject
.)
|
|
|
SetParents |
Sets the parent shapes collection for the current object by searching for a parent of type XlsShapesCollection.
Throws an ArgumentNullException if the parent collection is not found.
(Inherited from
XlsShape
.)
|
|
|
SetTextEffect |
Sets the text effect and updates the text for a shape.
(Inherited from
XlsShape
.)
|
|
|
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
Fields
| Name | Description | |
|---|---|---|
|
m_bIsDisposed |
Flag which indicates if the object was disposed or not.
(Inherited from
XlsObject
.)
|
See Also
