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

spire/xls/ExcelFont.py

@@ -7,15 +7,18 @@ from ctypes import *
 import abc
 
 class ExcelFont (  SpireObject, IFont) :
-    """
-
+    """Represents a font in an Excel workbook.
+    
+    This class encapsulates the properties and methods for managing font formatting in Excel,
+    including font name, size, style (bold, italic, etc.), color, and other attributes.
+    It implements the IFont interface to provide standard font manipulation functionality.
     """
     @property
     def IsItalic(self)->bool:
-        """
-    <summary>
-        True if the font style is italic. Read / write Boolean.
-    </summary>
+        """Gets or sets whether the font style is italic.
+        
+        Returns:
+            bool: True if the font style is italic; otherwise, False.
         """
         GetDllLibXls().ExcelFont_get_IsItalic.argtypes=[c_void_p]
         GetDllLibXls().ExcelFont_get_IsItalic.restype=c_bool
@@ -30,10 +33,10 @@ class ExcelFont (  SpireObject, IFont) :
     @property
 
     def KnownColor(self)->'ExcelColors':
-        """
-    <summary>
-        Returns or sets the primary excel color of the object.
-    </summary>
+        """Gets or sets the primary Excel color of the font using predefined Excel colors.
+        
+        Returns:
+            ExcelColors: An enumeration value representing the predefined Excel color.
         """
         GetDllLibXls().ExcelFont_get_KnownColor.argtypes=[c_void_p]
         GetDllLibXls().ExcelFont_get_KnownColor.restype=c_int
@@ -49,10 +52,10 @@ class ExcelFont (  SpireObject, IFont) :
     @property
 
     def Color(self)->'Color':
-        """
-    <summary>
-        Returns or sets the primary color of the font.
-    </summary>
+        """Gets or sets the primary color of the font using RGB values.
+        
+        Returns:
+            Color: A Color object representing the RGB color of the font.
         """
         GetDllLibXls().ExcelFont_get_Color.argtypes=[c_void_p]
         GetDllLibXls().ExcelFont_get_Color.restype=c_void_p
@@ -68,12 +71,12 @@ class ExcelFont (  SpireObject, IFont) :
 
 
     def SetThemeColor(self ,type:'ThemeColorType',tint:float):
-        """
-    <summary>
-        Set the theme color.
-    </summary>
-    <param name="type">theme color type</param>
-    <param name="tint"></param>
+        """Sets the theme color for the font.
+        
+        Args:
+            type (ThemeColorType): The theme color type to apply.
+            tint (float): The tint value to apply to the theme color, between -1.0 and 1.0.
+                          Positive values lighten the color, negative values darken it.
         """
         enumtype:c_int = type.value
 
@@ -97,9 +100,8 @@ class ExcelFont (  SpireObject, IFont) :
     @property
     def IsBold(self)->bool:
         """
-    <summary>
         True if the font is bold.
-    </summary>
+
         """
         GetDllLibXls().ExcelFont_get_IsBold.argtypes=[c_void_p]
         GetDllLibXls().ExcelFont_get_IsBold.restype=c_bool
@@ -115,9 +117,8 @@ class ExcelFont (  SpireObject, IFont) :
 
     def FontName(self)->str:
         """
-    <summary>
         Returns or sets the font name. Read / write string.
-    </summary>
+
         """
         GetDllLibXls().ExcelFont_get_FontName.argtypes=[c_void_p]
         GetDllLibXls().ExcelFont_get_FontName.restype=c_void_p
@@ -133,9 +134,8 @@ class ExcelFont (  SpireObject, IFont) :
     @property
     def Size(self)->float:
         """
-    <summary>
         Returns or sets the size of the font. Read / write integer.
-    </summary>
+
         """
         GetDllLibXls().ExcelFont_get_Size.argtypes=[c_void_p]
         GetDllLibXls().ExcelFont_get_Size.restype=c_double
@@ -150,10 +150,8 @@ class ExcelFont (  SpireObject, IFont) :
     @property
     def IsStrikethrough(self)->bool:
         """
