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

spire/xls/TextSaveOptions.py

@@ -7,15 +7,21 @@ from ctypes import *
 import abc
 
 class TextSaveOptions (SpireObject) :
-    """
-
+    """Options for saving Excel files to text formats.
+    
+    This class provides configuration options for controlling how Excel files
+    are exported to text-based formats such as CSV or TSV. It allows customization
+    of separator characters, encoding, and data inclusion settings.
     """
     @property
     def RetainHiddenData(self)->bool:
-        """
-    <summary>
-        Gets or sets whether retain hidden data. Default is true.
-    </summary>
+        """Gets or sets whether to retain hidden data in the output text file.
+        
+        When set to True, hidden rows, columns, and sheets will be included in the
+        exported text file. Default is True.
+        
+        Returns:
+            bool: True if hidden data should be retained; otherwise, False.
         """
         GetDllLibXls().TextSaveOptions_get_RetainHiddenData.argtypes=[c_void_p]
         GetDllLibXls().TextSaveOptions_get_RetainHiddenData.restype=c_bool
@@ -29,10 +35,13 @@ class TextSaveOptions (SpireObject) :
 
     @property
     def RetainBlankRowsAndCols(self)->bool:
-        """
-    <summary>
-        Gets or sets whether retain blank rows and columns. Default is false.
-    </summary>
+        """Gets or sets whether to retain blank rows and columns in the output text file.
+        
+        When set to True, empty rows and columns will be included in the exported text file.
+        Default is False.
+        
+        Returns:
+            bool: True if blank rows and columns should be retained; otherwise, False.
         """
         GetDllLibXls().TextSaveOptions_get_RetainBlankRowsAndCols.argtypes=[c_void_p]
         GetDllLibXls().TextSaveOptions_get_RetainBlankRowsAndCols.restype=c_bool
@@ -47,10 +56,13 @@ class TextSaveOptions (SpireObject) :
     @property
 
     def Separator(self)->str:
-        """
-    <summary>
-        Gets or sets the separator. Default is ",".
-    </summary>
+        """Gets or sets the separator character for the output text file.
+        
+        This character is used to separate values in the text file.
+        Default is a comma (",").
+        
+        Returns:
+            str: The separator character.
         """
         GetDllLibXls().TextSaveOptions_get_Separator.argtypes=[c_void_p]
         GetDllLibXls().TextSaveOptions_get_Separator.restype=c_void_p
@@ -66,10 +78,13 @@ class TextSaveOptions (SpireObject) :
     @property
 
     def Encoding(self)->'Encoding':
-        """
-    <summary>
-        Gets or sets the encoding. Default is UTF8.
-    </summary>
+        """Gets or sets the character encoding for the output text file.
+        
+        This determines the character encoding used when writing the text file.
+        Default is UTF-8.
+        
+        Returns:
+            Encoding: The character encoding object.
         """
         GetDllLibXls().TextSaveOptions_get_Encoding.argtypes=[c_void_p]
         GetDllLibXls().TextSaveOptions_get_Encoding.restype=c_void_p

spire/xls/TopBottom.py

@@ -7,13 +7,20 @@ from ctypes import *
 import abc
 
 class TopBottom (SpireObject) :
-    """
-
+    """Represents a top/bottom conditional formatting rule in Excel.
+    
+    This class provides functionality for configuring top/bottom conditional formatting
+    rules, which highlight cells with values in the top or bottom N values or N percent
+    of a range. For example, highlighting the top 10 values or bottom 5% of values.
     """
     @property
     def Rank(self)->int:
-        """
-
+        """Gets or sets the rank value for the top/bottom rule.
+        
+        For example, in a "Top 10" rule, the rank would be 10.
+        
+        Returns:
+            int: The rank value.
         """
         GetDllLibXls().TopBottom_get_Rank.argtypes=[c_void_p]
         GetDllLibXls().TopBottom_get_Rank.restype=c_int
@@ -28,8 +35,13 @@ class TopBottom (SpireObject) :
     @property
 
     def Type(self)->'TopBottomType':
-        """
-
+        """Gets or sets the type of the top/bottom rule.
+        
+        Determines whether the rule applies to top or bottom values, and whether
+        it uses a count or percentage.
+        
+        Returns:
+            TopBottomType: The top/bottom rule type.
         """
         GetDllLibXls().TopBottom_get_Type.argtypes=[c_void_p]
         GetDllLibXls().TopBottom_get_Type.restype=c_int

spire/xls/VPageBreak.py

@@ -8,17 +8,15 @@ import abc
 
 class VPageBreak (  XlsVPageBreak) :
     """
-    <summary>
-        Represents a vertical page break.
-    </summary>
+    Represents a vertical page break.
+
     """
     @property
 
     def Location(self)->'CellRange':
         """
-    <summary>
         Returns or sets the cell (a Range object) that defines the page-break location.
-    </summary>
+
         """
         GetDllLibXls().VPageBreak_get_Location.argtypes=[c_void_p]
         GetDllLibXls().VPageBreak_get_Location.restype=c_void_p

spire/xls/Validation.py

@@ -7,16 +7,22 @@ from ctypes import *
 import abc
 
 class Validation (  XlsValidationWrapper) :
