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

spire/xls/WriteProtection.py

@@ -14,9 +14,8 @@ class WriteProtection (SpireObject) :
 
     def Author(self)->str:
         """
-    <summary>
         Gets and sets the author.
-    </summary>
+
         """
         GetDllLibXls().WriteProtection_get_Author.argtypes=[c_void_p]
         GetDllLibXls().WriteProtection_get_Author.restype=c_void_p
@@ -32,9 +31,8 @@ class WriteProtection (SpireObject) :
     @property
     def IsWriteProtected(self)->bool:
         """
-    <summary>
         Gets whether this workbook is write protected.
-    </summary>
+
         """
         GetDllLibXls().WriteProtection_get_IsWriteProtected.argtypes=[c_void_p]
         GetDllLibXls().WriteProtection_get_IsWriteProtected.restype=c_bool
@@ -48,9 +46,8 @@ class WriteProtection (SpireObject) :
     @property
     def RecommendReadOnly(self)->bool:
         """
-    <summary>
         Gets or sets whether the Read Only Recommended option is selected.
-    </summary>
+
         """
         GetDllLibXls().WriteProtection_get_RecommendReadOnly.argtypes=[c_void_p]
         GetDllLibXls().WriteProtection_get_RecommendReadOnly.restype=c_bool

spire/xls/XlsAddInFunction.py

@@ -7,15 +7,18 @@ from ctypes import *
 import abc
 
 class XlsAddInFunction (  XlsObject, IAddInFunction, ICloneParent) :
-    """
-
+    """Represents an add-in function in Excel.
+    
+    This class provides properties and methods for manipulating add-in functions,
+    including accessing and modifying function name and indexes. It extends XlsObject
+    and implements the IAddInFunction and ICloneParent interfaces.
     """
     @property
     def BookIndex(self)->int:
-        """
-    <summary>
-        Gets or sets book index.
-    </summary>
+        """Gets or sets the book index of the add-in function.
+        
+        Returns:
+            int: The book index of the add-in function.
         """
         GetDllLibXls().XlsAddInFunction_get_BookIndex.argtypes=[c_void_p]
         GetDllLibXls().XlsAddInFunction_get_BookIndex.restype=c_int
@@ -24,15 +27,20 @@ class XlsAddInFunction (  XlsObject, IAddInFunction, ICloneParent) :
 
     @BookIndex.setter
     def BookIndex(self, value:int):
+        """Sets the book index of the add-in function.
+        
+        Args:
+            value (int): The book index to set.
+        """
         GetDllLibXls().XlsAddInFunction_set_BookIndex.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsAddInFunction_set_BookIndex, self.Ptr, value)
 
     @property
     def NameIndex(self)->int:
-        """
-    <summary>
-        Name index.
-    </summary>
+        """Gets or sets the name index of the add-in function.
+        
+        Returns:
+            int: The name index of the add-in function.
         """
         GetDllLibXls().XlsAddInFunction_get_NameIndex.argtypes=[c_void_p]
         GetDllLibXls().XlsAddInFunction_get_NameIndex.restype=c_int
@@ -41,16 +49,21 @@ class XlsAddInFunction (  XlsObject, IAddInFunction, ICloneParent) :
 
     @NameIndex.setter
     def NameIndex(self, value:int):
+        """Sets the name index of the add-in function.
+        
+        Args:
+            value (int): The name index to set.
+        """
         GetDllLibXls().XlsAddInFunction_set_NameIndex.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsAddInFunction_set_NameIndex, self.Ptr, value)
 
     @property
 
     def Name(self)->str:
-        """
-    <summary>
-        Name of add-in function.
-    </summary>
+        """Gets the name of the add-in function.
+        
+        Returns:
+            str: The name of the add-in function.
         """
         GetDllLibXls().XlsAddInFunction_get_Name.argtypes=[c_void_p]
         GetDllLibXls().XlsAddInFunction_get_Name.restype=c_void_p
