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

spire/xls/ExternalConnection.py

@@ -7,14 +7,19 @@ from ctypes import *
 import abc
 
 class ExternalConnection (SpireObject) :
-    """
-
+    """Represents an external connection in an Excel workbook.
+    
+    This class provides properties and methods for managing external connections
+    to data sources, such as databases, web queries, or text files. It allows for
+    configuring connection settings and refresh behavior.
     """
     @property
 
     def ID(self)->str:
-        """
-
+        """Gets the unique identifier of the external connection.
+        
+        Returns:
+            str: The unique identifier of the connection.
         """
         GetDllLibXls().ExternalConnection_get_ID.argtypes=[c_void_p]
         GetDllLibXls().ExternalConnection_get_ID.restype=c_void_p
@@ -25,8 +30,10 @@ class ExternalConnection (SpireObject) :
     @property
 
     def Name(self)->str:
-        """
-
+        """Gets or sets the name of the external connection.
+        
+        Returns:
+            str: The name of the connection.
         """
         GetDllLibXls().ExternalConnection_get_Name.argtypes=[c_void_p]
         GetDllLibXls().ExternalConnection_get_Name.restype=c_void_p
@@ -36,14 +43,21 @@ class ExternalConnection (SpireObject) :
 
     @Name.setter
     def Name(self, value:str):
+        """Sets the name of the external connection.
+        
+        Args:
+            value (str): The name to set for the connection.
+        """
         GetDllLibXls().ExternalConnection_set_Name.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().ExternalConnection_set_Name, self.Ptr, value)
 
     @property
 
     def ConnType(self)->'ConnectionDataSourceType':
-        """
-
+        """Gets the type of the external connection.
+        
+        Returns:
+            ConnectionDataSourceType: An enumeration value representing the connection type.
         """
         GetDllLibXls().ExternalConnection_get_ConnType.argtypes=[c_void_p]
         GetDllLibXls().ExternalConnection_get_ConnType.restype=c_int
@@ -53,8 +67,12 @@ class ExternalConnection (SpireObject) :
 
     @property
     def BackgroundRefresh(self)->bool:
-        """
-
+        """Gets or sets whether data is refreshed in the background.
+        
+        When True, data is refreshed asynchronously without blocking the user interface.
+        
+        Returns:
+            bool: True if background refresh is enabled; False otherwise.
         """
         GetDllLibXls().ExternalConnection_get_BackgroundRefresh.argtypes=[c_void_p]
         GetDllLibXls().ExternalConnection_get_BackgroundRefresh.restype=c_bool
@@ -63,14 +81,21 @@ class ExternalConnection (SpireObject) :
 
     @BackgroundRefresh.setter
     def BackgroundRefresh(self, value:bool):
+        """Sets whether data is refreshed in the background.
+        
+        Args:
+            value (bool): True to enable background refresh; False otherwise.
+        """
         GetDllLibXls().ExternalConnection_set_BackgroundRefresh.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().ExternalConnection_set_BackgroundRefresh, self.Ptr, value)
 
     @property
 
     def RefreshedVersion(self)->str:
-        """
-
+        """Gets or sets the version of the connection when it was last refreshed.
+        
+        Returns:
+            str: The version string of the connection when last refreshed.
         """
         GetDllLibXls().ExternalConnection_get_RefreshedVersion.argtypes=[c_void_p]
         GetDllLibXls().ExternalConnection_get_RefreshedVersion.restype=c_void_p
@@ -80,13 +105,22 @@ class ExternalConnection (SpireObject) :
 
     @RefreshedVersion.setter
     def RefreshedVersion(self, value:str):
+        """Sets the version of the connection when it was last refreshed.
+        
+        Args:
+            value (str): The version string to set.
+        """
         GetDllLibXls().ExternalConnection_set_RefreshedVersion.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().ExternalConnection_set_RefreshedVersion, self.Ptr, value)
 
     @property
     def SaveData(self)->bool:
-        """
-
+        """Gets or sets whether to save the external data with the workbook.
+        
+        When True, the external data is saved with the workbook, allowing offline access.
+        
+        Returns:
+            bool: True if external data is saved with the workbook; False otherwise.
         """
         GetDllLibXls().ExternalConnection_get_SaveData.argtypes=[c_void_p]
         GetDllLibXls().ExternalConnection_get_SaveData.restype=c_bool
@@ -95,14 +129,21 @@ class ExternalConnection (SpireObject) :
 
     @SaveData.setter
     def SaveData(self, value:bool):
+        """Sets whether to save the external data with the workbook.
+        
+        Args:
+            value (bool): True to save external data with the workbook; False otherwise.
+        """
         GetDllLibXls().ExternalConnection_set_SaveData.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().ExternalConnection_set_SaveData, self.Ptr, value)
 
     @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().ExternalConnection_get_OdcFile.argtypes=[c_void_p]
         GetDllLibXls().ExternalConnection_get_OdcFile.restype=c_void_p
@@ -112,13 +153,22 @@ class ExternalConnection (SpireObject) :
 
     @OdcFile.setter
     def OdcFile(self, value:str):
+        """Sets the path to the Office Data Connection (ODC) file.
+        
+        Args:
+            value (str): The path to the ODC file.
+        """
         GetDllLibXls().ExternalConnection_set_OdcFile.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().ExternalConnection_set_OdcFile, self.Ptr, value)
 
     @property
     def KeepAlive(self)->bool:
-        """
-
+        """Gets or sets whether to maintain the connection open.
+        
+        When True, the connection is kept open after refreshing the data.
+        
+        Returns:
+            bool: True if the connection is kept alive; False otherwise.
         """
         GetDllLibXls().ExternalConnection_get_KeepAlive.argtypes=[c_void_p]
         GetDllLibXls().ExternalConnection_get_KeepAlive.restype=c_bool
@@ -127,13 +177,23 @@ class ExternalConnection (SpireObject) :
 
     @KeepAlive.setter
     def KeepAlive(self, value:bool):
+        """Sets whether to maintain the connection open.
+        
+        Args:
+            value (bool): True to keep the connection alive; False otherwise.
+        """
         GetDllLibXls().ExternalConnection_set_KeepAlive.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().ExternalConnection_set_KeepAlive, self.Ptr, value)
 
     @property
     def OnlyUseConnectionFile(self)->bool:
-        """
-
+        """Gets or sets whether to use only the connection file.
+        
+        When True, only the connection file is used for refreshing data,
+        ignoring any connection information stored in the workbook.
+        
+        Returns:
+            bool: True if only the connection file is used; False otherwise.
         """
         GetDllLibXls().ExternalConnection_get_OnlyUseConnectionFile.argtypes=[c_void_p]
         GetDllLibXls().ExternalConnection_get_OnlyUseConnectionFile.restype=c_bool
@@ -142,6 +202,11 @@ class ExternalConnection (SpireObject) :
 
     @OnlyUseConnectionFile.setter
     def OnlyUseConnectionFile(self, value:bool):
+        """Sets whether to use only the connection file.
+        
+        Args:
+            value (bool): True to use only the connection file; False otherwise.
+        """
         GetDllLibXls().ExternalConnection_set_OnlyUseConnectionFile.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().ExternalConnection_set_OnlyUseConnectionFile, self.Ptr, value)
 

spire/xls/ExternalLink.py

@@ -7,14 +7,21 @@ from ctypes import *
 import abc
 
 class ExternalLink (  XlsObject) :
-    """
-
+    """Represents an external link in an Excel workbook.
+    
+    This class provides functionality to manage external links to other workbooks or data sources.
+    External links allow data to be referenced from external sources and updated when the workbook
+    is opened or when links are refreshed.
     """
     @property
 
     def DataSource(self)->str:
-        """
-
+        """Gets or sets the data source path for the external link.
+        
+        The data source typically represents the path to the external workbook or data file.
+        
+        Returns:
+            str: The path to the external data source.
         """
         GetDllLibXls().ExternalLink_get_DataSource.argtypes=[c_void_p]
         GetDllLibXls().ExternalLink_get_DataSource.restype=c_void_p
@@ -29,8 +36,10 @@ class ExternalLink (  XlsObject) :
 
     @property
     def IsReferred(self)->bool:
-        """
-
+        """Gets whether the external link is being referenced by any formulas or other elements.
+        
+        Returns:
+            bool: True if the external link is being referenced; otherwise, False.
         """
         GetDllLibXls().ExternalLink_get_IsReferred.argtypes=[c_void_p]
         GetDllLibXls().ExternalLink_get_IsReferred.restype=c_bool
@@ -39,8 +48,10 @@ class ExternalLink (  XlsObject) :
 
     @property
     def IsVisible(self)->bool:
-        """
-
+        """Gets whether the external link is visible in the workbook.
+        
+        Returns:
+            bool: True if the external link is visible; otherwise, False.
         """
         GetDllLibXls().ExternalLink_get_IsVisible.argtypes=[c_void_p]
         GetDllLibXls().ExternalLink_get_IsVisible.restype=c_bool
@@ -49,8 +60,13 @@ class ExternalLink (  XlsObject) :
 
 
     def AddExternalName(self ,text:str,referTo:str):
-        """
-
+        """Adds an external name to the external link.
+        
+        External names are defined names that reference cells or ranges in external workbooks.
+        
+        Args:
+            text (str): The name of the external reference.
+            referTo (str): The formula or reference that the external name points to.
         """
         
         GetDllLibXls().ExternalLink_AddExternalName.argtypes=[c_void_p ,c_void_p,c_void_p]

spire/xls/FileFormat.py

@@ -7,10 +7,38 @@ from ctypes import *
 import abc
 
 class FileFormat(Enum):
-    """
-    <summary>
-        Represents possible excel versions.
-    </summary>
+    """Represents possible Excel file formats and versions.
+    
+    This enum defines the various file formats that can be used when working with
+    Excel files, including different Excel versions and other export formats like
+    PDF, HTML, etc.
+    
+    Attributes:
+        Xlsb2007: Excel Binary Format for Excel 2007.
+        Xlsb2010: Excel Binary Format for Excel 2010.
+        ODS: OpenDocument Spreadsheet format.
+        CSV: Comma-Separated Values format.
+        XML: XML Spreadsheet format.
+        PDF: Portable Document Format.
+        Bitmap: Bitmap image format.
+        XPS: XML Paper Specification format.
+        HTML: HyperText Markup Language format.
+        Version97to2003: Excel 97-2003 format (.xls).
+        Version2007: Excel 2007 format (.xlsx).
+        Version2010: Excel 2010 format (.xlsx).
+        Version2013: Excel 2013 format (.xlsx).
+        Version2016: Excel 2016 format (.xlsx).
+        PostScript: PostScript document format.
+        OFD: Open Fixed-layout Document format.
+        PCL: Printer Command Language format.
+        Xlsm: Excel Macro-Enabled Workbook format.
+        ET: WPS Spreadsheet format.
+        ETT: WPS Spreadsheet Template format.
+        UOS: Unified Office Format Spreadsheet.
+        XLT: Excel Template format.
+        XLTX: Excel Template format (XML-based).
+        XLTM: Excel Macro-Enabled Template format.
+        Markdown: Markdown text format.
     """
     Xlsb2007 = 0
     Xlsb2010 = 1

spire/xls/Font.py

@@ -7,8 +7,12 @@ from ctypes import *
 import abc
 
 class Font (SpireObject) :
-    """
-
+    """Represents a font for text display in Excel.
+    
+    This class encapsulates the properties and behavior of a font used in Excel documents,
+    including attributes like name, size, style, and other formatting characteristics.
+    It provides methods to manipulate font appearance and convert between different font
+    representations.
     """
 #    @staticmethod
 #
@@ -42,8 +46,10 @@ class Font (SpireObject) :
 
     @property
     def GdiCharSet(self)->int:
-        """
-
+        """Gets the GDI character set of this font.
+        
+        Returns:
+            int: An integer value representing the GDI character set.
         """
         dlllib.Font_get_GdiCharSet.argtypes=[c_void_p]
         dlllib.Font_get_GdiCharSet.restype=c_int
@@ -52,8 +58,10 @@ class Font (SpireObject) :
 
     @property
     def GdiVerticalFont(self)->bool:
-        """
-
+        """Gets a value indicating whether this font is a GDI vertical font.
+        
+        Returns:
+            bool: True if this is a GDI vertical font; otherwise, False.
         """
         dlllib.Font_get_GdiVerticalFont.argtypes=[c_void_p]
         dlllib.Font_get_GdiVerticalFont.restype=c_bool
@@ -62,8 +70,10 @@ class Font (SpireObject) :
 
     @property
     def Italic(self)->bool:
-        """
-
+        """Gets a value indicating whether this font has the italic style applied.
+        
+        Returns:
+            bool: True if this font is italic; otherwise, False.
         """
         dlllib.Font_get_Italic.argtypes=[c_void_p]
         dlllib.Font_get_Italic.restype=c_bool
@@ -85,8 +95,10 @@ class Font (SpireObject) :
     @dispatch
 
     def ToLogFont(self ,logFont:SpireObject):
-        """
-
+        """Fills a LOGFONT structure with the font's data.
+        
+        Args:
+            logFont (SpireObject): The LOGFONT structure to fill with this font's data.
         """
         intPtrlogFont:c_void_p = logFont.Ptr
 
@@ -122,8 +134,10 @@ class Font (SpireObject) :
     @property
 
     def Style(self)->'FontStyle':
-        """
-
+        """Gets the style information for this font.
+        
+        Returns:
+            FontStyle: A FontStyle enumeration value representing the style of this font.
         """
         dlllib.Font_get_Style.argtypes=[c_void_p]
         dlllib.Font_get_Style.restype=c_int
@@ -133,8 +147,10 @@ class Font (SpireObject) :
 
     @property
     def Size(self)->float:
-        """
-
+        """Gets the em-size of this font measured in the current unit.
+        
+        Returns:
+            float: The em-size of this font.
         """
         dlllib.Font_get_Size.argtypes=[c_void_p]
         dlllib.Font_get_Size.restype=c_float
@@ -143,8 +159,10 @@ class Font (SpireObject) :
 
     @property
     def SizeInPoints(self)->float:
-        """
-
+        """Gets the em-size of this font measured in points.
+        
+        Returns:
+            float: The em-size of this font, in points.
         """
         dlllib.Font_get_SizeInPoints.argtypes=[c_void_p]
         dlllib.Font_get_SizeInPoints.restype=c_float
@@ -195,8 +213,13 @@ class Font (SpireObject) :
     @dispatch
 
     def FromLogFont(lf:SpireObject)->'Font':
-        """
-
+        """Creates a Font object from a LOGFONT structure.
+        
+        Args:
+            lf (SpireObject): The LOGFONT structure from which to create the font.
+            
+        Returns:
+            Font: A new Font object based on the specified LOGFONT structure.
         """
         intPtrlf:c_void_p = lf.Ptr
 
@@ -225,8 +248,10 @@ class Font (SpireObject) :
 
 
     def Clone(self)->'SpireObject':
-        """
-
+        """Creates an exact copy of this Font object.
+        
+        Returns:
+            SpireObject: A new Font object that is an exact copy of this Font.
         """
         dlllib.Font_Clone.argtypes=[c_void_p]
         dlllib.Font_Clone.restype=c_void_p
@@ -243,8 +268,10 @@ class Font (SpireObject) :
     #    CallCFunction(dlllib.Font_Dispose,self.Ptr)
 
     def GetHashCode(self)->int:
-        """
-
+        """Returns a hash code for this Font object.
+        
+        Returns:
+            int: An integer value that represents the hash code for this Font.
         """
         dlllib.Font_GetHashCode.argtypes=[c_void_p]
         dlllib.Font_GetHashCode.restype=c_int
