spire-xls 15.5.0__py3-none-win_amd64.whl → 15.11.1__py3-none-win_amd64.whl

spire/xls/ExcelCommentObject.py

@@ -7,13 +7,19 @@ from ctypes import *
 import abc
 
 class ExcelCommentObject (  SpireObject, IComment) :
-    """
-
+    """Represents a comment object in an Excel worksheet.
+    
+    This class encapsulates the functionality of a comment attached to a cell in an Excel worksheet.
+    It provides properties and methods to manage comment visibility, text content, formatting,
+    and positioning. The class implements the IComment interface to support standard comment operations.
     """
 
     def SetCommentLocation(self ,isMoveWithCell:bool,isSizeWithCell:bool):
-        """
-
+        """Sets the location behavior of the comment when cells are moved or resized.
+        
+        Args:
+            isMoveWithCell (bool): True to move the comment when the cell is moved; otherwise, False.
+            isSizeWithCell (bool): True to resize the comment when the cell is resized; otherwise, False.
         """
         
         GetDllLibXls().ExcelCommentObject_SetCommentLocation.argtypes=[c_void_p ,c_bool,c_bool]
@@ -22,10 +28,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def Author(self)->str:
-        """
-    <summary>
-        Gets or sets the author of the comment. 
-    </summary>
+        """Gets or sets the author of the comment.
+        
+        Returns:
+            str: The name of the author who created the comment.
         """
         GetDllLibXls().ExcelCommentObject_get_Author.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Author.restype=c_void_p
@@ -40,10 +46,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def IsVisible(self)->bool:
-        """
-    <summary>
-        Indicates whether the comment is visible. 
-    </summary>
+        """Gets or sets whether the comment is visible.
+        
+        Returns:
+            bool: True if the comment is visible; otherwise, False.
         """
         GetDllLibXls().ExcelCommentObject_get_IsVisible.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_IsVisible.restype=c_bool
@@ -58,10 +64,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def HtmlString(self)->str:
-        """
-    <summary>
-        Gets and sets the html string which contains data and some formattings in this shape.
-    </summary>
+        """Gets or sets the HTML string which contains data and some formatting in this comment.
+        
+        Returns:
+            str: The HTML representation of the comment content with formatting.
         """
         GetDllLibXls().ExcelCommentObject_get_HtmlString.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_HtmlString.restype=c_void_p
@@ -76,10 +82,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def Row(self)->int:
-        """
-    <summary>
-        Row of the commented range.
-    </summary>
+        """Gets the row index of the cell that contains the comment.
+        
+        Returns:
+            int: The zero-based row index.
         """
         GetDllLibXls().ExcelCommentObject_get_Row.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Row.restype=c_int
@@ -88,10 +94,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def Column(self)->int:
-        """
-    <summary>
-        Column of the commented range.
-    </summary>
+        """Gets the column index of the cell that contains the comment.
+        
+        Returns:
+            int: The zero-based column index.
         """
         GetDllLibXls().ExcelCommentObject_get_Column.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Column.restype=c_int
@@ -101,8 +107,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def RichText(self)->'IRichTextString':
-        """
-
+        """Gets the rich text formatting of the comment.
+        
+        Returns:
+            IRichTextString: An object representing the rich text formatting applied to the comment text.
         """
         GetDllLibXls().ExcelCommentObject_get_RichText.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_RichText.restype=c_void_p
@@ -114,9 +122,14 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def Line(self)->'IShapeLineFormat':
+        """Gets the line formatting for the comment shape border.
+        
+        The line formatting includes properties such as line color, style, and weight.
+        
+        Returns:
+            IShapeLineFormat: The line formatting object for the comment shape border.
         """
-
-        """
+        from spire.xls.XlsShapeLineFormat import XlsShapeLineFormat
         GetDllLibXls().ExcelCommentObject_get_Line.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Line.restype=c_void_p
         intPtr = CallCFunction(GetDllLibXls().ExcelCommentObject_get_Line, self.Ptr)
@@ -127,8 +140,12 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def Fill(self)->'IShapeFill':
-        """
-
+        """Gets the fill formatting for the comment shape.
+        
+        The fill formatting includes properties such as fill color, pattern, and gradient.
+        
+        Returns:
+            IShapeFill: The fill formatting object for the comment shape.
         """
         GetDllLibXls().ExcelCommentObject_get_Fill.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Fill.restype=c_void_p