@@ -59,20 +72,21 @@ class XlsAddInFunction (  XlsObject, IAddInFunction, ICloneParent) :
 
 
 
-    def Clone(self ,parent:'SpireObject')->'SpireObject':
-        """
-    <summary>
-        Creates a new object that is a copy of the current instance.
-    </summary>
-    <param name="parent">Parent object for a copy of this instance.</param>
-    <returns>A new object that is a copy of this instance.</returns>
+    def Clone(self ,parent:'XlsWorkbook')->'XlsAddInFunction':
+        """Creates a new object that is a copy of the current instance.
+
+        Args:
+            parent (XlsWorkbook): Parent object for a copy of this instance.
+
+        Returns:
+            XlsAddInFunction: A new object that is a copy of this instance.
         """
         intPtrparent:c_void_p = parent.Ptr
 
         GetDllLibXls().XlsAddInFunction_Clone.argtypes=[c_void_p ,c_void_p]
         GetDllLibXls().XlsAddInFunction_Clone.restype=c_void_p
         intPtr = CallCFunction(GetDllLibXls().XlsAddInFunction_Clone, self.Ptr, intPtrparent)
-        ret = None if intPtr==None else SpireObject(intPtr)
+        ret = None if intPtr==None else XlsAddInFunction(intPtr)
         return ret
 
 

spire/xls/XlsArcShape.py

@@ -7,14 +7,19 @@ from ctypes import *
 import abc
 
 class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
-    """
-
+    """Represents an arc shape in an Excel worksheet.
+    
+    This class provides properties and methods for manipulating arc shapes in Excel,
+    including appearance settings such as line style, color, arrow styles, and text
+    formatting. It extends XlsPrstGeomShape and implements the IArcShape interface.
     """
     @property
 
     def ShapeType(self)->'ExcelShapeType':
-        """
-
+        """Gets the type of the shape.
+        
+        Returns:
+            ExcelShapeType: An enumeration value representing the type of the shape.
         """
         GetDllLibXls().XlsArcShape_get_ShapeType.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_ShapeType.restype=c_int
@@ -25,8 +30,10 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
     @property
 
     def Text(self)->str:
-        """
-
+        """Gets the text content of the arc shape.
+        
+        Returns:
+            str: The text content of the arc shape.
         """
         GetDllLibXls().XlsArcShape_get_Text.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_Text.restype=c_void_p
@@ -36,13 +43,20 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @Text.setter
     def Text(self, value:str):
+        """Sets the text content of the arc shape.
+        
+        Args:
+            value (str): The text content to set for the arc shape.
+        """
         GetDllLibXls().XlsArcShape_set_Text.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsArcShape_set_Text, self.Ptr, value)
 
     @property
     def IsTextLocked(self)->bool:
-        """
-
+        """Gets a value indicating whether the text in the arc shape is locked.
+        
+        Returns:
+            bool: True if the text is locked; otherwise, False.
         """
         GetDllLibXls().XlsArcShape_get_IsTextLocked.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_IsTextLocked.restype=c_bool
@@ -51,14 +65,21 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @IsTextLocked.setter
     def IsTextLocked(self, value:bool):
+        """Sets a value indicating whether the text in the arc shape is locked.
+        
+        Args:
+            value (bool): True to lock the text; otherwise, False.
+        """
         GetDllLibXls().XlsArcShape_set_IsTextLocked.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsArcShape_set_IsTextLocked, self.Ptr, value)
 
     @property
 
     def TextRotation(self)->'TextRotationType':
-        """
-
+        """Gets the rotation type of the text in the arc shape.
+        
+        Returns:
+            TextRotationType: An enumeration value representing the text rotation type.
         """
         GetDllLibXls().XlsArcShape_get_TextRotation.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_TextRotation.restype=c_int
@@ -68,27 +89,36 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @TextRotation.setter
     def TextRotation(self, value:'TextRotationType'):
