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

spire/xls/CellStyleObject.py

@@ -13,9 +13,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def JustifyLast(self)->bool:
         """
-    <summary>
         Represents justify text alignment
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_JustifyLast.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_JustifyLast.restype=c_bool
@@ -31,10 +30,8 @@ class CellStyleObject (  SpireObject, IStyle) :
 
     def NumberFormatLocal(self)->str:
         """
-    <summary>
-        Returns or sets the format code for the object as a string in the
-            language of the user.
-    </summary>
+        Returns or sets the format code for the object as a string in the language of the user.
+
         """
         GetDllLibXls().CellStyleObject_get_NumberFormatLocal.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_NumberFormatLocal.restype=c_void_p
@@ -73,11 +70,12 @@ class CellStyleObject (  SpireObject, IStyle) :
 
     def SetThemeColor(self ,type:'ThemeColorType',tint:float):
         """
-    <summary>
         Set the theme color.
-    </summary>
-    <param name="type">theme color type</param>
-    <param name="tint"></param>
+
+        Args:
+            type: theme color type
+            tint: 
+
         """
         enumtype:c_int = type.value
 
@@ -114,9 +112,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def BuiltIn(self)->bool:
         """
-    <summary>
         True if the style is a built-in style.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_BuiltIn.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_BuiltIn.restype=c_bool
@@ -127,9 +124,8 @@ class CellStyleObject (  SpireObject, IStyle) :
 
     def FillPattern(self)->'ExcelPatternType':
         """
-    <summary>
         Gets or Sets fill pattern type.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_FillPattern.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_FillPattern.restype=c_int
@@ -158,9 +154,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def FormulaHidden(self)->bool:
         """
-    <summary>
         True if the formula will be hidden when the worksheet is protected.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_FormulaHidden.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_FormulaHidden.restype=c_bool
@@ -176,9 +171,8 @@ class CellStyleObject (  SpireObject, IStyle) :
 
     def HorizontalAlignment(self)->'HorizontalAlignType':
         """
-    <summary>
         Returns or sets the horizontal alignment for the specified object.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_HorizontalAlignment.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_HorizontalAlignment.restype=c_int
@@ -194,10 +188,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def IncludeAlignment(self)->bool:
         """
-    <summary>
-        True if the style includes the AddIndent, HorizontalAlignment,
-            VerticalAlignment, WrapText, and Orientation properties.
-    </summary>
+        True if the style includes the AddIndent, HorizontalAlignment, VerticalAlignment, WrapText, and Orientation properties.
+
         """
         GetDllLibXls().CellStyleObject_get_IncludeAlignment.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_IncludeAlignment.restype=c_bool
@@ -212,9 +204,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def IncludeBorder(self)->bool:
         """
-    <summary>
         True if the style includes the Color, KnownColor, LineStyle, and Weight border properties
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_IncludeBorder.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_IncludeBorder.restype=c_bool
@@ -229,9 +220,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def IncludeFont(self)->bool:
         """
-    <summary>
         True if the style includes the Background, Bold, Color, KnownColor, FontStyle, Italic, Name, OutlineFont, Shadow, Size, Strikethrough, Subscript, Superscript, and Underline font properties.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_IncludeFont.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_IncludeFont.restype=c_bool
@@ -246,9 +236,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def IncludeNumberFormat(self)->bool:
         """
-    <summary>
         True if the style includes the NumberFormat property.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_IncludeNumberFormat.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_IncludeNumberFormat.restype=c_bool
@@ -263,11 +252,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def IncludePatterns(self)->bool:
         """
-    <summary>
-        True if the style includes the Color, KnownColor,
-            InvertIfNegative, Pattern, PatternColor, and PatternKnownColor
-            interior properties.
-    </summary>
+        True if the style includes the Color, KnownColor, InvertIfNegative, Pattern, PatternColor, and PatternKnownColor interior properties.
+
         """
         GetDllLibXls().CellStyleObject_get_IncludePatterns.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_IncludePatterns.restype=c_bool
@@ -282,10 +268,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def IncludeProtection(self)->bool:
         """
-    <summary>
-        True if the style includes the FormulaHidden and Locked protection
-            properties.
-    </summary>
+        True if the style includes the FormulaHidden and Locked protection properties.
+
         """
         GetDllLibXls().CellStyleObject_get_IncludeProtection.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_IncludeProtection.restype=c_bool
@@ -300,9 +284,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def IndentLevel(self)->int:
         """
-    <summary>
         Returns or sets the indent level for the style.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_IndentLevel.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_IndentLevel.restype=c_int
@@ -327,9 +310,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def Locked(self)->bool:
         """
-    <summary>
         True if the object is locked; False if the object can be modified when the sheet is protected.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_Locked.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_Locked.restype=c_bool
