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

spire/xls/AddtionalFormatWrapper.py

@@ -8,13 +8,19 @@ import abc
 
 
 class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtendIndex, IStyle) :
-    """
-
+    """Represents a wrapper for additional formatting in Excel.
+    
+    This class extends CommonWrapper and implements multiple interfaces to provide
+    comprehensive formatting capabilities for Excel worksheets. It serves as a base
+    for various formatting classes and includes properties and methods for managing
+    borders, colors, alignment, fonts, and other formatting aspects.
     """
     @property
     def BuiltIn(self)->bool:
-        """
-
+        """Gets whether the format is a built-in format.
+        
+        Returns:
+            bool: True if the format is a built-in format; False if it is a custom format.
         """
         GetDllLibXls().AddtionalFormatWrapper_get_BuiltIn.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_BuiltIn.restype=c_bool
@@ -24,8 +30,10 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
 
     def Name(self)->str:
-        """
-
+        """Gets the name of the format.
+        
+        Returns:
+            str: The name of the format.
         """
         GetDllLibXls().AddtionalFormatWrapper_get_Name.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_Name.restype=c_void_p
@@ -35,8 +43,10 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     @property
     def IsInitialized(self)->bool:
-        """
-
+        """Gets whether the format has been initialized.
+        
+        Returns:
+            bool: True if the format has been initialized; False otherwise.
         """
         GetDllLibXls().AddtionalFormatWrapper_get_IsInitialized.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_IsInitialized.restype=c_bool
@@ -46,8 +56,10 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
 
     def Parent(self)->'SpireObject':
-        """
-
+        """Gets the parent object of the format.
+        
+        Returns:
+            SpireObject: The parent object that contains this format.
         """
         GetDllLibXls().AddtionalFormatWrapper_get_Parent.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_Parent.restype=c_void_p
@@ -59,8 +71,10 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
 
     def Workbook(self)->'XlsWorkbook':
-        """
-
+        """Gets the workbook that contains this format.
+        
+        Returns:
+            XlsWorkbook: The workbook object that contains this format.
         """
         GetDllLibXls().AddtionalFormatWrapper_get_Workbook.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_Workbook.restype=c_void_p
@@ -73,9 +87,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def BottomBorderColor(self)->'OColor':
         """
-    <summary>
         Gets or sets bottom border color.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_BottomBorderColor.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_BottomBorderColor.restype=c_void_p
@@ -88,9 +101,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def TopBorderColor(self)->'OColor':
         """
-    <summary>
         Gets or sets top border color.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_TopBorderColor.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_TopBorderColor.restype=c_void_p
@@ -103,9 +115,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def LeftBorderColor(self)->'OColor':
         """
-    <summary>
         Gets or sets left border color.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_LeftBorderColor.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_LeftBorderColor.restype=c_void_p
@@ -118,9 +129,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def RightBorderColor(self)->'OColor':
         """
-    <summary>
         Gets or sets right border color.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_RightBorderColor.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_RightBorderColor.restype=c_void_p
@@ -133,9 +143,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def DiagonalBorderColor(self)->'OColor':
         """
-    <summary>
         Gets or sets diagonal border color.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_DiagonalBorderColor.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_DiagonalBorderColor.restype=c_void_p
@@ -148,9 +157,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def LeftBorderLineStyle(self)->'LineStyleType':
         """
-    <summary>
         Gets or sets line style of the left border.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_LeftBorderLineStyle.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_LeftBorderLineStyle.restype=c_int
@@ -167,9 +175,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def RightBorderLineStyle(self)->'LineStyleType':
         """
-    <summary>
         Gets or sets line style of the right border.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_RightBorderLineStyle.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_RightBorderLineStyle.restype=c_int
@@ -186,9 +193,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def TopBorderLineStyle(self)->'LineStyleType':
         """
-    <summary>
         Gets or sets line style of the top border.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_TopBorderLineStyle.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_TopBorderLineStyle.restype=c_int
