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

spire/xls/PicTile.py

@@ -7,13 +7,21 @@ from ctypes import *
 import abc
 
 class PicTile (SpireObject) :
-    """
-
+    """Represents picture tiling settings for a fill picture in Excel.
+    
+    This class encapsulates the properties that control how a picture is tiled
+    when used as a fill for shapes, cells, or other Excel objects. It allows for configuring
+    the picture's offset and scaling when tiled across an area.
     """
     @property
     def OffsetX(self)->float:
-        """
-
+        """Gets or sets the horizontal offset for the tiled picture.
+        
+        This value represents the horizontal displacement of the picture from its default position
+        when tiled. A value of 0.0 indicates no horizontal offset.
+        
+        Returns:
+            float: The horizontal offset as a decimal value.
         """
         GetDllLibXls().PicTile_get_OffsetX.argtypes=[c_void_p]
         GetDllLibXls().PicTile_get_OffsetX.restype=c_double
@@ -27,8 +35,13 @@ class PicTile (SpireObject) :
 
     @property
     def OffsetY(self)->float:
-        """
-
+        """Gets or sets the vertical offset for the tiled picture.
+        
+        This value represents the vertical displacement of the picture from its default position
+        when tiled. A value of 0.0 indicates no vertical offset.
+        
+        Returns:
+            float: The vertical offset as a decimal value.
         """
         GetDllLibXls().PicTile_get_OffsetY.argtypes=[c_void_p]
         GetDllLibXls().PicTile_get_OffsetY.restype=c_double
@@ -42,8 +55,14 @@ class PicTile (SpireObject) :
 
     @property
     def ScaleX(self)->float:
-        """
-
+        """Gets or sets the horizontal scale factor for the tiled picture.
+        
+        This value determines how the picture is stretched or compressed horizontally when tiled.
+        A value of 1.0 represents 100% (original size). Values greater than 1.0 enlarge
+        the picture, while values less than 1.0 reduce it.
+        
+        Returns:
+            float: The horizontal scale factor as a decimal value.
         """
         GetDllLibXls().PicTile_get_ScaleX.argtypes=[c_void_p]
         GetDllLibXls().PicTile_get_ScaleX.restype=c_double
@@ -57,8 +76,14 @@ class PicTile (SpireObject) :
 
     @property
     def ScaleY(self)->float:
-        """
-
+        """Gets or sets the vertical scale factor for the tiled picture.
+        
+        This value determines how the picture is stretched or compressed vertically when tiled.
+        A value of 1.0 represents 100% (original size). Values greater than 1.0 enlarge
+        the picture, while values less than 1.0 reduce it.
+        
+        Returns:
+            float: The vertical scale factor as a decimal value.
         """
         GetDllLibXls().PicTile_get_ScaleY.argtypes=[c_void_p]
         GetDllLibXls().PicTile_get_ScaleY.restype=c_double

spire/xls/QueryTableXls.py

@@ -7,13 +7,21 @@ from ctypes import *
 import abc
 
 class QueryTableXls (SpireObject) :
-    """
-
+    """Represents a query table in an Excel worksheet.
+    
+    This class encapsulates the properties and methods for managing query tables in Excel.
+    Query tables are used to import data from external data sources such as databases,
+    text files, web pages, or other data sources into an Excel worksheet.
     """
     @property
     def AdjustColumnWidth(self)->bool:
-        """
-
+        """Gets or sets whether column widths are automatically adjusted when refreshing the query table.
+        
+        When set to True, Excel will automatically adjust the column widths to fit the imported data
+        when the query table is refreshed.
+        
+        Returns:
+            bool: True if column widths are automatically adjusted; otherwise, False.
         """
         GetDllLibXls().QueryTableXls_get_AdjustColumnWidth.argtypes=[c_void_p]
         GetDllLibXls().QueryTableXls_get_AdjustColumnWidth.restype=c_bool
@@ -27,8 +35,13 @@ class QueryTableXls (SpireObject) :
 
     @property
     def PreserveFormatting(self)->bool:
-        """
-
+        """Gets or sets whether formatting is preserved when refreshing the query table.
+        
+        When set to True, any manual formatting applied to the query table will be preserved
+        when the query table is refreshed with new data.
+        
+        Returns:
+            bool: True if formatting is preserved during refresh; otherwise, False.
         """
         GetDllLibXls().QueryTableXls_get_PreserveFormatting.argtypes=[c_void_p]
         GetDllLibXls().QueryTableXls_get_PreserveFormatting.restype=c_bool

