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

spire/xls/CommentsRange.py

@@ -7,14 +7,20 @@ from ctypes import *
 import abc
 
 class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
-    """
-
+    """Represents a comment 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 multiple interfaces to support various aspects of
+    comment functionality, including text box and shape behaviors.
     """
     @property
 
     def Author(self)->str:
-        """
-
+        """Gets or sets the author of the comment.
+        
+        Returns:
+            str: The name of the author who created the comment.
         """
         GetDllLibXls().CommentsRange_get_Author.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Author.restype=c_void_p
@@ -29,8 +35,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @property
     def IsVisible(self)->bool:
-        """
-
+        """Gets or sets whether the comment is visible.
+        
+        Returns:
+            bool: True if the comment is visible; otherwise, False.
         """
         GetDllLibXls().CommentsRange_get_IsVisible.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_IsVisible.restype=c_bool
@@ -44,8 +52,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @property
     def Row(self)->int:
-        """
-
+        """Gets the row index of the cell that contains the comment.
+        
+        Returns:
+            int: The zero-based row index.
         """
         GetDllLibXls().CommentsRange_get_Row.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Row.restype=c_int
@@ -54,8 +64,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @property
     def Column(self)->int:
-        """
-
+        """Gets the column index of the cell that contains the comment.
+        
+        Returns:
+            int: The zero-based column index.
         """
         GetDllLibXls().CommentsRange_get_Column.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Column.restype=c_int
@@ -65,8 +77,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @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().CommentsRange_get_RichText.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_RichText.restype=c_void_p
@@ -78,8 +92,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @property
 
     def Text(self)->str:
-        """
-
+        """Gets or sets the text content of the comment.
+        
+        Returns:
+            str: The text content of the comment.
         """
         GetDllLibXls().CommentsRange_get_Text.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Text.restype=c_void_p
@@ -95,10 +111,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @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().CommentsRange_get_HtmlString.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_HtmlString.restype=c_void_p
@@ -113,8 +129,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @property
     def IsMoveWithCell(self)->bool:
-        """
-
+        """Gets or sets whether the comment moves with the cell when the cell is moved.
+        
+        Returns:
+            bool: True if the comment moves with the cell; otherwise, False.
         """
         GetDllLibXls().CommentsRange_get_IsMoveWithCell.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_IsMoveWithCell.restype=c_bool
@@ -128,8 +146,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @property
     def AutoSize(self)->bool:
-        """
-
+        """Gets or sets whether the comment is automatically sized to fit its content.
+        
+        Returns:
+            bool: True if the comment is automatically sized; otherwise, False.
         """
         GetDllLibXls().CommentsRange_get_AutoSize.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_AutoSize.restype=c_bool
@@ -142,16 +162,20 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
         CallCFunction(GetDllLibXls().CommentsRange_set_AutoSize, self.Ptr, value)
 
     def Remove(self):
-        """
-
+        """Removes the comment from the worksheet.
+        
+        This method deletes the comment from its associated cell in the worksheet.
         """
         GetDllLibXls().CommentsRange_Remove.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().CommentsRange_Remove, self.Ptr)
 
 
     def Scale(self ,scaleWidth:int,scaleHeight:int):
-        """
-
+        """Scales the comment by the specified width and height percentages.
+        
+        Args:
+            scaleWidth (int): The percentage to scale the width of the comment.
+            scaleHeight (int): The percentage to scale the height of the comment.
         """
         
         GetDllLibXls().CommentsRange_Scale.argtypes=[c_void_p ,c_int,c_int]
@@ -161,9 +185,8 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     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>
+
         """
         GetDllLibXls().CommentsRange_get_ResizeBehave.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_ResizeBehave.restype=c_int
@@ -178,8 +201,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @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().CommentsRange_get_Visible.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Visible.restype=c_bool
@@ -193,8 +218,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @property
     def Height(self)->int:
-        """
-
+        """Gets or sets the height of the comment shape in points.
+        
+        Returns:
+            int: The height of the comment shape in points.
         """
         GetDllLibXls().CommentsRange_get_Height.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Height.restype=c_int
@@ -208,8 +235,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @property
     def ID(self)->int:
-        """
-
+        """Gets the unique identifier for the comment shape.
+        
+        Returns:
+            int: The unique identifier for the comment shape.
         """
         GetDllLibXls().CommentsRange_get_ID.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_ID.restype=c_int
@@ -218,8 +247,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @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().CommentsRange_get_IsSmartArt.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_IsSmartArt.restype=c_bool
@@ -228,8 +259,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @property
     def Left(self)->int:
-        """
-
+        """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().CommentsRange_get_Left.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Left.restype=c_int
@@ -244,8 +277,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @property
 
     def Name(self)->str:
-        """
-
+        """Gets or sets the name of the comment shape.
+        
+        Returns:
+            str: The name of the comment shape.
         """
         GetDllLibXls().CommentsRange_get_Name.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Name.restype=c_void_p
@@ -260,8 +295,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @property
     def Top(self)->int:
-        """
-
+        """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().CommentsRange_get_Top.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Top.restype=c_int
@@ -275,8 +312,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @property
     def Width(self)->int:
-        """
-
+        """Gets or sets the width of the comment shape in points.
+        
+        Returns:
+            int: The width of the comment shape in points.
         """
         GetDllLibXls().CommentsRange_get_Width.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Width.restype=c_int
@@ -291,8 +330,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @property
 
     def ShapeType(self)->'ExcelShapeType':
-        """
-
+        """Gets or sets the shape type of the comment.
+        
+        Returns:
+            ExcelShapeType: An enumeration value representing the shape type of the comment.
         """
         GetDllLibXls().CommentsRange_get_ShapeType.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_ShapeType.restype=c_int
@@ -308,8 +349,13 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @property
 
     def AlternativeText(self)->str:
-        """
-
+        """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().CommentsRange_get_AlternativeText.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_AlternativeText.restype=c_void_p
@@ -325,8 +371,12 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @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.
         """
         GetDllLibXls().CommentsRange_get_TextFrame.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_TextFrame.restype=c_void_p
@@ -338,8 +388,12 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @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().CommentsRange_get_Fill.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Fill.restype=c_void_p
@@ -351,10 +405,12 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @property
 
     def Line(self)->'IShapeLineFormat':
-        """
-    <summary>
-        Represents line format properties. Read only.
-    </summary>
+        """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.
         """
         GetDllLibXls().CommentsRange_get_Line.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Line.restype=c_void_p
@@ -366,8 +422,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @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().CommentsRange_get_OnAction.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_OnAction.restype=c_void_p
@@ -383,8 +441,12 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @property
 
     def LinkedCell(self)->'IXLSRange':
-        """
-
+        """Gets or sets the cell range that is linked to the comment.
+        
+        When the linked cell's value changes, it can affect the comment's behavior.
+        
+        Returns:
+            IXLSRange: The cell range that is linked to the comment.
         """
         GetDllLibXls().CommentsRange_get_LinkedCell.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_LinkedCell.restype=c_void_p
@@ -400,8 +462,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @property
     def Rotation(self)->int:
-        """
-
+        """Gets or sets the rotation angle of the comment shape in degrees.
+        
+        Returns:
+            int: The rotation angle of the comment shape in degrees.
         """
         GetDllLibXls().CommentsRange_get_Rotation.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Rotation.restype=c_int
@@ -416,8 +480,12 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @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.
         """
         GetDllLibXls().CommentsRange_get_ThreeD.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_ThreeD.restype=c_void_p
@@ -429,8 +497,12 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @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.
         """
         GetDllLibXls().CommentsRange_get_Glow.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Glow.restype=c_void_p
@@ -442,8 +514,12 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @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().CommentsRange_get_Shadow.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Shadow.restype=c_void_p
@@ -455,8 +531,12 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @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.
         """
         GetDllLibXls().CommentsRange_get_Reflection.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_Reflection.restype=c_void_p
@@ -467,8 +547,13 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @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().CommentsRange_get_IsLockAspectRatio.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_IsLockAspectRatio.restype=c_bool
@@ -482,8 +567,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @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().CommentsRange_get_IsPrintable.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_IsPrintable.restype=c_bool
@@ -497,8 +584,12 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @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().CommentsRange_get_IsLocked.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_IsLocked.restype=c_bool
@@ -513,8 +604,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @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().CommentsRange_get_HAlignment.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_HAlignment.restype=c_int
@@ -530,8 +623,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @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().CommentsRange_get_VAlignment.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_VAlignment.restype=c_int
@@ -547,8 +642,10 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
     @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().CommentsRange_get_TextRotation.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_TextRotation.restype=c_int
@@ -563,8 +660,12 @@ class CommentsRange (  XlsObject, IComment, ITextBoxShape, ITextBox, IShape) :
 
     @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().CommentsRange_get_IsTextLocked.argtypes=[c_void_p]
         GetDllLibXls().CommentsRange_get_IsTextLocked.restype=c_bool

spire/xls/CommonWrapper.py

@@ -7,27 +7,42 @@ from ctypes import *
 import abc
 
 class CommonWrapper (  SpireObject, IOptimizedUpdate, ICloneParent) :
-    """
-
+    """Represents a common wrapper for Excel objects.
+    
+    This class extends SpireObject and implements IOptimizedUpdate and ICloneParent interfaces,
+    providing basic functionality for Excel objects, including batch update operations and
+    cloning capabilities. It serves as a base class for more specialized wrapper classes.
     """
     def BeginUpdate(self):
-        """
-
+        """Begins a batch update operation.
+        
+        This method marks the beginning of a series of changes to the object properties.
+        Changes made between BeginUpdate and EndUpdate are applied together for better performance.
         """
         GetDllLibXls().CommonWrapper_BeginUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().CommonWrapper_BeginUpdate, self.Ptr)
 
     def EndUpdate(self):
-        """
-
+        """Ends a batch update operation.
+        
+        This method completes the batch update started with BeginUpdate and
+        applies all pending changes to the object properties.
         """
         GetDllLibXls().CommonWrapper_EndUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().CommonWrapper_EndUpdate, self.Ptr)
 
 
     def Clone(self ,parent:'SpireObject')->'SpireObject':
-        """
-
+        """Creates a copy of the current object with the specified parent.
+        
+        This method creates a new object with the same properties as the current object,
+        but with a different parent object.
+        
+        Args:
+            parent (SpireObject): The parent object for the cloned object.
+            
+        Returns:
+            SpireObject: A new object that is a copy of the current object.
         """
         intPtrparent:c_void_p = parent.Ptr