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

spire/xls/XlsRectangleShape.py

@@ -7,14 +7,18 @@ from ctypes import *
 import abc
 
 class XlsRectangleShape (  XlsPrstGeomShape, IRectangleShape) :
-    """
-
+    """Represents a rectangle shape in an Excel worksheet.
+    
+    This class provides properties and methods for manipulating rectangle shapes,
+    including text, alignment, and hyperlinks.
     """
     @property
 
     def ShapeType(self)->'ExcelShapeType':
-        """
-
+        """Gets the shape type of the rectangle.
+        
+        Returns:
+            ExcelShapeType: An enumeration value representing the shape type of the rectangle.
         """
         GetDllLibXls().XlsRectangleShape_get_ShapeType.argtypes=[c_void_p]
         GetDllLibXls().XlsRectangleShape_get_ShapeType.restype=c_int
@@ -25,8 +29,10 @@ class XlsRectangleShape (  XlsPrstGeomShape, IRectangleShape) :
     @property
 
     def RectShapeType(self)->'RectangleShapeType':
-        """
-
+        """Gets the specific rectangle shape type.
+        
+        Returns:
+            RectangleShapeType: An enumeration value representing the specific type of rectangle shape.
         """
         GetDllLibXls().XlsRectangleShape_get_RectShapeType.argtypes=[c_void_p]
         GetDllLibXls().XlsRectangleShape_get_RectShapeType.restype=c_int
@@ -37,8 +43,10 @@ class XlsRectangleShape (  XlsPrstGeomShape, IRectangleShape) :
     @property
 
     def Text(self)->str:
-        """
-
+        """Gets or sets the text displayed in the rectangle shape.
+        
+        Returns:
+            str: The text content of the rectangle shape.
         """
         GetDllLibXls().XlsRectangleShape_get_Text.argtypes=[c_void_p]
         GetDllLibXls().XlsRectangleShape_get_Text.restype=c_void_p
@@ -48,13 +56,20 @@ class XlsRectangleShape (  XlsPrstGeomShape, IRectangleShape) :
 
     @Text.setter
     def Text(self, value:str):
+        """Sets the text displayed in the rectangle shape.
+        
+        Args:
+            value (str): The text to display in the rectangle shape.
+        """
         GetDllLibXls().XlsRectangleShape_set_Text.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsRectangleShape_set_Text, self.Ptr, value)
 
     @property
     def IsTextLocked(self)->bool:
-        """
-
+        """Gets or sets whether the text in the rectangle shape is locked.
+        
+        Returns:
+            bool: True if the text is locked; otherwise, False.
         """
         GetDllLibXls().XlsRectangleShape_get_IsTextLocked.argtypes=[c_void_p]
         GetDllLibXls().XlsRectangleShape_get_IsTextLocked.restype=c_bool
@@ -63,14 +78,21 @@ class XlsRectangleShape (  XlsPrstGeomShape, IRectangleShape) :
 
     @IsTextLocked.setter
     def IsTextLocked(self, value:bool):
+        """Sets whether the text in the rectangle shape is locked.
+        
+        Args:
+            value (bool): True to lock the text; False to unlock it.
+        """
         GetDllLibXls().XlsRectangleShape_set_IsTextLocked.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsRectangleShape_set_IsTextLocked, self.Ptr, value)
 
     @property
 
     def TextRotation(self)->'TextRotationType':
-        """
-
+        """Gets or sets the text rotation in the rectangle shape.
+        
+        Returns:
+            TextRotationType: An enumeration value representing the text rotation.
         """
         GetDllLibXls().XlsRectangleShape_get_TextRotation.argtypes=[c_void_p]
         GetDllLibXls().XlsRectangleShape_get_TextRotation.restype=c_int
@@ -80,14 +102,21 @@ class XlsRectangleShape (  XlsPrstGeomShape, IRectangleShape) :
 
     @TextRotation.setter
     def TextRotation(self, value:'TextRotationType'):
+        """Sets the text rotation in the rectangle shape.
+        
+        Args:
+            value (TextRotationType): An enumeration value representing the text rotation.
+        """
         GetDllLibXls().XlsRectangleShape_set_TextRotation.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsRectangleShape_set_TextRotation, self.Ptr, value.value)
 
     @property
 
     def RichText(self)->'IRichTextString':
-        """
-
+        """Gets the rich text formatting for the text in the rectangle shape.
+        
+        Returns:
+            IRichTextString: An object that represents the rich text formatting.
         """
         GetDllLibXls().XlsRectangleShape_get_RichText.argtypes=[c_void_p]
         GetDllLibXls().XlsRectangleShape_get_RichText.restype=c_void_p
@@ -99,8 +128,10 @@ class XlsRectangleShape (  XlsPrstGeomShape, IRectangleShape) :
     @property
 
     def HAlignment(self)->'CommentHAlignType':
-        """
-
+        """Gets or sets the horizontal alignment of text in the rectangle shape.
+        
+        Returns:
+            CommentHAlignType: An enumeration value representing the horizontal alignment.
         """
         GetDllLibXls().XlsRectangleShape_get_HAlignment.argtypes=[c_void_p]
         GetDllLibXls().XlsRectangleShape_get_HAlignment.restype=c_int