@@ -205,9 +211,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def BottomBorderLineStyle(self)->'LineStyleType':
         """
-    <summary>
         Gets or sets line style of the bottom border.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_BottomBorderLineStyle.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_BottomBorderLineStyle.restype=c_int
@@ -224,9 +229,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def DiagonalUpBorderLineStyle(self)->'LineStyleType':
         """
-    <summary>
         Gets or sets line style of the diagonal border.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_DiagonalUpBorderLineStyle.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_DiagonalUpBorderLineStyle.restype=c_int
@@ -243,9 +247,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def DiagonalDownBorderLineStyle(self)->'LineStyleType':
         """
-    <summary>
         Gets or sets line style of the diagonal border.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_DiagonalDownBorderLineStyle.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_DiagonalDownBorderLineStyle.restype=c_int
@@ -261,9 +264,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
     def DiagonalUpVisible(self)->bool:
         """
-    <summary>
         Indicates whether DiagonalUp line is visible.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_DiagonalUpVisible.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_DiagonalUpVisible.restype=c_bool
@@ -278,9 +280,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
     def DiagonalDownVisible(self)->bool:
         """
-    <summary>
         Indicates whether diagonal down line is visible.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_DiagonalDownVisible.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_DiagonalDownVisible.restype=c_bool
@@ -296,9 +297,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def FillPattern(self)->'ExcelPatternType':
         """
-    <summary>
         Gets or Sets fill pattern type.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_FillPattern.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_FillPattern.restype=c_int
@@ -314,9 +314,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
     def ExtendedFormatIndex(self)->int:
         """
-    <summary>
         Gets extended format index.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_ExtendedFormatIndex.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_ExtendedFormatIndex.restype=c_int
@@ -327,9 +326,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def BackgroundKnownColor(self)->'ExcelColors':
         """
-    <summary>
         Gets or Sets index of fill background excel color.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_BackgroundKnownColor.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_BackgroundKnownColor.restype=c_int
@@ -346,9 +344,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def BackgroundColor(self)->'Color':
         """
-    <summary>
         Gets or Sets fill background color.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_BackgroundColor.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_BackgroundColor.restype=c_void_p
@@ -364,8 +361,11 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
 
     def SetThemeColor(self ,type:'ThemeColorType',tint:float):
-        """
-
+        """Sets the theme color for the formatting.
+        
+        Args:
+            type (ThemeColorType): The theme color type to set.
+            tint (float): The tint value to apply to the theme color (between -1.0 and 1.0).
         """
         enumtype:c_int = type.value
 
@@ -388,8 +388,11 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
 
     def SetBackgroundThemeColor(self ,type:'ThemeColorType',tint:int):
-        """
-
+        """Sets the background theme color for the formatting.
+        
+        Args:
+            type (ThemeColorType): The theme color type to set for the background.
+            tint (int): The tint value to apply to the theme color.
         """
         enumtype:c_int = type.value
 
@@ -414,9 +417,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def ForegroundKnownColor(self)->'ExcelColors':
         """
-    <summary>
         Gets or Sets fill foreground excel color.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_ForegroundKnownColor.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_ForegroundKnownColor.restype=c_int
@@ -433,9 +435,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def ForegroundColor(self)->'Color':
         """
-    <summary>
         Gets or Sets fill foreground color.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_ForegroundColor.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_ForegroundColor.restype=c_void_p
@@ -452,9 +453,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
     def NumberFormatIndex(self)->int:
         """
-    <summary>
         Gets or Sets format index.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_NumberFormatIndex.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_NumberFormatIndex.restype=c_int
@@ -470,9 +470,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def HorizontalAlignment(self)->'HorizontalAlignType':
         """
-    <summary>
         Returns or sets the horizontal alignment for the specified object.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_HorizontalAlignment.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_HorizontalAlignment.restype=c_int
@@ -488,10 +487,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @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().AddtionalFormatWrapper_get_IncludeAlignment.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_IncludeAlignment.restype=c_bool
@@ -506,9 +503,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
     def IncludeBorder(self)->bool:
         """
