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

spire/xls/ConverterSetting.py

@@ -8,9 +8,8 @@ import abc
 
 class ConverterSetting (SpireObject) :
     """
-    <summary>
-        Convert Setting
-    </summary>
+    Convert Setting
+
     """
 #    @PrintPageEventHandler.setter
 #    def PrintPageEventHandler(self, value:'PrintPageEventHandler'):
@@ -33,13 +32,27 @@ class ConverterSetting (SpireObject) :
 #        return ret
 #
 
+    _correct_names = {
+        'xdpi': 'XDpi',
+        'ydpi': 'YDpi',
+    }
+
+    def __setattr__(self, name: str, value):
+        lower_name = name.lower()
+        if lower_name in self._correct_names and name != self._correct_names[lower_name]:
+            correct_name = self._correct_names[lower_name]
+            raise AttributeError(
+                f"'{type(self).__name__}' object has no attribute '{name}'. "
+                f"Did you mean '{correct_name}'?"
+            )
+        else:
+            super().__setattr__(name, value)
 
     @property
     def XDpi(self)->int:
         """
-    <summary>
         Gets or sets the horizontal resolution, in dots per inch (DPI). Default value is 96.
-    </summary>
+
         """
         GetDllLibXls().ConverterSetting_get_XDpi.argtypes=[c_void_p]
         GetDllLibXls().ConverterSetting_get_XDpi.restype=c_int
@@ -54,9 +67,8 @@ class ConverterSetting (SpireObject) :
     @property
     def YDpi(self)->int:
         """
-    <summary>
         Gets or sets the vertical resolution, in dots per inch (DPI). Default value is 96.
-    </summary>
+
         """
         GetDllLibXls().ConverterSetting_get_YDpi.argtypes=[c_void_p]
         GetDllLibXls().ConverterSetting_get_YDpi.restype=c_int
@@ -71,10 +83,8 @@ class ConverterSetting (SpireObject) :
     @property
     def PrintWithSheetPageSetting(self)->bool:
         """
-    <summary>
-        If PrintWithSheetPageSetting = false(Default) . printing all pages with default page settings
-            If PrintWithSheetPageSetting = true . printing each page with its owning sheet's page settings
-    </summary>
+        If PrintWithSheetPageSetting = false(Default) . printing all pages with default page settings If PrintWithSheetPageSetting = true . printing each page with its owning sheet's page settings
+
         """
         GetDllLibXls().ConverterSetting_get_PrintWithSheetPageSetting.argtypes=[c_void_p]
         GetDllLibXls().ConverterSetting_get_PrintWithSheetPageSetting.restype=c_bool
@@ -89,9 +99,8 @@ class ConverterSetting (SpireObject) :
     @property
     def JPEGQuality(self)->int:
         """
-    <summary>
         Gets or sets a value determining the quality.
-    </summary>
+
         """
         GetDllLibXls().ConverterSetting_get_JPEGQuality.argtypes=[c_void_p]
         GetDllLibXls().ConverterSetting_get_JPEGQuality.restype=c_int
@@ -124,10 +133,8 @@ class ConverterSetting (SpireObject) :
     @property
     def IsCellAutoFit(self)->bool:
         """
-    <summary>
-        Indicates whether the width and height of the cells is automatically fitted by cell value. 
-            The default value is false.
-    </summary>
+        Indicates whether the width and height of the cells is automatically fitted by cell value. The default value is false.
+
         """
         GetDllLibXls().ConverterSetting_get_IsCellAutoFit.argtypes=[c_void_p]
         GetDllLibXls().ConverterSetting_get_IsCellAutoFit.restype=c_bool
@@ -142,9 +149,8 @@ class ConverterSetting (SpireObject) :
     @property
     def SheetFitToPage(self)->bool:
         """
-    <summary>
-        One sheet context render to only one page. 
-    </summary>
+        One sheet context render to only one page.
+
         """
         GetDllLibXls().ConverterSetting_get_SheetFitToPage.argtypes=[c_void_p]
         GetDllLibXls().ConverterSetting_get_SheetFitToPage.restype=c_bool