@@ -140,10 +157,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def Text(self)->str:
-        """
-    <summary>
-        Comment text
-    </summary>
+        """Gets or sets the text content of the comment.
+        
+        Returns:
+            str: The text content of the comment.
         """
         GetDllLibXls().ExcelCommentObject_get_Text.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Text.restype=c_void_p
@@ -158,11 +175,12 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def AutoSize(self)->bool:
-        """
-    <summary>
-        Indicates whether the size of the specified object is changed automatically
-            to fit text within its boundaries. Read/write Boolean.
-    </summary>
+        """Gets or sets whether the comment is automatically sized to fit its content.
+        
+        When set to True, the comment will automatically resize to fit the text within its boundaries.
+        
+        Returns:
+            bool: True if the comment is automatically sized; otherwise, False.
         """
         GetDllLibXls().ExcelCommentObject_get_AutoSize.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_AutoSize.restype=c_bool
@@ -177,23 +195,31 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def TextFrame(self)->'ITextFrame':
+        """Gets the text frame object for the comment shape.
+        
+        The text frame contains properties related to the text display within the comment.
+        
+        Returns:
+            ITextFrame: The text frame object for the comment shape.
         """
-
-        """
+        from spire.xls.MsoTextFrame import MsoTextFrame
         GetDllLibXls().ExcelCommentObject_get_TextFrame.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_TextFrame.restype=c_void_p
         intPtr = CallCFunction(GetDllLibXls().ExcelCommentObject_get_TextFrame, self.Ptr)
-        ret = None if intPtr==None else ITextFrame(intPtr)
+        ret = None if intPtr==None else MsoTextFrame(intPtr)
         return ret
 
 
     @property
 
     def ResizeBehave(self)->'ResizeBehaveType':
-        """
-    <summary>
-        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.
-    </summary>
+        """Gets or sets how the comment shape resizes when rows and columns are resized.
+        
+        This property specifies how the drawing object shall be resized when the rows and columns 
+        between its start and ending anchor are resized or inserted.
+        
+        Returns:
+            ResizeBehaveType: An enumeration value representing the resize behavior type.
         """
         GetDllLibXls().ExcelCommentObject_get_ResizeBehave.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_ResizeBehave.restype=c_int
@@ -208,8 +234,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def Visible(self)->bool:
-        """
-
+        """Gets or sets whether the comment shape is visible in the worksheet.
+        
+        Returns:
+            bool: True if the comment shape is visible; otherwise, False.
         """
         GetDllLibXls().ExcelCommentObject_get_Visible.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Visible.restype=c_bool
@@ -223,10 +251,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def Height(self)->int:
-        """
-    <summary>
-        Height of comment.
-    </summary>
+        """Gets or sets the height of the comment shape in points.
+        
+        Returns:
+            int: The height of the comment shape in points.
         """
         GetDllLibXls().ExcelCommentObject_get_Height.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Height.restype=c_int
@@ -241,8 +269,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def HAlignment(self)->'CommentHAlignType':
-        """
-
+        """Gets or sets the horizontal alignment of text in the comment.
+        
+        Returns:
+            CommentHAlignType: An enumeration value representing the horizontal alignment type.
         """
         GetDllLibXls().ExcelCommentObject_get_HAlignment.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_HAlignment.restype=c_int
@@ -258,8 +288,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def VAlignment(self)->'CommentVAlignType':
-        """
-
+        """Gets or sets the vertical alignment of text in the comment.
+        
+        Returns:
+            CommentVAlignType: An enumeration value representing the vertical alignment type.
         """
         GetDllLibXls().ExcelCommentObject_get_VAlignment.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_VAlignment.restype=c_int
@@ -275,8 +307,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def TextRotation(self)->'TextRotationType':
-        """
-
+        """Gets or sets the rotation type of the text in the comment.
+        
+        Returns:
+            TextRotationType: An enumeration value representing the text rotation type.
         """
         GetDllLibXls().ExcelCommentObject_get_TextRotation.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_TextRotation.restype=c_int
@@ -291,8 +325,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def ID(self)->int:
-        """
-
+        """Gets the unique identifier for the comment shape.
+        
+        Returns:
+            int: The unique identifier for the comment shape.
         """
         GetDllLibXls().ExcelCommentObject_get_ID.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_ID.restype=c_int
@@ -301,10 +337,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def Left(self)->int:
-        """
-    <summary>
-        Position of left
-    </summary>
+        """Gets or sets the horizontal position of the comment shape in points.
+        
+        Returns:
+            int: The horizontal position of the comment shape in points, measured from the left edge.
         """
         GetDllLibXls().ExcelCommentObject_get_Left.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Left.restype=c_int
@@ -319,10 +355,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def Name(self)->str:
-        """
-    <summary>
-        Name of object.
-    </summary>
+        """Gets or sets the name of the comment shape.
+        
+        Returns:
+            str: The name of the comment shape.
         """
         GetDllLibXls().ExcelCommentObject_get_Name.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Name.restype=c_void_p