@@ -110,14 +141,21 @@ class XlsRectangleShape (  XlsPrstGeomShape, IRectangleShape) :
 
     @HAlignment.setter
     def HAlignment(self, value:'CommentHAlignType'):
+        """Sets the horizontal alignment of text in the rectangle shape.
+        
+        Args:
+            value (CommentHAlignType): An enumeration value representing the horizontal alignment.
+        """
         GetDllLibXls().XlsRectangleShape_set_HAlignment.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsRectangleShape_set_HAlignment, self.Ptr, value.value)
 
     @property
 
     def VAlignment(self)->'CommentVAlignType':
-        """
-
+        """Gets or sets the vertical alignment of text in the rectangle shape.
+        
+        Returns:
+            CommentVAlignType: An enumeration value representing the vertical alignment.
         """
         GetDllLibXls().XlsRectangleShape_get_VAlignment.argtypes=[c_void_p]
         GetDllLibXls().XlsRectangleShape_get_VAlignment.restype=c_int
@@ -127,14 +165,21 @@ class XlsRectangleShape (  XlsPrstGeomShape, IRectangleShape) :
 
     @VAlignment.setter
     def VAlignment(self, value:'CommentVAlignType'):
+        """Sets the vertical alignment of text in the rectangle shape.
+        
+        Args:
+            value (CommentVAlignType): An enumeration value representing the vertical alignment.
+        """
         GetDllLibXls().XlsRectangleShape_set_VAlignment.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsRectangleShape_set_VAlignment, self.Ptr, value.value)
 
     @property
 
     def HyLink(self)->'IHyperLink':
-        """
-
+        """Gets the hyperlink associated with the rectangle shape.
+        
+        Returns:
+            IHyperLink: An object representing the hyperlink associated with the shape.
         """
         GetDllLibXls().XlsRectangleShape_get_HyLink.argtypes=[c_void_p]
         GetDllLibXls().XlsRectangleShape_get_HyLink.restype=c_void_p
@@ -146,8 +191,10 @@ class XlsRectangleShape (  XlsPrstGeomShape, IRectangleShape) :
     @property
 
     def PrstShapeType(self)->'PrstGeomShapeType':
-        """
-
+        """Gets the preset geometry shape type of the rectangle.
+        
+        Returns:
+            PrstGeomShapeType: An enumeration value representing the preset geometry shape type.
         """
         GetDllLibXls().XlsRectangleShape_get_PrstShapeType.argtypes=[c_void_p]
         GetDllLibXls().XlsRectangleShape_get_PrstShapeType.restype=c_int

spire/xls/XlsScrollBarShape.py

@@ -7,13 +7,17 @@ from ctypes import *
 import abc
 
 class XlsScrollBarShape (  XlsShape, IScrollBarShape) :
-    """
-
+    """Represents a scroll bar control in an Excel worksheet.
+    
+    This class provides properties and methods for manipulating scroll bar controls,
+    including value ranges, appearance, and orientation.
     """
     @property
     def Display3DShading(self)->bool:
-        """
-
+        """Gets or sets whether the scroll bar displays with 3D shading.
+        
+        Returns:
+            bool: True if the scroll bar has 3D shading; otherwise, False.
         """
         GetDllLibXls().XlsScrollBarShape_get_Display3DShading.argtypes=[c_void_p]
         GetDllLibXls().XlsScrollBarShape_get_Display3DShading.restype=c_bool
@@ -22,13 +26,22 @@ class XlsScrollBarShape (  XlsShape, IScrollBarShape) :
 
     @Display3DShading.setter
     def Display3DShading(self, value:bool):
+        """Sets whether the scroll bar displays with 3D shading.
+        
+        Args:
+            value (bool): True to display with 3D shading; False for flat appearance.
+        """
         GetDllLibXls().XlsScrollBarShape_set_Display3DShading.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsScrollBarShape_set_Display3DShading, self.Ptr, value)
 
     @property
     def CurrentValue(self)->int:
-        """
-
+        """Gets or sets the current value of the scroll bar.
+        
+        The value must be between Min and Max properties.
+        
+        Returns:
+            int: The current value of the scroll bar.
         """
         GetDllLibXls().XlsScrollBarShape_get_CurrentValue.argtypes=[c_void_p]
         GetDllLibXls().XlsScrollBarShape_get_CurrentValue.restype=c_int
@@ -37,13 +50,20 @@ class XlsScrollBarShape (  XlsShape, IScrollBarShape) :
 
     @CurrentValue.setter
     def CurrentValue(self, value:int):
+        """Sets the current value of the scroll bar.
+        
+        Args:
+            value (int): The current value to set for the scroll bar. Must be between Min and Max.
+        """
         GetDllLibXls().XlsScrollBarShape_set_CurrentValue.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsScrollBarShape_set_CurrentValue, self.Ptr, value)
 
     @property
     def Min(self)->int:
-        """
-
+        """Gets or sets the minimum value of the scroll bar.
+        
+        Returns:
+            int: The minimum value of the scroll bar.
         """
         GetDllLibXls().XlsScrollBarShape_get_Min.argtypes=[c_void_p]
         GetDllLibXls().XlsScrollBarShape_get_Min.restype=c_int
@@ -52,13 +72,20 @@ class XlsScrollBarShape (  XlsShape, IScrollBarShape) :
 
     @Min.setter
     def Min(self, value:int):
+        """Sets the minimum value of the scroll bar.
+        
+        Args:
+            value (int): The minimum value to set for the scroll bar.
+        """
         GetDllLibXls().XlsScrollBarShape_set_Min.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsScrollBarShape_set_Min, self.Ptr, value)
 
     @property
     def Max(self)->int:
-        """
-
+        """Gets or sets the maximum value of the scroll bar.
+        
+        Returns:
+            int: The maximum value of the scroll bar.
         """
         GetDllLibXls().XlsScrollBarShape_get_Max.argtypes=[c_void_p]
         GetDllLibXls().XlsScrollBarShape_get_Max.restype=c_int
@@ -67,13 +94,22 @@ class XlsScrollBarShape (  XlsShape, IScrollBarShape) :
 
     @Max.setter
     def Max(self, value:int):
+        """Sets the maximum value of the scroll bar.
+        
+        Args:
+            value (int): The maximum value to set for the scroll bar.
+        """
         GetDllLibXls().XlsScrollBarShape_set_Max.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsScrollBarShape_set_Max, self.Ptr, value)
 
     @property
     def IncrementalChange(self)->int:
-        """
-
+        """Gets or sets the small change value for the scroll bar.
+        
+        This is the value that changes when the user clicks on the scroll arrows.
+        
+        Returns:
+            int: The small change value for the scroll bar.
         """
         GetDllLibXls().XlsScrollBarShape_get_IncrementalChange.argtypes=[c_void_p]
         GetDllLibXls().XlsScrollBarShape_get_IncrementalChange.restype=c_int
@@ -82,13 +118,23 @@ class XlsScrollBarShape (  XlsShape, IScrollBarShape) :
 
     @IncrementalChange.setter
     def IncrementalChange(self, value:int):
+        """Sets the small change value for the scroll bar.
+        
+        Args:
+            value (int): The small change value to set for the scroll bar.
+        """
         GetDllLibXls().XlsScrollBarShape_set_IncrementalChange.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsScrollBarShape_set_IncrementalChange, self.Ptr, value)
 
     @property
     def PageChange(self)->int:
-        """
-
+        """Gets or sets the large change value for the scroll bar.
+        
+        This is the value that changes when the user clicks on the scroll bar area
+        between the thumb and the arrows.
+        
+        Returns:
+            int: The large change value for the scroll bar.
         """
         GetDllLibXls().XlsScrollBarShape_get_PageChange.argtypes=[c_void_p]
         GetDllLibXls().XlsScrollBarShape_get_PageChange.restype=c_int
@@ -97,13 +143,20 @@ class XlsScrollBarShape (  XlsShape, IScrollBarShape) :
 
     @PageChange.setter
     def PageChange(self, value:int):
+        """Sets the large change value for the scroll bar.
+        
+        Args:
+            value (int): The large change value to set for the scroll bar.
+        """
         GetDllLibXls().XlsScrollBarShape_set_PageChange.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsScrollBarShape_set_PageChange, self.Ptr, value)
 
     @property
     def IsHorizontal(self)->bool:
-        """
-
+        """Gets or sets whether the scroll bar is horizontal.
+        
+        Returns:
+            bool: True if the scroll bar is horizontal; False if it is vertical.
         """
         GetDllLibXls().XlsScrollBarShape_get_IsHorizontal.argtypes=[c_void_p]
         GetDllLibXls().XlsScrollBarShape_get_IsHorizontal.restype=c_bool
@@ -112,14 +165,21 @@ class XlsScrollBarShape (  XlsShape, IScrollBarShape) :
 
     @IsHorizontal.setter
     def IsHorizontal(self, value:bool):
+        """Sets whether the scroll bar is horizontal.
+        
+        Args:
+            value (bool): True to make the scroll bar horizontal; False to make it vertical.
+        """
         GetDllLibXls().XlsScrollBarShape_set_IsHorizontal.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsScrollBarShape_set_IsHorizontal, self.Ptr, value)
 
     @property
 
     def ShapeType(self)->'ExcelShapeType':
-        """
-
+        """Gets the shape type of the scroll bar.
+        
+        Returns:
+            ExcelShapeType: An enumeration value representing the shape type.
         """
         GetDllLibXls().XlsScrollBarShape_get_ShapeType.argtypes=[c_void_p]
         GetDllLibXls().XlsScrollBarShape_get_ShapeType.restype=c_int