+        """Sets the rotation type of the text in the arc shape.
+        
+        Args:
+            value (TextRotationType): An enumeration value representing the text rotation type.
+        """
         GetDllLibXls().XlsArcShape_set_TextRotation.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsArcShape_set_TextRotation, self.Ptr, value.value)
 
     @property
 
     def RichText(self)->'IRichTextString':
-        """
-
+        """Gets the rich text formatting of the text in the arc shape.
+        
+        Returns:
+            IRichTextString: An object representing the rich text formatting.
         """
         GetDllLibXls().XlsArcShape_get_RichText.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_RichText.restype=c_void_p
         intPtr = CallCFunction(GetDllLibXls().XlsArcShape_get_RichText, self.Ptr)
-        ret = None if intPtr==None else RichTextObject(intPtr)
+        ret = None if intPtr==None else RichTextShape(intPtr)
         return ret
 
 
     @property
 
     def HAlignment(self)->'CommentHAlignType':
-        """
-
+        """Gets the horizontal alignment of the text in the arc shape.
+        
+        Returns:
+            CommentHAlignType: An enumeration value representing the horizontal alignment.
         """
         GetDllLibXls().XlsArcShape_get_HAlignment.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_HAlignment.restype=c_int
@@ -98,14 +128,21 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @HAlignment.setter
     def HAlignment(self, value:'CommentHAlignType'):
+        """Sets the horizontal alignment of the text in the arc shape.
+        
+        Args:
+            value (CommentHAlignType): An enumeration value representing the horizontal alignment.
+        """
         GetDllLibXls().XlsArcShape_set_HAlignment.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsArcShape_set_HAlignment, self.Ptr, value.value)
 
     @property
 
     def VAlignment(self)->'CommentVAlignType':
-        """
-
+        """Gets the vertical alignment of the text in the arc shape.
+        
+        Returns:
+            CommentVAlignType: An enumeration value representing the vertical alignment.
         """
         GetDllLibXls().XlsArcShape_get_VAlignment.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_VAlignment.restype=c_int
@@ -115,13 +152,20 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @VAlignment.setter
     def VAlignment(self, value:'CommentVAlignType'):
+        """Sets the vertical alignment of the text in the arc shape.
+        
+        Args:
+            value (CommentVAlignType): An enumeration value representing the vertical alignment.
+        """
         GetDllLibXls().XlsArcShape_set_VAlignment.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsArcShape_set_VAlignment, self.Ptr, value.value)
 
     @property
     def Weight(self)->float:
-        """
-
+        """Gets the weight (thickness) of the arc line in points.
+        
+        Returns:
+            float: The weight of the arc line in points.
         """
         GetDllLibXls().XlsArcShape_get_Weight.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_Weight.restype=c_double
@@ -130,14 +174,21 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @Weight.setter
     def Weight(self, value:float):
+        """Sets the weight (thickness) of the arc line in points.
+        
+        Args:
+            value (float): The weight of the arc line in points.
+        """
         GetDllLibXls().XlsArcShape_set_Weight.argtypes=[c_void_p, c_double]
         CallCFunction(GetDllLibXls().XlsArcShape_set_Weight, self.Ptr, value)
 
     @property
 
     def Color(self)->'Color':
-        """
-
+        """Gets the color of the arc line.
+        
+        Returns:
+            Color: A Color object representing the color of the arc line.
         """
         GetDllLibXls().XlsArcShape_get_Color.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_Color.restype=c_void_p
@@ -148,14 +199,21 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @Color.setter
     def Color(self, value:'Color'):
+        """Sets the color of the arc line.
+        
+        Args:
+            value (Color): A Color object representing the color of the arc line.
+        """
         GetDllLibXls().XlsArcShape_set_Color.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsArcShape_set_Color, self.Ptr, value.Ptr)
 
     @property
 
     def Style(self)->'ShapeLineStyleType':
-        """
-
+        """Gets the line style of the arc.
+        
+        Returns:
+            ShapeLineStyleType: An enumeration value representing the line style.
         """
         GetDllLibXls().XlsArcShape_get_Style.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_Style.restype=c_int