-    <summary>
         True if the style includes the Color, KnownColor, LineStyle, and Weight border properties
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_IncludeBorder.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_IncludeBorder.restype=c_bool
@@ -523,9 +519,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @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().AddtionalFormatWrapper_get_IncludeFont.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_IncludeFont.restype=c_bool
@@ -540,9 +535,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
     def IncludeNumberFormat(self)->bool:
         """
-    <summary>
         True if the style includes the NumberFormat property.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_IncludeNumberFormat.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_IncludeNumberFormat.restype=c_bool
@@ -557,11 +551,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @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().AddtionalFormatWrapper_get_IncludePatterns.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_IncludePatterns.restype=c_bool
@@ -576,10 +567,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @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().AddtionalFormatWrapper_get_IncludeProtection.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_IncludeProtection.restype=c_bool
@@ -594,9 +583,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
     def IndentLevel(self)->int:
         """
-    <summary>
         Returns or sets the indent level for the style.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_IndentLevel.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_IndentLevel.restype=c_int
@@ -611,9 +599,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
     def FormulaHidden(self)->bool:
         """
-    <summary>
         True if the formula will be hidden when the worksheet is protected.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_FormulaHidden.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_FormulaHidden.restype=c_bool
@@ -628,9 +615,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @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().AddtionalFormatWrapper_get_Locked.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_Locked.restype=c_bool
@@ -645,9 +631,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
     def JustifyLast(self)->bool:
         """
-    <summary>
         Represents justify text alignment
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_JustifyLast.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_JustifyLast.restype=c_bool
@@ -663,9 +648,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def NumberFormat(self)->str:
         """
-    <summary>
         Returns or sets the format code for the object.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_NumberFormat.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_NumberFormat.restype=c_void_p
@@ -682,10 +666,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     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().AddtionalFormatWrapper_get_NumberFormatLocal.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_NumberFormatLocal.restype=c_void_p
@@ -717,9 +699,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def ReadingOrder(self)->'ReadingOrderType':
         """
-    <summary>
         Returns or sets the reading order for the specified object.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_ReadingOrder.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_ReadingOrder.restype=c_int
@@ -735,9 +716,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
     def Rotation(self)->int:
         """
-    <summary>
         The text orientation. Can be an integer value from 1 to 180 degrees
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_Rotation.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_Rotation.restype=c_int
@@ -752,9 +732,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
     def ShrinkToFit(self)->bool:
         """
-    <summary>
         True if text automatically shrinks to fit in the available column width.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_ShrinkToFit.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_ShrinkToFit.restype=c_bool
@@ -770,9 +749,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def VerticalAlignment(self)->'VerticalAlignType':
         """
-    <summary>
         Returns or sets the vertical alignment of the specified object.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_VerticalAlignment.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_VerticalAlignment.restype=c_int
@@ -788,9 +766,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
     def WrapText(self)->bool:
         """
-    <summary>
         True if Microsoft Excel wraps the text in the object.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_WrapText.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_WrapText.restype=c_bool
@@ -831,9 +808,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
     @property
     def IsFirstSymbolApostrophe(self)->bool:
         """
-    <summary>
         If true then first symbol in cell is apostrophe.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_IsFirstSymbolApostrophe.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_IsFirstSymbolApostrophe.restype=c_bool
@@ -849,9 +825,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def PatternKnownColor(self)->'ExcelColors':
         """
-    <summary>
         Returns or sets the excel color of the interior.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_PatternKnownColor.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_PatternKnownColor.restype=c_int
@@ -868,9 +843,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def PatternColor(self)->'Color':
         """
-    <summary>
         Returns or sets the color of the interior pattern.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_PatternColor.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_PatternColor.restype=c_void_p
@@ -888,9 +862,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def KnownColor(self)->'ExcelColors':
         """
-    <summary>
         Gets or sets the cell shading excel color.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_KnownColor.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_KnownColor.restype=c_int