-    <summary>
-        True if the font is struck through with a horizontal line.
-            Read / write Boolean
-    </summary>
+        True if the font is struck through with a horizontal line. Read / write Boolean
+
         """
         GetDllLibXls().ExcelFont_get_IsStrikethrough.argtypes=[c_void_p]
         GetDllLibXls().ExcelFont_get_IsStrikethrough.restype=c_bool
@@ -185,10 +183,8 @@ class ExcelFont (  SpireObject, IFont) :
     @property
     def IsSubscript(self)->bool:
         """
-    <summary>
-        True if the font is formatted as subscript.
-            False by default. Read / write Boolean.
-    </summary>
+        True if the font is formatted as subscript. False by default. Read / write Boolean.
+
         """
         GetDllLibXls().ExcelFont_get_IsSubscript.argtypes=[c_void_p]
         GetDllLibXls().ExcelFont_get_IsSubscript.restype=c_bool
@@ -203,10 +199,8 @@ class ExcelFont (  SpireObject, IFont) :
     @property
     def IsSuperscript(self)->bool:
         """
-    <summary>
-        True if the font is formatted as superscript. False by default.
-            Read/write Boolean
-    </summary>
+        True if the font is formatted as superscript. False by default. Read/write Boolean
+
         """
         GetDllLibXls().ExcelFont_get_IsSuperscript.argtypes=[c_void_p]
         GetDllLibXls().ExcelFont_get_IsSuperscript.restype=c_bool
@@ -220,10 +214,13 @@ class ExcelFont (  SpireObject, IFont) :
 
     @property
     def IsAutoColor(self)->bool:
-        """
-    <summary>
-        Indicates whether color is automatically selected. Read-only.
-    </summary>
+        """Gets whether the font color is automatically selected.
+        
+        When True, Excel automatically determines the font color based on the background
+        or other contextual factors.
+        
+        Returns:
+            bool: True if the font color is automatically selected; otherwise, False.
         """
         GetDllLibXls().ExcelFont_get_IsAutoColor.argtypes=[c_void_p]
         GetDllLibXls().ExcelFont_get_IsAutoColor.restype=c_bool
@@ -233,10 +230,13 @@ class ExcelFont (  SpireObject, IFont) :
     @property
 
     def Underline(self)->'FontUnderlineType':
-        """
-    <summary>
-        Returns or sets the type of underline applied to the font. 
-    </summary>
+        """Gets or sets the type of underline applied to the font.
+        
+        This property allows for different underline styles such as single, double,
+        accounting, etc.
+        
+        Returns:
+            FontUnderlineType: An enumeration value representing the underline type.
         """
         GetDllLibXls().ExcelFont_get_Underline.argtypes=[c_void_p]
         GetDllLibXls().ExcelFont_get_Underline.restype=c_int
@@ -252,8 +252,12 @@ class ExcelFont (  SpireObject, IFont) :
     @property
 
     def VerticalAlignment(self)->'FontVertialAlignmentType':
-        """
-
+        """Gets or sets the vertical alignment of the font.
+        
+        This property controls whether text appears as normal, subscript, or superscript.
+        
+        Returns:
+            FontVertialAlignmentType: An enumeration value representing the vertical alignment.
         """
         GetDllLibXls().ExcelFont_get_VerticalAlignment.argtypes=[c_void_p]
         GetDllLibXls().ExcelFont_get_VerticalAlignment.restype=c_int
@@ -268,11 +272,13 @@ class ExcelFont (  SpireObject, IFont) :
 
 
     def GenerateNativeFont(self)->'Font':
