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

spire/xls/XlsObject.py

@@ -14,9 +14,8 @@ class XlsObject (  SpireObject, IExcelApplication) :
 
     def Parent(self)->'SpireObject':
         """
-    <summary>
         Reference to Parent object. Read-only.
-    </summary>
+
         """
         GetDllLibXls().XlsObject_get_Parent.argtypes=[c_void_p]
         GetDllLibXls().XlsObject_get_Parent.restype=c_void_p
@@ -27,9 +26,8 @@ class XlsObject (  SpireObject, IExcelApplication) :
 
     def Dispose(self):
         """
-    <summary>
         Dispose object and free resources.
-    </summary>
+
         """
         GetDllLibXls().XlsObject_Dispose.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().XlsObject_Dispose, self.Ptr)

spire/xls/XlsOvalShape.py

@@ -7,14 +7,19 @@ from ctypes import *
 import abc
 
 class XlsOvalShape (  XlsShape, IOvalShape) :
-    """
-
+    """Represents an oval shape in an Excel worksheet.
+    
+    This class provides properties and methods for manipulating oval shapes in Excel,
+    including text settings, alignment, hyperlinks, and other oval-specific functionality.
+    It extends XlsShape and implements the IOvalShape interface.
     """
     @property
 
     def ShapeType(self)->'ExcelShapeType':
-        """
-
+        """Gets the shape type of the oval shape.
+        
+        Returns:
+            ExcelShapeType: An enumeration value representing the shape type of the oval.
         """
         GetDllLibXls().XlsOvalShape_get_ShapeType.argtypes=[c_void_p]
         GetDllLibXls().XlsOvalShape_get_ShapeType.restype=c_int
@@ -25,8 +30,10 @@ class XlsOvalShape (  XlsShape, IOvalShape) :
     @property
 
     def Text(self)->str:
-        """
-
+        """Gets or sets the text displayed in the oval shape.
+        
+        Returns:
+            str: The text displayed in the oval shape.
         """
         GetDllLibXls().XlsOvalShape_get_Text.argtypes=[c_void_p]
         GetDllLibXls().XlsOvalShape_get_Text.restype=c_void_p
@@ -36,13 +43,20 @@ class XlsOvalShape (  XlsShape, IOvalShape) :
 
     @Text.setter
     def Text(self, value:str):
+        """Sets the text displayed in the oval shape.
+        
+        Args:
+            value (str): The text to display in the oval shape.
+        """
         GetDllLibXls().XlsOvalShape_set_Text.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsOvalShape_set_Text, self.Ptr, value)
 
     @property
     def IsTextLocked(self)->bool:
-        """
-
+        """Gets or sets whether the text in the oval shape is locked.
+        
+        Returns:
+            bool: True if the text is locked, False otherwise.
         """
         GetDllLibXls().XlsOvalShape_get_IsTextLocked.argtypes=[c_void_p]
         GetDllLibXls().XlsOvalShape_get_IsTextLocked.restype=c_bool
@@ -51,14 +65,21 @@ class XlsOvalShape (  XlsShape, IOvalShape) :
 
     @IsTextLocked.setter
     def IsTextLocked(self, value:bool):
+        """Sets whether the text in the oval shape is locked.
+        
+        Args:
+            value (bool): True to lock the text, False otherwise.
+        """
         GetDllLibXls().XlsOvalShape_set_IsTextLocked.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsOvalShape_set_IsTextLocked, self.Ptr, value)
 
     @property
 
     def TextRotation(self)->'TextRotationType':