spire/xls/RTFCommentArray.py

@@ -7,13 +7,21 @@ from ctypes import *
 import abc
 
 class RTFCommentArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
-    """
-
+    """Represents an array of rich text comments in Excel.
+    
+    This class implements the IRichTextString and IOptimizedUpdate interfaces and provides
+    functionality for managing arrays of rich text comments in Excel worksheets.
+    It allows for formatting and manipulating the text content of multiple comments.
     """
 
     def GetFont(self ,iPosition:int)->'IFont':
-        """
-
+        """Gets the font used at the specified character position in the comment text.
+        
+        Args:
+            iPosition (int): The zero-based character position in the text.
+            
+        Returns:
+            IFont: The font object used at the specified position.
         """
         
         GetDllLibXls().RTFCommentArray_GetFont.argtypes=[c_void_p ,c_int]
@@ -25,8 +33,12 @@ class RTFCommentArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
 
 
     def SetFont(self ,iStartPos:int,iEndPos:int,font:'IFont'):
-        """
-
+        """Sets the font for a range of characters in the comment text.
+        
+        Args:
+            iStartPos (int): The zero-based starting character position.
+            iEndPos (int): The zero-based ending character position (inclusive).
+            font (IFont): The font to apply to the specified range of characters.
         """
         intPtrfont:c_void_p = font.Ptr
 
@@ -34,16 +46,21 @@ class RTFCommentArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
         CallCFunction(GetDllLibXls().RTFCommentArray_SetFont, self.Ptr, iStartPos,iEndPos,intPtrfont)
 
     def ClearFormatting(self):
-        """
-
+        """Clears all formatting from the comment text.
+        
+        This method removes all formatting information while preserving the text content,
+        resulting in plain text with default formatting.
         """
         GetDllLibXls().RTFCommentArray_ClearFormatting.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RTFCommentArray_ClearFormatting, self.Ptr)
 
 
     def Append(self ,text:str,font:'IFont'):
-        """
-
+        """Appends text with the specified font to the end of the comment text.
+        
+        Args:
+            text (str): The text to append.
+            font (IFont): The font to apply to the appended text.
         """
         intPtrfont:c_void_p = font.Ptr
 
@@ -51,8 +68,10 @@ class RTFCommentArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
         CallCFunction(GetDllLibXls().RTFCommentArray_Append, self.Ptr, text,intPtrfont)
 
     def Clear(self):
-        """
-
+        """Clears both the text content and formatting of the comments.
+        
+        This method removes all text and formatting information, resulting in empty
+        comment text.
         """
         GetDllLibXls().RTFCommentArray_Clear.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RTFCommentArray_Clear, self.Ptr)
@@ -60,8 +79,13 @@ class RTFCommentArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
     @property
 
     def Text(self)->str:
-        """
-
+        """Gets or sets the plain text content of the comment.
+        
+        When setting this property, any existing formatting is preserved and applied
+        to the new text content where applicable.
+        
+        Returns:
+            str: The plain text content without formatting information.
         """
         GetDllLibXls().RTFCommentArray_get_Text.argtypes=[c_void_p]
         GetDllLibXls().RTFCommentArray_get_Text.restype=c_void_p
@@ -77,8 +101,13 @@ class RTFCommentArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
     @property
 
     def RtfText(self)->str:
-        """
-
+        """Gets the text content in Rich Text Format (RTF).
+        
+        This property returns the text with all formatting information encoded in RTF format,
+        which can be used for interoperability with other applications that support RTF.
+        
+        Returns:
+            str: The text content in RTF format.
         """
         GetDllLibXls().RTFCommentArray_get_RtfText.argtypes=[c_void_p]
         GetDllLibXls().RTFCommentArray_get_RtfText.restype=c_void_p
@@ -88,8 +117,11 @@ class RTFCommentArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
 
     @property
     def IsFormatted(self)->bool:
-        """
-
+        """Gets whether the comment text contains any formatting.
+        
+        Returns:
+            bool: True if the text contains formatting (different fonts, colors, etc.);
+                 otherwise, False.
         """
         GetDllLibXls().RTFCommentArray_get_IsFormatted.argtypes=[c_void_p]
         GetDllLibXls().RTFCommentArray_get_IsFormatted.restype=c_bool
@@ -97,15 +129,20 @@ class RTFCommentArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
         return ret
 
     def BeginUpdate(self):
-        """
-
+        """Begins a batch update operation on the comment array.
+        
+        This method marks the start of a series of changes to the comment array.
+        Multiple changes can be made more efficiently by calling BeginUpdate
+        before making the changes and EndUpdate after all changes are complete.
         """
         GetDllLibXls().RTFCommentArray_BeginUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RTFCommentArray_BeginUpdate, self.Ptr)
 
     def EndUpdate(self):
-        """
-
+        """Ends a batch update operation on the comment array.
+        
+        This method should be called after BeginUpdate and all desired changes
+        have been made. It applies all pending changes to the comment array.
         """
         GetDllLibXls().RTFCommentArray_EndUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RTFCommentArray_EndUpdate, self.Ptr)

spire/xls/RTFStringArray.py

@@ -7,13 +7,21 @@ from ctypes import *
 import abc
 
 class RTFStringArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
-    """
-
+    """Represents an array of rich text strings in Excel.
+    
+    This class implements the IRichTextString and IOptimizedUpdate interfaces and provides
+    functionality for managing arrays of rich text strings in Excel worksheets.
+    It allows for formatting and manipulating the text content of multiple text strings.
     """
 
     def GetFont(self ,iPosition:int)->'IFont':
-        """
-
+        """Gets the font used at the specified character position in the text.
+        
+        Args:
+            iPosition (int): The zero-based character position in the text.
+            
+        Returns:
+            IFont: The font object used at the specified position.
         """
         
         GetDllLibXls().RTFStringArray_GetFont.argtypes=[c_void_p ,c_int]
@@ -25,8 +33,12 @@ class RTFStringArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
 
 
     def SetFont(self ,iStartPos:int,iEndPos:int,font:'IFont'):
-        """
-
+        """Sets the font for a range of characters in the text.
+        
+        Args:
+            iStartPos (int): The zero-based starting character position.
+            iEndPos (int): The zero-based ending character position (inclusive).
+            font (IFont): The font to apply to the specified range of characters.
         """
         intPtrfont:c_void_p = font.Ptr
 
@@ -34,16 +46,21 @@ class RTFStringArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
         CallCFunction(GetDllLibXls().RTFStringArray_SetFont, self.Ptr, iStartPos,iEndPos,intPtrfont)
 
     def ClearFormatting(self):
-        """
-
+        """Clears all formatting from the text strings.
+        
+        This method removes all formatting information while preserving the text content,
+        resulting in plain text with default formatting.
         """
         GetDllLibXls().RTFStringArray_ClearFormatting.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RTFStringArray_ClearFormatting, self.Ptr)
 
 
     def Append(self ,text:str,font:'IFont'):
-        """
-
+        """Appends text with the specified font to the end of the text string array.
+        
+        Args:
+            text (str): The text to append.
+            font (IFont): The font to apply to the appended text.
         """
         intPtrfont:c_void_p = font.Ptr
 
@@ -53,8 +70,13 @@ class RTFStringArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
     @property
 
     def Text(self)->str:
-        """
-
+        """Gets or sets the plain text content of the string array.
+        
+        When setting this property, any existing formatting is preserved and applied
+        to the new text content where applicable.
+        
+        Returns:
+            str: The plain text content without formatting information.
         """
         GetDllLibXls().RTFStringArray_get_Text.argtypes=[c_void_p]
         GetDllLibXls().RTFStringArray_get_Text.restype=c_void_p
@@ -70,8 +92,13 @@ class RTFStringArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
     @property
 
     def RtfText(self)->str:
-        """
-
+        """Gets the text content in Rich Text Format (RTF).
+        
+        This property returns the text with all formatting information encoded in RTF format,
+        which can be used for interoperability with other applications that support RTF.
+        
+        Returns:
+            str: The text content in RTF format.
         """
         GetDllLibXls().RTFStringArray_get_RtfText.argtypes=[c_void_p]
         GetDllLibXls().RTFStringArray_get_RtfText.restype=c_void_p