@@ -159,9 +165,8 @@ class ConverterSetting (SpireObject) :
     @property
     def SheetFitToPageRetainPaperSize(self)->bool:
         """
-    <summary>
         Gets or sets a value indicates whether retain paper size when to one sheet context render to only one page.
-    </summary>
+
         """
         GetDllLibXls().ConverterSetting_get_SheetFitToPageRetainPaperSize.argtypes=[c_void_p]
         GetDllLibXls().ConverterSetting_get_SheetFitToPageRetainPaperSize.restype=c_bool
@@ -176,9 +181,8 @@ class ConverterSetting (SpireObject) :
     @property
     def SheetFitToWidth(self)->bool:
         """
-    <summary>
         Sheet content fit to page width.
-    </summary>
+
         """
         GetDllLibXls().ConverterSetting_get_SheetFitToWidth.argtypes=[c_void_p]
         GetDllLibXls().ConverterSetting_get_SheetFitToWidth.restype=c_bool
@@ -208,10 +212,8 @@ class ConverterSetting (SpireObject) :
     @property
     def IgnoreErrorCalculateResult(self)->bool:
         """
-    <summary>
-        Ignore error calculate result when calculating formula.
-            Default is false.
-    </summary>
+        Ignore error calculate result when calculating formula. Default is false.
+
         """
         GetDllLibXls().ConverterSetting_get_IgnoreErrorCalculateResult.argtypes=[c_void_p]
         GetDllLibXls().ConverterSetting_get_IgnoreErrorCalculateResult.restype=c_bool
@@ -242,9 +244,8 @@ class ConverterSetting (SpireObject) :
 
     def PdfConformanceLevel(self)->'PdfConformanceLevel':
         """
-    <summary>
         Gets or sets the Pdf document's Conformance-level.
-    </summary>
+
         """
         GetDllLibXls().ConverterSetting_get_PdfConformanceLevel.argtypes=[c_void_p]
         GetDllLibXls().ConverterSetting_get_PdfConformanceLevel.restype=c_int
@@ -298,9 +299,8 @@ class ConverterSetting (SpireObject) :
     @property
     def IsRegionClip(self)->bool:
         """
-    <summary>
         Enables or disables clipping the image to the region
-    </summary>
+
         """
         GetDllLibXls().ConverterSetting_get_IsRegionClip.argtypes=[c_void_p]
         GetDllLibXls().ConverterSetting_get_IsRegionClip.restype=c_bool
@@ -315,9 +315,8 @@ class ConverterSetting (SpireObject) :
     @property
     def MaxConvertPages(self)->int:
         """
-    <summary>
         Sets or gets the maximum number of pages for the conversion.
-     </summary>
+
         """
         GetDllLibXls().ConverterSetting_get_MaxConvertPages.argtypes=[c_void_p]
         GetDllLibXls().ConverterSetting_get_MaxConvertPages.restype=c_int
@@ -332,9 +331,8 @@ class ConverterSetting (SpireObject) :
     @property
     def ToImageWithoutMargins(self)->bool:
         """
-    <summary>
         To image without margins. Default false.
-    </summary>
+
         """
         GetDllLibXls().ConverterSetting_get_ToImageWithoutMargins.argtypes=[c_void_p]
         GetDllLibXls().ConverterSetting_get_ToImageWithoutMargins.restype=c_bool

spire/xls/DBConnection.py

@@ -7,8 +7,11 @@ from ctypes import *
 import abc
 
 class DBConnection (  ExternalConnection) :
-    """
-
+    """Represents a database connection in an Excel workbook.
+    
+    This class extends ExternalConnection and provides properties and methods for managing
+    connections to database sources, including connection strings, commands, and command types.
+    It allows for configuring database-specific connection settings and refresh behavior.
     """
     @property
 
@@ -148,8 +151,13 @@ class DBConnection (  ExternalConnection) :
     @property
 
     def Connection(self)->str:
-        """
-
+        """Gets or sets the connection string for the database connection.
+        
+        This property contains the connection string that specifies how to connect
+        to the database, including server, database name, authentication details, etc.
+        
+        Returns:
+            str: The connection string for the database.
         """
         GetDllLibXls().DBConnection_get_Connection.argtypes=[c_void_p]
         GetDllLibXls().DBConnection_get_Connection.restype=c_void_p
@@ -159,14 +167,24 @@ class DBConnection (  ExternalConnection) :
 
     @Connection.setter
     def Connection(self, value:str):
+        """Sets the connection string for the database connection.
+        
+        Args:
+            value (str): The connection string to set.
+        """
         GetDllLibXls().DBConnection_set_Connection.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().DBConnection_set_Connection, self.Ptr, value)
 
     @property
 
     def Command(self)->str:
-        """
-
+        """Gets or sets the command text for the database connection.
+        
+        This property contains the SQL query, stored procedure name, or table name
+        that is used to retrieve data from the database.
+        
+        Returns:
+            str: The command text for the database connection.
         """
         GetDllLibXls().DBConnection_get_Command.argtypes=[c_void_p]
         GetDllLibXls().DBConnection_get_Command.restype=c_void_p
@@ -176,14 +194,24 @@ class DBConnection (  ExternalConnection) :
 
     @Command.setter
     def Command(self, value:str):
+        """Sets the command text for the database connection.
+        
+        Args:
+            value (str): The command text to set.
+        """
         GetDllLibXls().DBConnection_set_Command.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().DBConnection_set_Command, self.Ptr, value)
 
     @property
 
     def CommandType(self)->'OLEDBCommandType':
-        """
-
+        """Gets or sets the type of command used in the database connection.
+        
+        This property specifies how the Command property should be interpreted,
+        such as a SQL statement, table name, or stored procedure name.
+        
+        Returns:
+            OLEDBCommandType: An enumeration value representing the command type.
         """
         GetDllLibXls().DBConnection_get_CommandType.argtypes=[c_void_p]
         GetDllLibXls().DBConnection_get_CommandType.restype=c_int
@@ -193,6 +221,11 @@ class DBConnection (  ExternalConnection) :
 
     @CommandType.setter
     def CommandType(self, value:'OLEDBCommandType'):
+        """Sets the type of command used in the database connection.
+        
+        Args:
+            value (OLEDBCommandType): An enumeration value representing the command type to set.
+        """
         GetDllLibXls().DBConnection_set_CommandType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().DBConnection_set_CommandType, self.Ptr, value.value)
 

spire/xls/DVAspect.py

@@ -7,8 +7,14 @@ from ctypes import *
 import abc
 
 class DVAspect(Enum):
-    """
-
+    """Represents the aspects of data that can be viewed in OLE objects.
+    
+    This enumeration defines the various aspects of data that can be viewed
+    when working with OLE (Object Linking and Embedding) objects in Excel.
+    
+    Attributes:
+        DVASPECT_CONTENT: Indicates that the object is displayed as content.
+        DVASPECT_ICON: Indicates that the object is displayed as an icon.
     """
     DVASPECT_CONTENT = 0
     DVASPECT_ICON = 1

spire/xls/DataBar.py

@@ -7,18 +7,19 @@ from ctypes import *
 import abc
 
 class DataBar (SpireObject) :
-    """
-    <summary>
-        Represents a data bar conditional formating rule.
-    </summary>
+    """Represents a data bar conditional formatting rule in an Excel worksheet.
+    
+    This class provides properties and methods for configuring data bar conditional formatting,
+    which displays a colored bar in a cell where the length of the bar represents the value
+    in the cell relative to other values in the selected range. It allows for customizing
+    appearance settings such as colors, borders, axis position, and fill types.
     """
     @property
 
     def MinPoint(self)->'ConditionValue':
         """
-    <summary>
         The shortest bar is evaluated for a data bar conditional format.
-    </summary>
+
         """
         GetDllLibXls().DataBar_get_MinPoint.argtypes=[c_void_p]
         GetDllLibXls().DataBar_get_MinPoint.restype=c_void_p
@@ -31,9 +32,8 @@ class DataBar (SpireObject) :
 
     def MaxPoint(self)->'ConditionValue':
         """
-    <summary>
         The longest bar is evaluated for a data bar conditional format.
-    </summary>
+
         """
         GetDllLibXls().DataBar_get_MaxPoint.argtypes=[c_void_p]
         GetDllLibXls().DataBar_get_MaxPoint.restype=c_void_p
@@ -46,9 +46,8 @@ class DataBar (SpireObject) :
 
     def BarColor(self)->'Color':
         """
-    <summary>
         Gets or sets the color of the bar in a data bar condition format.
-    </summary>
+
         """
         GetDllLibXls().DataBar_get_BarColor.argtypes=[c_void_p]
         GetDllLibXls().DataBar_get_BarColor.restype=c_void_p