-    """
-
+    """Represents data validation settings for a cell or range in Excel.
+    
+    This class extends XlsValidationWrapper and provides functionality for
+    defining and managing data validation rules that restrict the type of data
+    or values that can be entered into cells in Excel worksheets.
     """
     @property
 
     def DataRange(self)->'CellRange':
-        """
-    <summary>
-        Returns data type validation for a range
-    </summary>
+        """Gets or sets the cell range to which the data validation applies.
+        
+        This property specifies the range of cells that will be validated according
+        to the validation rules defined in this object.
+        
+        Returns:
+            CellRange: The cell range object representing the data validation range.
         """
         GetDllLibXls().Validation_get_DataRange.argtypes=[c_void_p]
         GetDllLibXls().Validation_get_DataRange.restype=c_void_p

spire/xls/WebQueryConnection.py

@@ -7,14 +7,20 @@ from ctypes import *
 import abc
 
 class WebQueryConnection (  ExternalConnection) :
-    """
-
+    """Represents a web query connection in Excel.
+    
+    This class extends ExternalConnection and provides functionality for managing
+    web query connections, which allow Excel to retrieve data from web pages.
+    It includes properties for configuring connection settings such as URL,
+    refresh options, and data handling preferences.
     """
     @property
 
     def ID(self)->str:
-        """
-
+        """Gets the unique identifier for the web query connection.
+        
+        Returns:
+            str: The connection ID string.
         """
         GetDllLibXls().WebQueryConnection_get_ID.argtypes=[c_void_p]
         GetDllLibXls().WebQueryConnection_get_ID.restype=c_void_p
@@ -25,8 +31,10 @@ class WebQueryConnection (  ExternalConnection) :
     @property
 
     def Name(self)->str:
-        """
-
+        """Gets or sets the name of the web query connection.
+        
+        Returns:
+            str: The connection name.
         """
         GetDllLibXls().WebQueryConnection_get_Name.argtypes=[c_void_p]
         GetDllLibXls().WebQueryConnection_get_Name.restype=c_void_p
@@ -42,8 +50,10 @@ class WebQueryConnection (  ExternalConnection) :
     @property
 
     def ConnType(self)->'ConnectionDataSourceType':
-        """
-
+        """Gets the data source type for the connection.
+        
+        Returns:
+            ConnectionDataSourceType: The connection data source type.
         """
         GetDllLibXls().WebQueryConnection_get_ConnType.argtypes=[c_void_p]
         GetDllLibXls().WebQueryConnection_get_ConnType.restype=c_int
@@ -53,8 +63,13 @@ class WebQueryConnection (  ExternalConnection) :
 
     @property
     def BackgroundRefresh(self)->bool:
-        """
-
+        """Gets or sets whether data should be refreshed in the background.
+        
+        When set to True, Excel will refresh the data in the background without
+        blocking the user interface.
+        
+        Returns:
+            bool: True if background refresh is enabled; otherwise, False.
         """
         GetDllLibXls().WebQueryConnection_get_BackgroundRefresh.argtypes=[c_void_p]
         GetDllLibXls().WebQueryConnection_get_BackgroundRefresh.restype=c_bool
@@ -69,8 +84,10 @@ class WebQueryConnection (  ExternalConnection) :
     @property
 
     def RefreshedVersion(self)->str:
-        """
-
+        """Gets or sets the version of the connection when it was last refreshed.
+        
+        Returns:
+            str: The version string.
         """
         GetDllLibXls().WebQueryConnection_get_RefreshedVersion.argtypes=[c_void_p]
         GetDllLibXls().WebQueryConnection_get_RefreshedVersion.restype=c_void_p
@@ -85,8 +102,13 @@ class WebQueryConnection (  ExternalConnection) :
 
     @property
     def SaveData(self)->bool:
-        """
-
+        """Gets or sets whether to save the external data with the workbook.
+        
+        When set to True, the data retrieved from the web query will be saved
+        with the workbook.
+        
+        Returns:
+            bool: True if data should be saved with the workbook; otherwise, False.
         """
         GetDllLibXls().WebQueryConnection_get_SaveData.argtypes=[c_void_p]
         GetDllLibXls().WebQueryConnection_get_SaveData.restype=c_bool
@@ -101,8 +123,10 @@ class WebQueryConnection (  ExternalConnection) :
     @property
 
     def OdcFile(self)->str:
-        """
-
+        """Gets or sets the path to the Office Data Connection (ODC) file.
+        
+        Returns:
+            str: The path to the ODC file.
         """
         GetDllLibXls().WebQueryConnection_get_OdcFile.argtypes=[c_void_p]
         GetDllLibXls().WebQueryConnection_get_OdcFile.restype=c_void_p
@@ -117,8 +141,12 @@ class WebQueryConnection (  ExternalConnection) :
 
     @property
     def KeepAlive(self)->bool:
-        """
-
+        """Gets or sets whether to maintain the HTTP connection.
+        
+        When set to True, the HTTP connection will be kept alive between requests.
+        
+        Returns:
+            bool: True if the connection should be kept alive; otherwise, False.
         """
         GetDllLibXls().WebQueryConnection_get_KeepAlive.argtypes=[c_void_p]
         GetDllLibXls().WebQueryConnection_get_KeepAlive.restype=c_bool
@@ -208,8 +236,12 @@ class WebQueryConnection (  ExternalConnection) :
     @property
 
     def Url(self)->str:
-        """
-
+        """Gets or sets the URL for the web query.
+        
+        This is the web address from which data will be retrieved.
+        
+        Returns:
+            str: The URL string.
         """
         GetDllLibXls().WebQueryConnection_get_Url.argtypes=[c_void_p]
         GetDllLibXls().WebQueryConnection_get_Url.restype=c_void_p