-        """
-    <summary>
-        Generates system font object.
-    </summary>
-    <returns>Font object.</returns>
+        """Generates a system font object based on this Excel font.
+        
+        This method creates a Font object that can be used with the system's drawing
+        functions, representing the same visual attributes as this Excel font.
+        
+        Returns:
+            Font: A system Font object with the same properties as this Excel font.
         """
         GetDllLibXls().ExcelFont_GenerateNativeFont.argtypes=[c_void_p]
         GetDllLibXls().ExcelFont_GenerateNativeFont.restype=c_void_p
@@ -284,8 +290,12 @@ class ExcelFont (  SpireObject, IFont) :
     @property
 
     def Parent(self)->'SpireObject':
-        """
-
+        """Gets the parent object of this font.
+        
+        The parent object is typically the cell, range, or style that contains this font.
+        
+        Returns:
+            SpireObject: The parent object that contains this font.
         """
         GetDllLibXls().ExcelFont_get_Parent.argtypes=[c_void_p]
         GetDllLibXls().ExcelFont_get_Parent.restype=c_void_p
@@ -295,15 +305,20 @@ class ExcelFont (  SpireObject, IFont) :
 
 
     def BeginUpdate(self):
-        """
-
+        """Begins a batch update operation on the font.
+        
+        This method marks the start of a series of changes to the font properties.
+        Multiple property changes can be made more efficiently by calling BeginUpdate
+        before making the changes and EndUpdate after all changes are complete.
         """
         GetDllLibXls().ExcelFont_BeginUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().ExcelFont_BeginUpdate, self.Ptr)
 
     def EndUpdate(self):
-        """
-
+        """Ends a batch update operation on the font.
+        
+        This method should be called after BeginUpdate and all desired property
+        changes have been made. It applies all pending changes to the font properties.
         """
         GetDllLibXls().ExcelFont_EndUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().ExcelFont_EndUpdate, self.Ptr)

spire/xls/ExcelGradient.py

@@ -7,14 +7,19 @@ from ctypes import *
 import abc
 
 class ExcelGradient (  SpireObject, IGradient) :
-    """
-
+    """Represents a gradient fill effect in Excel.
+    
+    This class encapsulates the properties and methods for managing gradient fill effects
+    in Excel shapes, cells, and other objects. It provides functionality to set gradient colors,
+    styles, and variants, supporting both two-color and preset gradients.
     """
     @property
 
     def BackColor(self)->'Color':
-        """
-
+        """Gets or sets the ending color of the gradient.
+        
+        Returns:
+            Color: A Color object representing the ending color of the gradient.
         """
         GetDllLibXls().ExcelGradient_get_BackColor.argtypes=[c_void_p]
         GetDllLibXls().ExcelGradient_get_BackColor.restype=c_void_p
@@ -31,8 +36,10 @@ class ExcelGradient (  SpireObject, IGradient) :
     @property
 
     def BackColorObject(self)->'OColor':
-        """
-
+        """Gets the ending color object of the gradient.
+        
+        Returns:
+            OColor: An OColor object representing the ending color of the gradient.
         """
         GetDllLibXls().ExcelGradient_get_BackColorObject.argtypes=[c_void_p]
         GetDllLibXls().ExcelGradient_get_BackColorObject.restype=c_void_p
@@ -44,8 +51,10 @@ class ExcelGradient (  SpireObject, IGradient) :
     @property
 
     def BackKnownColor(self)->'ExcelColors':
-        """
-
+        """Gets or sets the ending color of the gradient using predefined Excel colors.
+        
+        Returns:
+            ExcelColors: An enumeration value representing the predefined Excel color.
         """
         GetDllLibXls().ExcelGradient_get_BackKnownColor.argtypes=[c_void_p]
         GetDllLibXls().ExcelGradient_get_BackKnownColor.restype=c_int
@@ -61,8 +70,10 @@ class ExcelGradient (  SpireObject, IGradient) :
     @property
 
     def ForeColor(self)->'Color':