@@ -65,9 +64,8 @@ class DataBar (SpireObject) :
     @property
     def PercentMax(self)->int:
         """
-    <summary>
         Gets or sets a value that specifies the length of the longest data bar as a percentage of cell width.
-    </summary>
+
         """
         GetDllLibXls().DataBar_get_PercentMax.argtypes=[c_void_p]
         GetDllLibXls().DataBar_get_PercentMax.restype=c_int
@@ -82,9 +80,8 @@ class DataBar (SpireObject) :
     @property
     def PercentMin(self)->int:
         """
-    <summary>
         Gets or sets a value that specifies the length of the shortest data bar as a percentage of cell width.
-    </summary>
+
         """
         GetDllLibXls().DataBar_get_PercentMin.argtypes=[c_void_p]
         GetDllLibXls().DataBar_get_PercentMin.restype=c_int
@@ -99,9 +96,8 @@ class DataBar (SpireObject) :
     @property
     def ShowValue(self)->bool:
         """
-    <summary>
         Gets or sets a Boolean value that specifies if the value in the cell is displayed.
-    </summary>
+
         """
         GetDllLibXls().DataBar_get_ShowValue.argtypes=[c_void_p]
         GetDllLibXls().DataBar_get_ShowValue.restype=c_bool
@@ -117,9 +113,8 @@ class DataBar (SpireObject) :
 
     def AxisColor(self)->'Color':
         """
-    <summary>
         Gets the color of the axis for cells with conditional formatting as data bars.
-    </summary>
+
         """
         GetDllLibXls().DataBar_get_AxisColor.argtypes=[c_void_p]
         GetDllLibXls().DataBar_get_AxisColor.restype=c_void_p
@@ -137,9 +132,8 @@ class DataBar (SpireObject) :
 
     def AxisPosition(self)->'DataBarAxisPosition':
         """
-    <summary>
         Gets or sets the position of the axis of the data bars specified by a conditional formatting rule.
-    </summary>
+
         """
         GetDllLibXls().DataBar_get_AxisPosition.argtypes=[c_void_p]
         GetDllLibXls().DataBar_get_AxisPosition.restype=c_int
@@ -156,9 +150,8 @@ class DataBar (SpireObject) :
 
     def BarBorder(self)->'DataBarBorder':
         """
-    <summary>
         Gets an object that specifies the border of a data bar.
-    </summary>
+
         """
         GetDllLibXls().DataBar_get_BarBorder.argtypes=[c_void_p]
         GetDllLibXls().DataBar_get_BarBorder.restype=c_void_p
@@ -170,8 +163,13 @@ class DataBar (SpireObject) :
     @property
 
     def BarFillType(self)->'DataBarFillType':
-        """
-
+        """Gets or sets the fill type for the data bar.
+        
+        This property determines how the data bar is filled with color,
+        such as solid fill or gradient fill.
+        
+        Returns:
+            DataBarFillType: An enumeration value representing the fill type of the data bar.
         """
         GetDllLibXls().DataBar_get_BarFillType.argtypes=[c_void_p]
         GetDllLibXls().DataBar_get_BarFillType.restype=c_int
@@ -181,6 +179,11 @@ class DataBar (SpireObject) :
 
     @BarFillType.setter
     def BarFillType(self, value:'DataBarFillType'):
+        """Sets the fill type for the data bar.
+        
+        Args:
+            value (DataBarFillType): An enumeration value representing the fill type to set.
+        """
         GetDllLibXls().DataBar_set_BarFillType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().DataBar_set_BarFillType, self.Ptr, value.value)
 
@@ -188,9 +191,8 @@ class DataBar (SpireObject) :
 
     def Direction(self)->'TextDirectionType':
         """
-    <summary>
         Gets or sets the direction the databar is displayed.
-    </summary>
+
         """
         GetDllLibXls().DataBar_get_Direction.argtypes=[c_void_p]
         GetDllLibXls().DataBar_get_Direction.restype=c_int
@@ -207,9 +209,8 @@ class DataBar (SpireObject) :
 
     def NegativeBarFormat(self)->'NegativeBarFormat':
         """
-    <summary>
         Gets the NegativeBarFormat object associated with a data bar conditional formatting rule.
-    </summary>
+
         """
         GetDllLibXls().DataBar_get_NegativeBarFormat.argtypes=[c_void_p]
         GetDllLibXls().DataBar_get_NegativeBarFormat.restype=c_void_p