@@ -907,9 +880,8 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
 
     def Color(self)->'Color':
         """
-    <summary>
         Gets or sets the cell shading color.
-    </summary>
+
         """
         GetDllLibXls().AddtionalFormatWrapper_get_Color.argtypes=[c_void_p]
         GetDllLibXls().AddtionalFormatWrapper_get_Color.restype=c_void_p
@@ -947,23 +919,32 @@ class AddtionalFormatWrapper (  CommonWrapper, IInternalAddtionalFormat, IExtend
         return ret
 
     def BeginUpdate(self):
-        """
-
+        """Begins a batch update operation.
+        
+        This method marks the beginning of a series of changes to the formatting properties.
+        Changes made between BeginUpdate and EndUpdate are applied together for better performance.
         """
         GetDllLibXls().AddtionalFormatWrapper_BeginUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().AddtionalFormatWrapper_BeginUpdate, self.Ptr)
 
     def EndUpdate(self):
-        """
-
+        """Ends a batch update operation.
+        
+        This method completes the batch update started with BeginUpdate and
+        applies all pending changes to the formatting properties.
         """
         GetDllLibXls().AddtionalFormatWrapper_EndUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().AddtionalFormatWrapper_EndUpdate, self.Ptr)
 
 
     def Clone(self ,parent:'SpireObject')->'SpireObject':
-        """
-
+        """Creates a copy of the current formatting with the specified parent.
+        
+        Args:
+            parent (SpireObject): The parent object for the cloned formatting.
+            
+        Returns:
+            SpireObject: A new object that is a copy of this formatting.
         """
         intPtrparent:c_void_p = parent.Ptr
 

spire/xls/Average.py

@@ -7,14 +7,23 @@ from ctypes import *
 import abc
 
 class Average (SpireObject) :
-    """
-
+    """Represents an average calculation in an Excel worksheet.
+    
+    This class provides properties and methods for configuring average calculations
+    in Excel, such as determining the type of average to calculate (e.g., simple average,
+    weighted average, etc.). It extends SpireObject and can be used in various Excel functions
+    and conditional formatting scenarios.
     """
     @property
 
     def Type(self)->'AverageType':
-        """
-
+        """Gets or sets the type of average calculation to perform.
+        
+        This property specifies which averaging method should be used when
+        calculating the average value.
+        
+        Returns:
+            AverageType: An enumeration value representing the type of average calculation.
         """
         GetDllLibXls().Average_get_Type.argtypes=[c_void_p]
         GetDllLibXls().Average_get_Type.restype=c_int
@@ -24,6 +33,11 @@ class Average (SpireObject) :
 
     @Type.setter
     def Type(self, value:'AverageType'):
+        """Sets the type of average calculation to perform.
+        
+        Args:
+            value (AverageType): An enumeration value representing the type of average calculation.
+        """
         GetDllLibXls().Average_set_Type.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().Average_set_Type, self.Ptr, value.value)
 

spire/xls/CellBaseStyle.py

@@ -7,19 +7,26 @@ from ctypes import *
 import abc
 
 class CellBaseStyle (  AddtionalFormatWrapper, IInternalAddtionalFormat) :
-    """
-
+    """Represents the base class for cell styles in an Excel worksheet.
+    
+    This class extends AddtionalFormatWrapper and implements IInternalAddtionalFormat,
+    providing basic functionality for cell formatting and styling. It serves as a base
+    for more specific cell style classes and includes methods for managing style updates.
     """
     def BeginUpdate(self):
-        """
-
+        """Begins a batch update operation on the cell style.
+        
+        This method marks the beginning of a series of changes to the style properties.
+        Changes made between BeginUpdate and EndUpdate are applied together for better performance.
         """
         GetDllLibXls().CellBaseStyle_BeginUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().CellBaseStyle_BeginUpdate, self.Ptr)
 
     def EndUpdate(self):
-        """
-
+        """Ends a batch update operation on the cell style.
+        
+        This method completes the batch update started with BeginUpdate and
+        applies all pending changes to the style properties.
         """
         GetDllLibXls().CellBaseStyle_EndUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().CellBaseStyle_EndUpdate, self.Ptr)