@@ -165,14 +223,21 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @Style.setter
     def Style(self, value:'ShapeLineStyleType'):
+        """Sets the line style of the arc.
+        
+        Args:
+            value (ShapeLineStyleType): An enumeration value representing the line style.
+        """
         GetDllLibXls().XlsArcShape_set_Style.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsArcShape_set_Style, self.Ptr, value.value)
 
     @property
 
     def DashStyle(self)->'ShapeDashLineStyleType':
-        """
-
+        """Gets the dash style of the arc line.
+        
+        Returns:
+            ShapeDashLineStyleType: An enumeration value representing the dash style.
         """
         GetDllLibXls().XlsArcShape_get_DashStyle.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_DashStyle.restype=c_int
@@ -182,14 +247,21 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @DashStyle.setter
     def DashStyle(self, value:'ShapeDashLineStyleType'):
+        """Sets the dash style of the arc line.
+        
+        Args:
+            value (ShapeDashLineStyleType): An enumeration value representing the dash style.
+        """
         GetDllLibXls().XlsArcShape_set_DashStyle.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsArcShape_set_DashStyle, self.Ptr, value.value)
 
     @property
 
     def BeginArrowheadWidth(self)->'ShapeArrowWidthType':
-        """
-
+        """Gets the width of the arrowhead at the beginning of the arc.
+        
+        Returns:
+            ShapeArrowWidthType: An enumeration value representing the arrowhead width.
         """
         GetDllLibXls().XlsArcShape_get_BeginArrowheadWidth.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_BeginArrowheadWidth.restype=c_int
@@ -199,14 +271,21 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @BeginArrowheadWidth.setter
     def BeginArrowheadWidth(self, value:'ShapeArrowWidthType'):
+        """Sets the width of the arrowhead at the beginning of the arc.
+        
+        Args:
+            value (ShapeArrowWidthType): An enumeration value representing the arrowhead width.
+        """
         GetDllLibXls().XlsArcShape_set_BeginArrowheadWidth.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsArcShape_set_BeginArrowheadWidth, self.Ptr, value.value)
 
     @property
 
     def BeginArrowHeadStyle(self)->'ShapeArrowStyleType':
-        """
-
+        """Gets the style of the arrowhead at the beginning of the arc.
+        
+        Returns:
+            ShapeArrowStyleType: An enumeration value representing the arrowhead style.
         """
         GetDllLibXls().XlsArcShape_get_BeginArrowHeadStyle.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_BeginArrowHeadStyle.restype=c_int
@@ -216,14 +295,21 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @BeginArrowHeadStyle.setter
     def BeginArrowHeadStyle(self, value:'ShapeArrowStyleType'):
+        """Sets the style of the arrowhead at the beginning of the arc.
+        
+        Args:
+            value (ShapeArrowStyleType): An enumeration value representing the arrowhead style.
+        """
         GetDllLibXls().XlsArcShape_set_BeginArrowHeadStyle.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsArcShape_set_BeginArrowHeadStyle, self.Ptr, value.value)
 
     @property
 
     def BeginArrowheadLength(self)->'ShapeArrowLengthType':
-        """
-
+        """Gets the length of the arrowhead at the beginning of the arc.
+        
+        Returns:
+            ShapeArrowLengthType: An enumeration value representing the arrowhead length.
         """
         GetDllLibXls().XlsArcShape_get_BeginArrowheadLength.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_BeginArrowheadLength.restype=c_int
@@ -233,14 +319,21 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @BeginArrowheadLength.setter
     def BeginArrowheadLength(self, value:'ShapeArrowLengthType'):