@@ -345,9 +327,8 @@ class CellStyleObject (  SpireObject, IStyle) :
 
     def Name(self)->str:
         """
-    <summary>
         Returns or sets the name of the object. Read-only String.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_Name.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_Name.restype=c_void_p
@@ -359,9 +340,8 @@ class CellStyleObject (  SpireObject, IStyle) :
 
     def NumberFormat(self)->str:
         """
-    <summary>
         Returns or sets the format code for the object.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_NumberFormat.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_NumberFormat.restype=c_void_p
@@ -377,9 +357,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def NumberFormatIndex(self)->int:
         """
-    <summary>
         Gets or Sets format index.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_NumberFormatIndex.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_NumberFormatIndex.restype=c_int
@@ -407,9 +386,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def Rotation(self)->int:
         """
-    <summary>
         The text orientation. Can be an integer value from 1 to 180 degrees
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_Rotation.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_Rotation.restype=c_int
@@ -424,9 +402,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def ShrinkToFit(self)->bool:
         """
-    <summary>
         True if text automatically shrinks to fit in the available column width.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_ShrinkToFit.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_ShrinkToFit.restype=c_bool
@@ -442,9 +419,8 @@ class CellStyleObject (  SpireObject, IStyle) :
 
     def VerticalAlignment(self)->'VerticalAlignType':
         """
-    <summary>
         Returns or sets the vertical alignment of the specified object.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_VerticalAlignment.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_VerticalAlignment.restype=c_int
@@ -460,9 +436,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def WrapText(self)->bool:
         """
-    <summary>
         True if Microsoft Excel wraps the text in the object.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_WrapText.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_WrapText.restype=c_bool
@@ -478,9 +453,8 @@ class CellStyleObject (  SpireObject, IStyle) :
 
     def ReadingOrder(self)->'ReadingOrderType':
         """
-    <summary>
         Returns or sets the reading order for the specified object.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_ReadingOrder.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_ReadingOrder.restype=c_int
@@ -496,9 +470,8 @@ class CellStyleObject (  SpireObject, IStyle) :
     @property
     def IsFirstSymbolApostrophe(self)->bool:
         """
-    <summary>
         If true then first symbol in cell is apostrophe.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_IsFirstSymbolApostrophe.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_IsFirstSymbolApostrophe.restype=c_bool
@@ -514,9 +487,8 @@ class CellStyleObject (  SpireObject, IStyle) :
 
     def PatternKnownColor(self)->'ExcelColors':
         """
-    <summary>
         Returns or sets the excel color of the interior.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_PatternKnownColor.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_PatternKnownColor.restype=c_int
@@ -533,9 +505,8 @@ class CellStyleObject (  SpireObject, IStyle) :
 
     def PatternColor(self)->'Color':
         """
-    <summary>
         Returns or sets the color of the interior pattern.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_PatternColor.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_PatternColor.restype=c_void_p
@@ -553,9 +524,8 @@ class CellStyleObject (  SpireObject, IStyle) :
 
     def KnownColor(self)->'ExcelColors':
         """
-    <summary>
         Gets or sets the cell shading excel color.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_KnownColor.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_KnownColor.restype=c_int
@@ -572,9 +542,8 @@ class CellStyleObject (  SpireObject, IStyle) :
 
     def Color(self)->'Color':
         """
-    <summary>
         Gets or sets the cell shading color.
-    </summary>
+
         """
         GetDllLibXls().CellStyleObject_get_Color.argtypes=[c_void_p]
         GetDllLibXls().CellStyleObject_get_Color.restype=c_void_p

spire/xls/CellValueChangedEventArgs.py

@@ -14,10 +14,8 @@ class CellValueChangedEventArgs (SpireObject) :
 
     def OldValue(self)->'SpireObject':
         """
-    <summary>
         Gets or sets the old value.
-    </summary>
-<value>The old value.</value>
+
         """
         GetDllLibXls().CellValueChangedEventArgs_get_OldValue.argtypes=[c_void_p]
         GetDllLibXls().CellValueChangedEventArgs_get_OldValue.restype=c_void_p
@@ -35,10 +33,8 @@ class CellValueChangedEventArgs (SpireObject) :
 
     def NewValue(self)->'SpireObject':
         """
-    <summary>
         Gets or sets the new value.
-    </summary>
-<value>The new value.</value>
+
         """
         GetDllLibXls().CellValueChangedEventArgs_get_NewValue.argtypes=[c_void_p]
         GetDllLibXls().CellValueChangedEventArgs_get_NewValue.restype=c_void_p
@@ -56,10 +52,8 @@ class CellValueChangedEventArgs (SpireObject) :
 
     def Range(self)->'IXLSRange':
         """
-    <summary>
         Gets or sets the range.
-    </summary>
-<value>The range.</value>
+
         """
         GetDllLibXls().CellValueChangedEventArgs_get_Range.argtypes=[c_void_p]
         GetDllLibXls().CellValueChangedEventArgs_get_Range.restype=c_void_p

spire/xls/ColorScale.py

@@ -7,35 +7,19 @@ from ctypes import *
 import abc
 
 class ColorScale (SpireObject) :