-        """
-
+        """Gets or sets the starting color of the gradient.
+        
+        Returns:
+            Color: A Color object representing the starting color of the gradient.
         """
         GetDllLibXls().ExcelGradient_get_ForeColor.argtypes=[c_void_p]
         GetDllLibXls().ExcelGradient_get_ForeColor.restype=c_void_p
@@ -79,8 +90,10 @@ class ExcelGradient (  SpireObject, IGradient) :
     @property
 
     def ForeKnownColor(self)->'ExcelColors':
-        """
-
+        """Gets or sets the starting color of the gradient using predefined Excel colors.
+        
+        Returns:
+            ExcelColors: An enumeration value representing the predefined Excel color.
         """
         GetDllLibXls().ExcelGradient_get_ForeKnownColor.argtypes=[c_void_p]
         GetDllLibXls().ExcelGradient_get_ForeKnownColor.restype=c_int
@@ -96,8 +109,10 @@ class ExcelGradient (  SpireObject, IGradient) :
     @property
 
     def ForeColorObject(self)->'OColor':
-        """
-
+        """Gets the starting color object of the gradient.
+        
+        Returns:
+            OColor: An OColor object representing the starting color of the gradient.
         """
         GetDllLibXls().ExcelGradient_get_ForeColorObject.argtypes=[c_void_p]
         GetDllLibXls().ExcelGradient_get_ForeColorObject.restype=c_void_p
@@ -109,8 +124,13 @@ class ExcelGradient (  SpireObject, IGradient) :
     @property
 
     def GradientStyle(self)->'GradientStyleType':
-        """
-
+        """Gets or sets the style of the gradient.
+        
+        The gradient style determines the direction and pattern of the gradient fill,
+        such as horizontal, vertical, diagonal, or radial.
+        
+        Returns:
+            GradientStyleType: An enumeration value representing the gradient style.
         """
         GetDllLibXls().ExcelGradient_get_GradientStyle.argtypes=[c_void_p]
         GetDllLibXls().ExcelGradient_get_GradientStyle.restype=c_int
@@ -126,8 +146,13 @@ class ExcelGradient (  SpireObject, IGradient) :
     @property
 
     def GradientVariant(self)->'GradientVariantsType':
-        """
-
+        """Gets or sets the variant of the gradient.
+        
+        The gradient variant determines the intensity and distribution of colors in the gradient,
+        such as the number of color bands or the smoothness of the transition.
+        
+        Returns:
+            GradientVariantsType: An enumeration value representing the gradient variant.
         """
         GetDllLibXls().ExcelGradient_get_GradientVariant.argtypes=[c_void_p]
         GetDllLibXls().ExcelGradient_get_GradientVariant.restype=c_int
@@ -142,8 +167,19 @@ class ExcelGradient (  SpireObject, IGradient) :
 
 
     def CompareTo(self ,gradient:'IGradient')->int:
-        """
-
+        """Compares this gradient with another gradient object.
+        
+        This method compares the current gradient with the specified gradient object
+        and returns an integer that indicates their relative position in the sort order.
+        
+        Args:
+            gradient (IGradient): The gradient to compare with this instance.
+            
+        Returns:
+            int: A value that indicates the relative order of the objects being compared.
+                 Less than zero: This instance precedes the specified object in the sort order.
+                 Zero: This instance occurs in the same position in the sort order as the specified object.
+                 Greater than zero: This instance follows the specified object in the sort order.
         """
         intPtrgradient:c_void_p = gradient.Ptr
 
@@ -154,8 +190,10 @@ class ExcelGradient (  SpireObject, IGradient) :
 
     @dispatch
     def TwoColorGradient(self):
-        """
-
+        """Creates a two-color gradient with default style and variant.
+        
+        This method configures the gradient to use two colors (the fore color and back color)
+        with default gradient style and variant settings.
         """
         GetDllLibXls().ExcelGradient_TwoColorGradient.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().ExcelGradient_TwoColorGradient, self.Ptr)
@@ -163,8 +201,14 @@ class ExcelGradient (  SpireObject, IGradient) :
     @dispatch
 
     def TwoColorGradient(self ,style:GradientStyleType,variant:GradientVariantsType):
-        """
-
+        """Creates a two-color gradient with the specified style and variant.
+        
+        This method configures the gradient to use two colors (the fore color and back color)
+        with the specified gradient style and variant settings.
+        
+        Args:
+            style (GradientStyleType): The style of the gradient (horizontal, vertical, diagonal, etc.).
+            variant (GradientVariantsType): The variant of the gradient determining color distribution.
         """
         enumstyle:c_int = style.value
         enumvariant:c_int = variant.value