+        """Sets the length of the arrowhead at the beginning of the arc.
+        
+        Args:
+            value (ShapeArrowLengthType): An enumeration value representing the arrowhead length.
+        """
         GetDllLibXls().XlsArcShape_set_BeginArrowheadLength.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsArcShape_set_BeginArrowheadLength, self.Ptr, value.value)
 
     @property
 
     def EndArrowHeadStyle(self)->'ShapeArrowStyleType':
-        """
-
+        """Gets the style of the arrowhead at the end of the arc.
+        
+        Returns:
+            ShapeArrowStyleType: An enumeration value representing the arrowhead style.
         """
         GetDllLibXls().XlsArcShape_get_EndArrowHeadStyle.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_EndArrowHeadStyle.restype=c_int
@@ -250,14 +343,21 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @EndArrowHeadStyle.setter
     def EndArrowHeadStyle(self, value:'ShapeArrowStyleType'):
+        """Sets the style of the arrowhead at the end of the arc.
+        
+        Args:
+            value (ShapeArrowStyleType): An enumeration value representing the arrowhead style.
+        """
         GetDllLibXls().XlsArcShape_set_EndArrowHeadStyle.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsArcShape_set_EndArrowHeadStyle, self.Ptr, value.value)
 
     @property
 
     def EndArrowheadLength(self)->'ShapeArrowLengthType':
-        """
-
+        """Gets the length of the arrowhead at the end of the arc.
+        
+        Returns:
+            ShapeArrowLengthType: An enumeration value representing the arrowhead length.
         """
         GetDllLibXls().XlsArcShape_get_EndArrowheadLength.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_EndArrowheadLength.restype=c_int
@@ -267,14 +367,21 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @EndArrowheadLength.setter
     def EndArrowheadLength(self, value:'ShapeArrowLengthType'):
+        """Sets the length of the arrowhead at the end of the arc.
+        
+        Args:
+            value (ShapeArrowLengthType): An enumeration value representing the arrowhead length.
+        """
         GetDllLibXls().XlsArcShape_set_EndArrowheadLength.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsArcShape_set_EndArrowheadLength, self.Ptr, value.value)
 
     @property
 
     def EndArrowheadWidth(self)->'ShapeArrowWidthType':
-        """
-
+        """Gets the width of the arrowhead at the end of the arc.
+        
+        Returns:
+            ShapeArrowWidthType: An enumeration value representing the arrowhead width.
         """
         GetDllLibXls().XlsArcShape_get_EndArrowheadWidth.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_EndArrowheadWidth.restype=c_int
@@ -284,14 +391,21 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
 
     @EndArrowheadWidth.setter
     def EndArrowheadWidth(self, value:'ShapeArrowWidthType'):
+        """Sets the width of the arrowhead at the end of the arc.
+        
+        Args:
+            value (ShapeArrowWidthType): An enumeration value representing the arrowhead width.
+        """
         GetDllLibXls().XlsArcShape_set_EndArrowheadWidth.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsArcShape_set_EndArrowheadWidth, self.Ptr, value.value)
 
     @property
 
     def HyLink(self)->'IHyperLink':
-        """
-
+        """Gets the hyperlink associated with the arc shape.
+        
+        Returns:
+            IHyperLink: An object representing the hyperlink associated with the arc shape.
         """
         GetDllLibXls().XlsArcShape_get_HyLink.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_HyLink.restype=c_void_p
@@ -303,8 +417,10 @@ class XlsArcShape (  XlsPrstGeomShape, IArcShape) :
     @property
 
     def PrstShapeType(self)->'PrstGeomShapeType':
-        """
-
+        """Gets the preset shape type of the arc shape.
+        
+        Returns:
+            PrstGeomShapeType: An enumeration value representing the preset shape type.
         """
         GetDllLibXls().XlsArcShape_get_PrstShapeType.argtypes=[c_void_p]
         GetDllLibXls().XlsArcShape_get_PrstShapeType.restype=c_int