+    """Represents a color scale conditional formatting rule in an Excel worksheet.
+    
+    This class provides properties and methods for configuring color scale conditional formatting,
+    which changes the color of a cell based on its value relative to other values in the selected range.
+    It allows for defining color gradients with minimum, midpoint, and maximum values and colors.
     """
-    <summary>
-        The color scale condition in the conditional format
-    </summary>
-    """
-#    @property
-#
-#    def Criteria(self)->'IList1':
-#        """
-#    <summary>
-#        Indicates the type, value, and the color
-#            of threshold criteria used in the color scale conditional format.
-#    </summary>
-#        """
-#        GetDllLibXls().ColorScale_get_Criteria.argtypes=[c_void_p]
-#        GetDllLibXls().ColorScale_get_Criteria.restype=c_void_p
-#        intPtr = CallCFunction(GetDllLibXls().ColorScale_get_Criteria, self.Ptr)
-#        ret = None if intPtr==None else IList1(intPtr)
-#        return ret
-#
-
 
     @property
 
     def MaxColor(self)->'Color':
         """
-    <summary>
         Get or set the max value object's corresponding color.
-    </summary>
+
         """
         GetDllLibXls().ColorScale_get_MaxColor.argtypes=[c_void_p]
         GetDllLibXls().ColorScale_get_MaxColor.restype=c_void_p
@@ -53,9 +37,8 @@ class ColorScale (SpireObject) :
 
     def MidColor(self)->'Color':
         """
-    <summary>
         Get or set the mid value object's corresponding color.
-    </summary>
+
         """
         GetDllLibXls().ColorScale_get_MidColor.argtypes=[c_void_p]
         GetDllLibXls().ColorScale_get_MidColor.restype=c_void_p
@@ -73,9 +56,8 @@ class ColorScale (SpireObject) :
 
     def MinColor(self)->'Color':
         """
-    <summary>
         Get or set the min value object's corresponding color.
-    </summary>
+
         """
         GetDllLibXls().ColorScale_get_MinColor.argtypes=[c_void_p]
         GetDllLibXls().ColorScale_get_MinColor.restype=c_void_p
@@ -93,9 +75,8 @@ class ColorScale (SpireObject) :
 
     def MaxValue(self)->'IConditionValue':
         """
-    <summary>
         Get or set this ColorScale's max value object.
-    </summary>
+
         """
         GetDllLibXls().ColorScale_get_MaxValue.argtypes=[c_void_p]
         GetDllLibXls().ColorScale_get_MaxValue.restype=c_void_p
@@ -108,9 +89,8 @@ class ColorScale (SpireObject) :
 
     def MidValue(self)->'IConditionValue':
         """
-    <summary>
         Get or set this ColorScale's mid value object.
-    </summary>
+
         """
         GetDllLibXls().ColorScale_get_MidValue.argtypes=[c_void_p]
         GetDllLibXls().ColorScale_get_MidValue.restype=c_void_p
@@ -123,9 +103,8 @@ class ColorScale (SpireObject) :
 
     def MinValue(self)->'IConditionValue':
         """
-    <summary>
         Get or set this ColorScale's min value object.
-    </summary>
+
         """
         GetDllLibXls().ColorScale_get_MinValue.argtypes=[c_void_p]
         GetDllLibXls().ColorScale_get_MinValue.restype=c_void_p
@@ -137,8 +116,13 @@ class ColorScale (SpireObject) :
     @dispatch
 
     def AddCriteria(self ,item:ColorConditionValue):
-        """
-
+        """Adds a color condition value to the color scale.
+        
+        This method adds a predefined color condition value to the color scale,
+        which includes a condition type, value, and color.
+        
+        Args:
+            item (ColorConditionValue): The color condition value to add.
         """
         intPtritem:c_void_p = item.Ptr
 
@@ -148,8 +132,15 @@ class ColorScale (SpireObject) :
     @dispatch
 
     def AddCriteria(self ,type:ConditionValueType,value:SpireObject,color:Color):
-        """
-
+        """Adds a color condition to the color scale with the specified type, value, and color.
+        
+        This method creates and adds a new color condition to the color scale
+        using the provided condition type, value object, and color.
+        
+        Args:
+            type (ConditionValueType): The type of condition value (e.g., minimum, percent, formula).
+            value (SpireObject): The value object that defines the condition threshold.
+            color (Color): The color to apply when the condition is met.
         """
         enumtype:c_int = type.value
         intPtrvalue:c_void_p = value.Ptr
@@ -161,10 +152,11 @@ class ColorScale (SpireObject) :
 
     def SetConditionCount(self ,count:int):
         """
-    <summary>
         Sets number of objects in the collection.
-    </summary>
-    <param name="count"></param>
+
+        Args:
+            count: 
+
         """
         
         GetDllLibXls().ColorScale_SetConditionCount.argtypes=[c_void_p ,c_int]