spire/xls/ExcelInterior.py

@@ -7,16 +7,21 @@ from ctypes import *
 import abc
 
 class ExcelInterior (  SpireObject, IInterior) :
-    """
-    <summary>
-        Used to get or set interior settings.
-    </summary>
+    """Used to get or set interior settings for Excel cells and shapes.
+    
+    This class encapsulates the properties and methods for managing the interior formatting
+    of cells and shapes in Excel, including background colors, patterns, and gradient effects.
+    It implements the IInterior interface to provide standard interior formatting functionality.
     """
     @property
 
     def PatternKnownColor(self)->'ExcelColors':
-        """
-
+        """Gets or sets the pattern color using predefined Excel colors.
+        
+        This property determines the color of the pattern applied to the cell or shape interior.
+        
+        Returns:
+            ExcelColors: An enumeration value representing the predefined Excel color for the pattern.
         """
         GetDllLibXls().ExcelInterior_get_PatternKnownColor.argtypes=[c_void_p]
         GetDllLibXls().ExcelInterior_get_PatternKnownColor.restype=c_int
@@ -32,8 +37,12 @@ class ExcelInterior (  SpireObject, IInterior) :
     @property
 
     def PatternColor(self)->'Color':
-        """
-
+        """Gets or sets the pattern color using RGB values.
+        
+        This property determines the color of the pattern applied to the cell or shape interior.
+        
+        Returns:
+            Color: A Color object representing the RGB color of the pattern.
         """
         GetDllLibXls().ExcelInterior_get_PatternColor.argtypes=[c_void_p]
         GetDllLibXls().ExcelInterior_get_PatternColor.restype=c_void_p
@@ -50,8 +59,12 @@ class ExcelInterior (  SpireObject, IInterior) :
     @property
 
     def KnownColor(self)->'ExcelColors':
-        """
-
+        """Gets or sets the background color using predefined Excel colors.
+        
+        This property determines the background color of the cell or shape interior.
+        
+        Returns:
+            ExcelColors: An enumeration value representing the predefined Excel color for the background.
         """
         GetDllLibXls().ExcelInterior_get_KnownColor.argtypes=[c_void_p]
         GetDllLibXls().ExcelInterior_get_KnownColor.restype=c_int
@@ -67,8 +80,12 @@ class ExcelInterior (  SpireObject, IInterior) :
     @property
 
     def Color(self)->'Color':
-        """
-
+        """Gets or sets the background color using RGB values.
+        
+        This property determines the background color of the cell or shape interior.
+        
+        Returns:
+            Color: A Color object representing the RGB color of the background.
         """
         GetDllLibXls().ExcelInterior_get_Color.argtypes=[c_void_p]
         GetDllLibXls().ExcelInterior_get_Color.restype=c_void_p
@@ -85,10 +102,13 @@ class ExcelInterior (  SpireObject, IInterior) :
     @property
 
     def Gradient(self)->'ExcelGradient':
-        """
-    <summary>
-        Returns gradient object for this extended format.
-    </summary>
+        """Gets the gradient object for this interior.
+        
+        The gradient object contains properties for configuring gradient fill effects,
+        including colors, style, and variants.
+        
+        Returns:
+            ExcelGradient: The gradient object for this interior.
         """
         GetDllLibXls().ExcelInterior_get_Gradient.argtypes=[c_void_p]
         GetDllLibXls().ExcelInterior_get_Gradient.restype=c_void_p
@@ -100,8 +120,13 @@ class ExcelInterior (  SpireObject, IInterior) :
     @property
 
     def FillPattern(self)->'ExcelPatternType':