@@ -81,8 +108,11 @@ class RTFStringArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
 
     @property
     def IsFormatted(self)->bool:
-        """
-
+        """Gets whether the text strings contain any formatting.
+        
+        Returns:
+            bool: True if the text contains formatting (different fonts, colors, etc.);
+                 otherwise, False.
         """
         GetDllLibXls().RTFStringArray_get_IsFormatted.argtypes=[c_void_p]
         GetDllLibXls().RTFStringArray_get_IsFormatted.restype=c_bool
@@ -90,22 +120,29 @@ class RTFStringArray (  XlsObject, IRichTextString, IOptimizedUpdate) :
         return ret
 
     def Clear(self):
-        """
-
+        """Clears both the text content and formatting of the string array.
+        
+        This method removes all text and formatting information, resulting in empty
+        text strings.
         """
         GetDllLibXls().RTFStringArray_Clear.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RTFStringArray_Clear, self.Ptr)
 
     def BeginUpdate(self):
-        """
-<summary></summary>
+        """Begins a batch update operation on the string array.
+        
+        This method marks the start of a series of changes to the string array.
+        Multiple changes can be made more efficiently by calling BeginUpdate
+        before making the changes and EndUpdate after all changes are complete.
         """
         GetDllLibXls().RTFStringArray_BeginUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RTFStringArray_BeginUpdate, self.Ptr)
 
     def EndUpdate(self):
-        """
-<summary></summary>
+        """Ends a batch update operation on the string array.
+        
+        This method should be called after BeginUpdate and all desired changes
+        have been made. It applies all pending changes to the string array.
         """
         GetDllLibXls().RTFStringArray_EndUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RTFStringArray_EndUpdate, self.Ptr)

spire/xls/RangeRichTextString.py

@@ -7,20 +7,27 @@ from ctypes import *
 import abc
 
 class RangeRichTextString (  RichTextString) :
-    """
-
+    """Represents a rich text string in a cell range.
+    
+    This class inherits from RichTextString and provides functionality for working with
+    formatted text in Excel cell ranges. Rich text strings can contain multiple text runs
+    with different formatting applied to different parts of the text.
     """
     def Dispose(self):
-        """
-
+        """Releases all resources used by the RangeRichTextString object.
+        
+        This method performs necessary cleanup operations and should be called
+        when the object is no longer needed.
         """
         GetDllLibXls().RangeRichTextString_Dispose.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RangeRichTextString_Dispose, self.Ptr)
 
     @property
     def Index(self)->int:
-        """
-
+        """Gets the index of this rich text string in the collection.
+        
+        Returns:
+            int: The zero-based index of the rich text string.
         """
         GetDllLibXls().RangeRichTextString_get_Index.argtypes=[c_void_p]
         GetDllLibXls().RangeRichTextString_get_Index.restype=c_int
@@ -30,8 +37,13 @@ class RangeRichTextString (  RichTextString) :
     @property
 
     def DefaultFont(self)->'XlsFont':
-        """
-
+        """Gets the default font for this rich text string.
+        
+        The default font is used for any portion of the text that doesn't have
+        specific formatting applied.
+        
+        Returns:
+            XlsFont: The default font object for the rich text string.
         """
         GetDllLibXls().RangeRichTextString_get_DefaultFont.argtypes=[c_void_p]
         GetDllLibXls().RangeRichTextString_get_DefaultFont.restype=c_void_p

spire/xls/ReferRangeArea.py

@@ -7,13 +7,18 @@ from ctypes import *
 import abc
 
 class ReferRangeArea (SpireObject) :
-    """
-
+    """Represents a referenced range area in an Excel worksheet.
+    
+    This class encapsulates information about a range reference in Excel, including the sheet name,
+    start and end positions of the range, and whether it's an external reference. It is typically
+    used in formulas and named ranges to identify cell ranges.
     """
     @property
     def IsExternalLink(self)->bool:
-        """
-
+        """Gets whether this range reference links to an external workbook.
+        
+        Returns:
+            bool: True if the range reference is to an external workbook; otherwise, False.
         """
         GetDllLibXls().ReferRangeArea_get_IsExternalLink.argtypes=[c_void_p]
         GetDllLibXls().ReferRangeArea_get_IsExternalLink.restype=c_bool