@@ -337,10 +373,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def Top(self)->int:
-        """
-    <summary>
-        Top of object.
-    </summary>
+        """Gets or sets the vertical position of the comment shape in points.
+        
+        Returns:
+            int: The vertical position of the comment shape in points, measured from the top edge.
         """
         GetDllLibXls().ExcelCommentObject_get_Top.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Top.restype=c_int
@@ -354,10 +390,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def Width(self)->int:
-        """
-    <summary>
-        Width of object.
-    </summary>
+        """Gets or sets the width of the comment shape in points.
+        
+        Returns:
+            int: The width of the comment shape in points.
         """
         GetDllLibXls().ExcelCommentObject_get_Width.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Width.restype=c_int
@@ -372,10 +408,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def ShapeType(self)->'ExcelShapeType':
-        """
-    <summary>
-        Shape type of object.
-    </summary>
+        """Gets or sets the shape type of the comment.
+        
+        Returns:
+            ExcelShapeType: An enumeration value representing the shape type of the comment.
         """
         GetDllLibXls().ExcelCommentObject_get_ShapeType.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_ShapeType.restype=c_int
@@ -390,8 +426,12 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def IsLocked(self)->bool:
-        """
-
+        """Gets or sets whether the comment shape is locked.
+        
+        When a comment shape is locked, it cannot be modified when the worksheet is protected.
+        
+        Returns:
+            bool: True if the comment shape is locked; otherwise, False.
         """
         GetDllLibXls().ExcelCommentObject_get_IsLocked.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_IsLocked.restype=c_bool
@@ -405,8 +445,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def IsPrintable(self)->bool:
-        """
-
+        """Gets or sets whether the comment shape is printed when the worksheet is printed.
+        
+        Returns:
+            bool: True if the comment shape is printed; otherwise, False.
         """
         GetDllLibXls().ExcelCommentObject_get_IsPrintable.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_IsPrintable.restype=c_bool
@@ -421,10 +463,13 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def AlternativeText(self)->str:
-        """
-    <summary>
-        Alternative text.
-    </summary>
+        """Gets or sets the alternative text description for the comment shape.
+        
+        Alternative text is used for accessibility purposes and appears when the comment
+        is hovered over or when the comment cannot be displayed.
+        
+        Returns:
+            str: The alternative text for the comment shape.
         """
         GetDllLibXls().ExcelCommentObject_get_AlternativeText.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_AlternativeText.restype=c_void_p
@@ -440,8 +485,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def Parent(self)->'SpireObject':
-        """
-
+        """Gets the parent object of the comment.
+        
+        Returns:
+            SpireObject: The parent object that contains this comment.
         """
         GetDllLibXls().ExcelCommentObject_get_Parent.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Parent.restype=c_void_p
@@ -452,8 +499,12 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def IsTextLocked(self)->bool:
-        """
-
+        """Gets or sets whether the text in the comment is locked.
+        
+        When the text is locked, it cannot be edited when the worksheet is protected.
+        
+        Returns:
+            bool: True if the text in the comment is locked; otherwise, False.
         """
         GetDllLibXls().ExcelCommentObject_get_IsTextLocked.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_IsTextLocked.restype=c_bool
@@ -467,8 +518,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def IsSmartArt(self)->bool:
-        """
-
+        """Gets whether the comment is part of a SmartArt object.
+        
+        Returns:
+            bool: True if the comment is part of a SmartArt object; otherwise, False.
         """
         GetDllLibXls().ExcelCommentObject_get_IsSmartArt.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_IsSmartArt.restype=c_bool
@@ -478,8 +531,10 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def OnAction(self)->str:
-        """
-
+        """Gets or sets the name of the macro to run when the comment is clicked.
+        
+        Returns:
+            str: The name of the macro to run when the comment is clicked.
         """
         GetDllLibXls().ExcelCommentObject_get_OnAction.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_OnAction.restype=c_void_p
@@ -494,8 +549,13 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def IsLockAspectRatio(self)->bool:
-        """
-
+        """Gets or sets whether the aspect ratio of the comment shape is locked.
+        
+        When the aspect ratio is locked, the width and height of the comment shape
+        maintain their proportions when the shape is resized.
+        
+        Returns:
+            bool: True if the aspect ratio is locked; otherwise, False.
         """
         GetDllLibXls().ExcelCommentObject_get_IsLockAspectRatio.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_IsLockAspectRatio.restype=c_bool
@@ -510,8 +570,12 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def Shadow(self)->'IShadow':
-        """
-
+        """Gets the shadow effect formatting for the comment shape.
+        
+        The shadow effect adds a shadow behind the comment.
+        
+        Returns:
+            IShadow: The shadow effect formatting object for the comment shape.
         """
         GetDllLibXls().ExcelCommentObject_get_Shadow.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Shadow.restype=c_void_p