-        """
-
+        """Gets or sets the text rotation in the oval shape.
+        
+        Returns:
+            TextRotationType: An enumeration value representing the text rotation.
         """
         GetDllLibXls().XlsOvalShape_get_TextRotation.argtypes=[c_void_p]
         GetDllLibXls().XlsOvalShape_get_TextRotation.restype=c_int
@@ -68,27 +89,36 @@ class XlsOvalShape (  XlsShape, IOvalShape) :
 
     @TextRotation.setter
     def TextRotation(self, value:'TextRotationType'):
+        """Sets the text rotation in the oval shape.
+        
+        Args:
+            value (TextRotationType): An enumeration value representing the text rotation.
+        """
         GetDllLibXls().XlsOvalShape_set_TextRotation.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsOvalShape_set_TextRotation, self.Ptr, value.value)
 
     @property
 
     def RichText(self)->'IRichTextString':
-        """
-
+        """Gets the rich text formatting for the text in the oval shape.
+        
+        Returns:
+            IRichTextString: An object representing the rich text formatting.
         """
         GetDllLibXls().XlsOvalShape_get_RichText.argtypes=[c_void_p]
         GetDllLibXls().XlsOvalShape_get_RichText.restype=c_void_p
         intPtr = CallCFunction(GetDllLibXls().XlsOvalShape_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 or sets the horizontal alignment of text in the oval shape.
+        
+        Returns:
+            CommentHAlignType: An enumeration value representing the horizontal alignment.
         """
         GetDllLibXls().XlsOvalShape_get_HAlignment.argtypes=[c_void_p]
         GetDllLibXls().XlsOvalShape_get_HAlignment.restype=c_int
@@ -98,14 +128,21 @@ class XlsOvalShape (  XlsShape, IOvalShape) :
 
     @HAlignment.setter
     def HAlignment(self, value:'CommentHAlignType'):
+        """Sets the horizontal alignment of text in the oval shape.
+        
+        Args:
+            value (CommentHAlignType): An enumeration value representing the horizontal alignment.
+        """
         GetDllLibXls().XlsOvalShape_set_HAlignment.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsOvalShape_set_HAlignment, self.Ptr, value.value)
 
     @property
 
     def VAlignment(self)->'CommentVAlignType':
-        """
-
+        """Gets or sets the vertical alignment of text in the oval shape.
+        
+        Returns:
+            CommentVAlignType: An enumeration value representing the vertical alignment.
         """
         GetDllLibXls().XlsOvalShape_get_VAlignment.argtypes=[c_void_p]
         GetDllLibXls().XlsOvalShape_get_VAlignment.restype=c_int
@@ -115,14 +152,21 @@ class XlsOvalShape (  XlsShape, IOvalShape) :
 
     @VAlignment.setter
     def VAlignment(self, value:'CommentVAlignType'):
+        """Sets the vertical alignment of text in the oval shape.
+        
+        Args:
+            value (CommentVAlignType): An enumeration value representing the vertical alignment.
+        """
         GetDllLibXls().XlsOvalShape_set_VAlignment.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsOvalShape_set_VAlignment, self.Ptr, value.value)
 
     @property
 
     def HyLink(self)->'IHyperLink':
-        """
-
+        """Gets the hyperlink associated with the oval shape.
+        
+        Returns:
+            IHyperLink: An object representing the hyperlink associated with the oval shape.
         """
         GetDllLibXls().XlsOvalShape_get_HyLink.argtypes=[c_void_p]
         GetDllLibXls().XlsOvalShape_get_HyLink.restype=c_void_p
@@ -134,8 +178,10 @@ class XlsOvalShape (  XlsShape, IOvalShape) :
     @property
 
     def PrstShapeType(self)->'PrstGeomShapeType':
-        """
-
+        """Gets the preset geometry shape type of the oval shape.
+        
+        Returns:
+            PrstGeomShapeType: An enumeration value representing the preset geometry shape type.
         """
         GetDllLibXls().XlsOvalShape_get_PrstShapeType.argtypes=[c_void_p]
         GetDllLibXls().XlsOvalShape_get_PrstShapeType.restype=c_int
@@ -147,7 +193,10 @@ class XlsOvalShape (  XlsShape, IOvalShape) :
 #
 #    def GeomPaths(self)->'CollectionExtended1':
 #        """
+#        Gets the collection of geometric paths that define the oval shape.
 #
+#        Returns:
+#            CollectionExtended1: A collection of geometric paths.
 #        """
 #        GetDllLibXls().XlsOvalShape_get_GeomPaths.argtypes=[c_void_p]
 #        GetDllLibXls().XlsOvalShape_get_GeomPaths.restype=c_void_p
@@ -160,7 +209,16 @@ class XlsOvalShape (  XlsShape, IOvalShape) :
 #
 #    def Clone(self ,parent:'SpireObject',hashNewNames:'Dictionary2',dicFontIndexes:'Dictionary2',addToCollections:bool)->'IShape':
 #        """