@@ -23,8 +28,10 @@ class ReferRangeArea (SpireObject) :
     @property
 
     def ExternalFileName(self)->str:
-        """
-
+        """Gets the file name of the external workbook when IsExternalLink is True.
+        
+        Returns:
+            str: The file name of the external workbook, or an empty string if not applicable.
         """
         GetDllLibXls().ReferRangeArea_get_ExternalFileName.argtypes=[c_void_p]
         GetDllLibXls().ReferRangeArea_get_ExternalFileName.restype=c_void_p
@@ -35,8 +42,10 @@ class ReferRangeArea (SpireObject) :
     @property
 
     def SheetName(self)->str:
-        """
-
+        """Gets the name of the worksheet containing the referenced range.
+        
+        Returns:
+            str: The name of the worksheet.
         """
         GetDllLibXls().ReferRangeArea_get_SheetName.argtypes=[c_void_p]
         GetDllLibXls().ReferRangeArea_get_SheetName.restype=c_void_p
@@ -46,8 +55,10 @@ class ReferRangeArea (SpireObject) :
 
     @property
     def EndColumn(self)->int:
-        """
-
+        """Gets the ending column index of the referenced range.
+        
+        Returns:
+            int: The zero-based index of the last column in the range.
         """
         GetDllLibXls().ReferRangeArea_get_EndColumn.argtypes=[c_void_p]
         GetDllLibXls().ReferRangeArea_get_EndColumn.restype=c_int
@@ -56,8 +67,10 @@ class ReferRangeArea (SpireObject) :
 
     @property
     def StartColumn(self)->int:
-        """
-
+        """Gets the starting column index of the referenced range.
+        
+        Returns:
+            int: The zero-based index of the first column in the range.
         """
         GetDllLibXls().ReferRangeArea_get_StartColumn.argtypes=[c_void_p]
         GetDllLibXls().ReferRangeArea_get_StartColumn.restype=c_int
@@ -66,8 +79,10 @@ class ReferRangeArea (SpireObject) :
 
     @property
     def EndRow(self)->int:
-        """
-
+        """Gets the ending row index of the referenced range.
+        
+        Returns:
+            int: The zero-based index of the last row in the range.
         """
         GetDllLibXls().ReferRangeArea_get_EndRow.argtypes=[c_void_p]
         GetDllLibXls().ReferRangeArea_get_EndRow.restype=c_int
@@ -76,8 +91,10 @@ class ReferRangeArea (SpireObject) :
 
     @property
     def StartRow(self)->int:
-        """
-
+        """Gets the starting row index of the referenced range.
+        
+        Returns:
+            int: The zero-based index of the first row in the range.
         """
         GetDllLibXls().ReferRangeArea_get_StartRow.argtypes=[c_void_p]
         GetDllLibXls().ReferRangeArea_get_StartRow.restype=c_int
@@ -85,4 +102,10 @@ class ReferRangeArea (SpireObject) :
         return ret
 
 class ListReferRangeAreas (IList[ReferRangeArea]):
+    """Represents a collection of ReferRangeArea objects.
+    
+    This class implements the IList interface for ReferRangeArea objects, providing
+    standard collection functionality for working with multiple range references.
+    It is typically used to manage multiple range references in formulas or named ranges.
+    """
     pass

spire/xls/RichText.py

@@ -19,10 +19,11 @@ class RichText (  RichTextObject) :
 
     def GetFont(self ,position:int)->'ExcelFont':
         """
-    <summary>
         Returns font for character at specified position.
-    </summary>
-    <param name="Position">Position</param>
+
+        Args:
+            Position: Position
+
         """
         
         GetDllLibXls().RichText_GetFont.argtypes=[c_void_p ,c_int]
@@ -35,12 +36,13 @@ class RichText (  RichTextObject) :
 
     def SetFont(self ,startPos:int,endPos:int,font:'ExcelFont'):
         """
-    <summary>
         Sets font for specified range of characters.
-    </summary>
-    <param name="startPos">Position of first character.</param>
-    <param name="endPos">Position of last character.</param>
-    <param name="font">Font to set.</param>
+
+        Args:
+            startPos: Position of first character.
+            endPos: Position of last character.
+            font: Font to set.
+
         """
         intPtrfont:c_void_p = font.Ptr