@@ -523,9 +587,14 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def Glow(self)->'IGlow':
+        """Gets the glow effect formatting for the comment shape.
+        
+        The glow effect adds a colored, blurred outline around the comment.
+        
+        Returns:
+            IGlow: The glow effect formatting object for the comment shape.
         """
-
-        """
+        from spire.xls.ShapeGlow import ShapeGlow
         GetDllLibXls().ExcelCommentObject_get_Glow.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Glow.restype=c_void_p
         intPtr = CallCFunction(GetDllLibXls().ExcelCommentObject_get_Glow, self.Ptr)
@@ -536,9 +605,14 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def Reflection(self)->'IReflectionEffect':
+        """Gets the reflection effect formatting for the comment shape.
+        
+        The reflection effect adds a reflection of the comment below it.
+        
+        Returns:
+            IReflectionEffect: The reflection effect formatting object for the comment shape.
         """
-
-        """
+        from spire.xls.ShapeReflection import ShapeReflection
         GetDllLibXls().ExcelCommentObject_get_Reflection.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Reflection.restype=c_void_p
         intPtr = CallCFunction(GetDllLibXls().ExcelCommentObject_get_Reflection, self.Ptr)
@@ -549,9 +623,14 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def ThreeD(self)->'IFormat3D':
+        """Gets the 3D formatting for the comment shape.
+        
+        The 3D formatting includes properties such as depth, contour, and surface.
+        
+        Returns:
+            IFormat3D: The 3D formatting object for the comment shape.
         """
-
-        """
+        from spire.xls.Format3D import Format3D
         GetDllLibXls().ExcelCommentObject_get_ThreeD.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_ThreeD.restype=c_void_p
         intPtr = CallCFunction(GetDllLibXls().ExcelCommentObject_get_ThreeD, self.Ptr)
@@ -561,10 +640,14 @@ class ExcelCommentObject (  SpireObject, IComment) :
 
     @property
     def Rotation(self)->int:
-        """
-    <summary>
-        Returns or sets the rotation of the shape, in degrees.
-    </summary>
+        """Gets or sets the rotation of the comment shape, in degrees.
+        
+        This property controls the angle of rotation for the comment shape.
+        Positive values rotate the shape clockwise, while negative values
+        rotate it counterclockwise.
+        
+        Returns:
+            int: The rotation angle in degrees.
         """
         GetDllLibXls().ExcelCommentObject_get_Rotation.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_Rotation.restype=c_int
@@ -579,8 +662,13 @@ class ExcelCommentObject (  SpireObject, IComment) :
     @property
 
     def LinkedCell(self)->'IXLSRange':
-        """
-
+        """Gets or sets the cell range that is linked to the comment.
+        
+        When a cell range is linked to a comment, changes to the linked cell
+        can affect the comment's behavior or appearance.
+        
+        Returns:
+            IXLSRange: The cell range that is linked to the comment.
         """
         GetDllLibXls().ExcelCommentObject_get_LinkedCell.argtypes=[c_void_p]
         GetDllLibXls().ExcelCommentObject_get_LinkedCell.restype=c_void_p
@@ -595,22 +683,24 @@ class ExcelCommentObject (  SpireObject, IComment) :
         CallCFunction(GetDllLibXls().ExcelCommentObject_set_LinkedCell, self.Ptr, value.Ptr)
 
     def Remove(self):
-        """
-    <summary>
-        Removes comment.
-    </summary>
+        """Removes the comment from the worksheet.
+        
+        This method permanently deletes the comment from the worksheet.
+        After calling this method, the comment object is no longer valid.
         """
         GetDllLibXls().ExcelCommentObject_Remove.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().ExcelCommentObject_Remove, self.Ptr)
 
 
     def Scale(self ,scaleWidth:int,scaleHeight:int):
-        """
-    <summary>
-        Scales all comments.
-    </summary>
-    <param name="scaleWidth">Width scale in percents.</param>
-    <param name="scaleHeight">Height scale in percents.</param>
+        """Scales the comment shape by the specified percentages.
+        
+        This method resizes the comment shape according to the specified width and height
+        scaling percentages.
+        
+        Args:
+            scaleWidth (int): The percentage to scale the width (100 = original size).
+            scaleHeight (int): The percentage to scale the height (100 = original size).
         """
         
         GetDllLibXls().ExcelCommentObject_Scale.argtypes=[c_void_p ,c_int,c_int]