+#        Creates a clone of this oval shape.
+#
+#        Args:
+#            parent (SpireObject): The parent object for the cloned shape.
+#            hashNewNames (Dictionary2): A dictionary of new names.
+#            dicFontIndexes (Dictionary2): A dictionary of font indexes.
+#            addToCollections (bool): Whether to add the cloned shape to collections.
 #
+#        Returns:
+#            IShape: A clone of this oval shape.
 #        """
 #        intPtrparent:c_void_p = parent.Ptr
 #        intPtrhashNewNames:c_void_p = hashNewNames.Ptr

spire/xls/XlsPageSetup.py

@@ -7,13 +7,18 @@ from ctypes import *
 import abc
 
 class XlsPageSetup (  XlsPageSetupBase, IPageSetup) :
-    """
-
+    """Represents the page setup settings for a worksheet in Excel.
+    
+    This class extends XlsPageSetupBase and implements IPageSetup to provide
+    functionality for configuring page layout options such as print area,
+    print titles, gridlines, and other page-related settings.
     """
     @property
     def IsPrintGridlines(self)->bool:
-        """
-
+        """Gets or sets whether gridlines are printed.
+        
+        Returns:
+            bool: True if gridlines are printed; otherwise, False.
         """
         GetDllLibXls().XlsPageSetup_get_IsPrintGridlines.argtypes=[c_void_p]
         GetDllLibXls().XlsPageSetup_get_IsPrintGridlines.restype=c_bool
@@ -27,8 +32,10 @@ class XlsPageSetup (  XlsPageSetupBase, IPageSetup) :
 
     @property
     def IsPrintHeadings(self)->bool:
-        """
-
+        """Gets or sets whether row and column headings are printed.
+        
+        Returns:
+            bool: True if row and column headings are printed; otherwise, False.
         """
         GetDllLibXls().XlsPageSetup_get_IsPrintHeadings.argtypes=[c_void_p]
         GetDllLibXls().XlsPageSetup_get_IsPrintHeadings.restype=c_bool
@@ -43,8 +50,10 @@ class XlsPageSetup (  XlsPageSetupBase, IPageSetup) :
     @property
 
     def PrintArea(self)->str:
-        """
-
+        """Gets or sets the range to print, specified as a string using A1-style references.
+        
+        Returns:
+            str: The print area as an A1-style range reference.
         """
         GetDllLibXls().XlsPageSetup_get_PrintArea.argtypes=[c_void_p]
         GetDllLibXls().XlsPageSetup_get_PrintArea.restype=c_void_p
@@ -60,8 +69,13 @@ class XlsPageSetup (  XlsPageSetupBase, IPageSetup) :
     @property
 
     def PrintTitleColumns(self)->str:
-        """
+        """Gets or sets the columns that contain the cells to be repeated on the left side of each page.
+        Example::
 
+            pageSetup.PrintTitleColumns = "$A:$A"
+
+        Returns:
+            str: The title columns as an A1-style reference.
         """
         GetDllLibXls().XlsPageSetup_get_PrintTitleColumns.argtypes=[c_void_p]
         GetDllLibXls().XlsPageSetup_get_PrintTitleColumns.restype=c_void_p
@@ -77,8 +91,13 @@ class XlsPageSetup (  XlsPageSetupBase, IPageSetup) :
     @property
 
     def PrintTitleRows(self)->str:
-        """
+        """Gets or sets the rows that contain the cells to be repeated at the top of each page.
+        Example::
 
+            pageSetup.PrintTitleRows = "$1:$10"
+
+        Returns:
+            str: The title rows as an A1-style reference.
         """
         GetDllLibXls().XlsPageSetup_get_PrintTitleRows.argtypes=[c_void_p]
         GetDllLibXls().XlsPageSetup_get_PrintTitleRows.restype=c_void_p
@@ -94,10 +113,10 @@ class XlsPageSetup (  XlsPageSetupBase, IPageSetup) :
     @property
 
     def RelationId(self)->str:
-        """
-    <summary>
-        Gets / sets relation id to the printer settings part.
-    </summary>
+        """Gets or sets relation id to the printer settings part.
+        
+        Returns:
+            str: The relation ID for printer settings.
         """
         GetDllLibXls().XlsPageSetup_get_RelationId.argtypes=[c_void_p]
         GetDllLibXls().XlsPageSetup_get_RelationId.restype=c_void_p
@@ -107,8 +126,10 @@ class XlsPageSetup (  XlsPageSetupBase, IPageSetup) :
 
     @property
     def IsSummaryRowBelow(self)->bool:
-        """
-
+        """Gets or sets whether summary rows appear below detail rows in an outline.
+        
+        Returns:
+            bool: True if summary rows appear below detail; otherwise, False.
         """
         GetDllLibXls().XlsPageSetup_get_IsSummaryRowBelow.argtypes=[c_void_p]
         GetDllLibXls().XlsPageSetup_get_IsSummaryRowBelow.restype=c_bool
@@ -122,8 +143,10 @@ class XlsPageSetup (  XlsPageSetupBase, IPageSetup) :
 
     @property
     def IsSummaryColumnRight(self)->bool:
-        """
-
+        """Gets or sets whether summary columns appear to the right of detail columns in an outline.
+        
+        Returns:
+            bool: True if summary columns appear to the right; otherwise, False.
         """
         GetDllLibXls().XlsPageSetup_get_IsSummaryColumnRight.argtypes=[c_void_p]
         GetDllLibXls().XlsPageSetup_get_IsSummaryColumnRight.restype=c_bool
@@ -137,8 +160,10 @@ class XlsPageSetup (  XlsPageSetupBase, IPageSetup) :
 
     @property
     def IsFitToPage(self)->bool:
-        """
-
+        """Gets or sets whether the worksheet is scaled to fit a single page when printed.
+        
+        Returns:
+            bool: True if the worksheet is scaled to fit a page; otherwise, False.
         """
         GetDllLibXls().XlsPageSetup_get_IsFitToPage.argtypes=[c_void_p]
         GetDllLibXls().XlsPageSetup_get_IsFitToPage.restype=c_bool
@@ -152,8 +177,10 @@ class XlsPageSetup (  XlsPageSetupBase, IPageSetup) :
 
     @property
     def NeedDataArray(self)->bool:
-        """
-
+        """Gets whether data array is needed for this page setup.
+        
+        Returns:
+            bool: True if data array is needed; otherwise, False.
         """
         GetDllLibXls().XlsPageSetup_get_NeedDataArray.argtypes=[c_void_p]
         GetDllLibXls().XlsPageSetup_get_NeedDataArray.restype=c_bool
@@ -162,10 +189,10 @@ class XlsPageSetup (  XlsPageSetupBase, IPageSetup) :
 
     @property
     def DefaultRowHeight(self)->int:
-        """
-    <summary>
-        Gets or sets default row height.
-    </summary>
+        """Gets or sets the default row height for the worksheet.
+        
+        Returns:
+            int: The default row height in points.
         """
         GetDllLibXls().XlsPageSetup_get_DefaultRowHeight.argtypes=[c_void_p]
         GetDllLibXls().XlsPageSetup_get_DefaultRowHeight.restype=c_int
@@ -179,8 +206,10 @@ class XlsPageSetup (  XlsPageSetupBase, IPageSetup) :
 
     @property
     def DefaultRowHeightFlag(self)->bool:
-        """
-
+        """Gets or sets whether the default row height is enabled.
+        
+        Returns:
+            bool: True if default row height is enabled; otherwise, False.
         """
         GetDllLibXls().XlsPageSetup_get_DefaultRowHeightFlag.argtypes=[c_void_p]
         GetDllLibXls().XlsPageSetup_get_DefaultRowHeightFlag.restype=c_bool
@@ -194,8 +223,13 @@ class XlsPageSetup (  XlsPageSetupBase, IPageSetup) :
 
 
     def Clone(self ,parent:'SpireObject')->'XlsPageSetup':
-        """
-
+        """Creates a copy of the page setup.
+        
+        Args:
+            parent (SpireObject): The parent object for the cloned page setup.
+            
+        Returns:
+            XlsPageSetup: A new instance of the page setup.
         """
         intPtrparent:c_void_p = parent.Ptr
 
@@ -208,8 +242,13 @@ class XlsPageSetup (  XlsPageSetupBase, IPageSetup) :
 
 
     def GetStoreSize(self ,version:'ExcelVersion')->int:
-        """
-
+        """Gets the storage size required for this page setup with the specified Excel version.
+        
+        Args:
+            version (ExcelVersion): The Excel version to determine storage size for.
+            
+        Returns:
+            int: The storage size in bytes.
         """
         enumversion:c_int = version.value