-        """
-
+        """Gets or sets the fill pattern for the interior.
+        
+        This property determines the pattern used to fill the cell or shape interior,
+        such as solid, dotted, striped, etc.
+        
+        Returns:
+            ExcelPatternType: An enumeration value representing the fill pattern type.
         """
         GetDllLibXls().ExcelInterior_get_FillPattern.argtypes=[c_void_p]
         GetDllLibXls().ExcelInterior_get_FillPattern.restype=c_int
@@ -116,8 +141,12 @@ class ExcelInterior (  SpireObject, IInterior) :
 
 
     def m_interior(self)->'IInterior':
-        """
-
+        """Gets the internal IInterior interface implementation.
+        
+        This method is primarily used internally to access the underlying interior object.
+        
+        Returns:
+            IInterior: The internal IInterior interface implementation.
         """
         GetDllLibXls().ExcelInterior_m_interior.argtypes=[c_void_p]
         GetDllLibXls().ExcelInterior_m_interior.restype=c_void_p

spire/xls/ExportTableOptions.py

@@ -7,13 +7,21 @@ from ctypes import *
 import abc
 
 class ExportTableOptions (SpireObject) :
-    """
-
+    """Represents options for exporting Excel tables to other formats.
+    
+    This class provides properties to control the behavior when exporting Excel tables
+    to other formats such as DataTable, CSV, etc. It allows customization of data formatting,
+    column names handling, and formula calculation during the export process.
     """
     @property
     def KeepDataFormat(self)->bool:
-        """
-
+        """Gets or sets whether to keep the original data format when exporting.
+        
+        When set to True, the exported data will maintain the same formatting as in Excel.
+        When set to False, the data may be converted to native types in the target format.
+        
+        Returns:
+            bool: True if the original data format should be kept; otherwise, False.
         """
         GetDllLibXls().ExportTableOptions_get_KeepDataFormat.argtypes=[c_void_p]
         GetDllLibXls().ExportTableOptions_get_KeepDataFormat.restype=c_bool
@@ -27,8 +35,13 @@ class ExportTableOptions (SpireObject) :
 
     @property
     def ExportColumnNames(self)->bool:
-        """
-
+        """Gets or sets whether to export column names when exporting.
+        
+        When set to True, the first row of the exported data will contain column names.
+        When set to False, only the data will be exported without column names.
+        
+        Returns:
+            bool: True if column names should be exported; otherwise, False.
         """
         GetDllLibXls().ExportTableOptions_get_ExportColumnNames.argtypes=[c_void_p]
         GetDllLibXls().ExportTableOptions_get_ExportColumnNames.restype=c_bool
@@ -43,8 +56,13 @@ class ExportTableOptions (SpireObject) :
     @property
 
     def RenameStrategy(self)->'RenameStrategy':
-        """
-
+        """Gets or sets the strategy for renaming columns when exporting.
+        
+        This property determines how column names are handled when there are duplicates or invalid names
+        in the target format.
+        
+        Returns:
+            RenameStrategy: An enumeration value representing the strategy for renaming columns.
         """
         GetDllLibXls().ExportTableOptions_get_RenameStrategy.argtypes=[c_void_p]
         GetDllLibXls().ExportTableOptions_get_RenameStrategy.restype=c_int
@@ -59,8 +77,13 @@ class ExportTableOptions (SpireObject) :
 
     @property
     def ComputedFormulaValue(self)->bool:
-        """
-
+        """Gets or sets whether to export the computed values of formulas.
+        
+        When set to True, the result of formula calculations will be exported.
+        When set to False, the formulas themselves may be exported depending on the target format.
+        
+        Returns:
+            bool: True if computed formula values should be exported; otherwise, False.
         """
         GetDllLibXls().ExportTableOptions_get_ComputedFormulaValue.argtypes=[c_void_p]
         GetDllLibXls().ExportTableOptions_get_ComputedFormulaValue.restype=c_bool