@@ -253,8 +280,10 @@ class Font (SpireObject) :
 
     @property
     def Bold(self)->bool:
-        """
-
+        """Gets a value indicating whether this font has the bold style applied.
+        
+        Returns:
+            bool: True if this font is bold; otherwise, False.
         """
         dlllib.Font_get_Bold.argtypes=[c_void_p]
         dlllib.Font_get_Bold.restype=c_bool
@@ -264,8 +293,10 @@ class Font (SpireObject) :
     @property
 
     def Name(self)->str:
-        """
-
+        """Gets the face name of this font.
+        
+        Returns:
+            str: A string that represents the face name of this font.
         """
         dlllib.Font_get_Name.argtypes=[c_void_p]
         dlllib.Font_get_Name.restype=c_void_p
@@ -275,8 +306,10 @@ class Font (SpireObject) :
 
     @property
     def Strikeout(self)->bool:
-        """
-
+        """Gets a value indicating whether this font has the strikeout style applied.
+        
+        Returns:
+            bool: True if this font has the strikeout style applied; otherwise, False.
         """
         dlllib.Font_get_Strikeout.argtypes=[c_void_p]
         dlllib.Font_get_Strikeout.restype=c_bool
@@ -285,8 +318,10 @@ class Font (SpireObject) :
 
     @property
     def Underline(self)->bool:
-        """
-
+        """Gets a value indicating whether this font has the underline style applied.
+        
+        Returns:
+            bool: True if this font is underlined; otherwise, False.
         """
         dlllib.Font_get_Underline.argtypes=[c_void_p]
         dlllib.Font_get_Underline.restype=c_bool
@@ -295,8 +330,13 @@ class Font (SpireObject) :
 
 
     def Equals(self ,obj:'SpireObject')->bool:
-        """
-
+        """Determines whether the specified object is equal to this Font object.
+        
+        Args:
+            obj (SpireObject): The object to compare with the current Font.
+            
+        Returns:
+            bool: True if the specified object is equal to the current Font; otherwise, False.
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -307,8 +347,10 @@ class Font (SpireObject) :
 
 
     def ToString(self)->str:
-        """
-
+        """Returns a string representation of this Font object.
+        
+        Returns:
+            str: A string that represents this Font object.
         """
         dlllib.Font_ToString.argtypes=[c_void_p]
         dlllib.Font_ToString.restype=c_void_p
@@ -332,8 +374,10 @@ class Font (SpireObject) :
 
     @dispatch
     def GetHeight(self)->float:
-        """
-
+        """Gets the height of this font.
+        
+        Returns:
+            float: The height of this font.
         """
         dlllib.Font_GetHeight1.argtypes=[c_void_p]
         dlllib.Font_GetHeight1.restype=c_float
@@ -343,8 +387,13 @@ class Font (SpireObject) :
     @dispatch
 
     def GetHeight(self ,dpi:float)->float:
-        """
-
+        """Gets the height of this font for the specified DPI value.
+        
+        Args:
+            dpi (float): The dots per inch (DPI) value for which to calculate the font height.
+            
+        Returns:
+            float: The height of this font for the specified DPI.
         """
         
         dlllib.Font_GetHeightD.argtypes=[c_void_p ,c_float]
@@ -354,8 +403,10 @@ class Font (SpireObject) :
 
     @property
     def IsSystemFont(self)->bool:
-        """
-
+        """Gets a value indicating whether this font is a system font.
+        
+        Returns:
+            bool: True if this font is a system font; otherwise, False.
         """
         dlllib.Font_get_IsSystemFont.argtypes=[c_void_p]
         dlllib.Font_get_IsSystemFont.restype=c_bool
@@ -365,8 +416,10 @@ class Font (SpireObject) :
     @property
 
     def SystemFontName(self)->str:
-        """
-
+        """Gets the name of the system font that this font is based on.
+        
+        Returns:
+            str: The name of the system font if this font is a system font; otherwise, an empty string.
         """
         dlllib.Font_get_SystemFontName.argtypes=[c_void_p]
         dlllib.Font_get_SystemFontName.restype=c_void_p