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

spire/xls/CellStyle.py

@@ -7,16 +7,19 @@ from ctypes import *
 import abc
 
 class CellStyle (  CellStyleObject) :
-    """
-
+    """Represents a style for cells in an Excel worksheet.
+    
+    This class extends CellStyleObject and provides properties and methods for 
+    defining and manipulating cell styles in Excel worksheets. It allows for accessing
+    and modifying borders, fonts, and interior formatting, as well as cloning styles
+    for reuse across multiple cells or worksheets.
     """
     @property
 
     def Borders(self)->'BordersCollection':
         """
-    <summary>
         Returns a Borders collection that represents the borders of a style.
-    </summary>
+
         """
         GetDllLibXls().CellStyle_get_Borders.argtypes=[c_void_p]
         GetDllLibXls().CellStyle_get_Borders.restype=c_void_p
@@ -29,9 +32,8 @@ class CellStyle (  CellStyleObject) :
 
     def Font(self)->'ExcelFont':
         """
-    <summary>
         Returns a Font object that represents the font of the specified object.
-    </summary>
+
         """
         GetDllLibXls().CellStyle_get_Font.argtypes=[c_void_p]
         GetDllLibXls().CellStyle_get_Font.restype=c_void_p
@@ -44,9 +46,8 @@ class CellStyle (  CellStyleObject) :
 
     def Interior(self)->'ExcelInterior':
         """
-    <summary>
         Returns interior object for extended format.
-    </summary>
+
         """
         GetDllLibXls().CellStyle_get_Interior.argtypes=[c_void_p]
         GetDllLibXls().CellStyle_get_Interior.restype=c_void_p
@@ -58,8 +59,13 @@ class CellStyle (  CellStyleObject) :
     @dispatch
 
     def clone(self)->'CellStyle':
-        """
-
+        """Creates a copy of the current cell style.
+        
+        This method creates a new CellStyle object with the same formatting attributes
+        as the current style.
+        
+        Returns:
+            CellStyle: A new CellStyle object that is a copy of the current style.
         """
         GetDllLibXls().CellStyle_clone.argtypes=[c_void_p]
         GetDllLibXls().CellStyle_clone.restype=c_void_p
@@ -71,8 +77,16 @@ class CellStyle (  CellStyleObject) :
     @dispatch
 
     def clone(self ,book)->'CellStyle':
-        """
-
+        """Creates a copy of the current cell style in the specified workbook.
+        
+        This method creates a new CellStyle object with the same formatting attributes
+        as the current style, but associated with the specified workbook.
+        
+        Args:
+            book: The workbook to create the cloned style in.
+            
+        Returns:
+            CellStyle: A new CellStyle object that is a copy of the current style.
         """
         intPtrbook:c_void_p = book.Ptr
 

spire/xls/CellStyleFlag.py

@@ -7,13 +7,22 @@ from ctypes import *
 import abc
 
 class CellStyleFlag (SpireObject) :
-    """
-
+    """Represents flags that control which aspects of a cell style are applied.
+    
+    This class provides a set of boolean properties that determine which formatting
+    elements of a cell style should be applied when copying styles between cells or
+    when applying styles to ranges. Each property corresponds to a specific formatting
+    aspect such as borders, font properties, alignment, etc.
     """
     @property
     def All(self)->bool:
-        """
-
+        """Gets or sets whether all style elements should be applied.
+        
+        When set to True, all formatting elements of the style will be applied.
+        When set to False, only the specifically enabled elements will be applied.
+        
+        Returns:
+            bool: True if all style elements should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_All.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_All.restype=c_bool
@@ -27,8 +36,13 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def Borders(self)->bool:
-        """
-
+        """Gets or sets whether all border style elements should be applied.
+        
+        When set to True, all border formatting (left, right, top, bottom, and diagonal borders)
+        will be applied.
+        
+        Returns:
+            bool: True if all border style elements should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_Borders.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_Borders.restype=c_bool
@@ -42,8 +56,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def LeftBorder(self)->bool:
-        """
-
+        """Gets or sets whether the left border style should be applied.
+        
+        When set to True, the left border formatting (style, color, etc.) will be applied.
+        
+        Returns:
+            bool: True if the left border style should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_LeftBorder.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_LeftBorder.restype=c_bool
@@ -57,8 +75,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def RightBorder(self)->bool:
-        """
-
+        """Gets or sets whether the right border style should be applied.
+        
+        When set to True, the right border formatting (style, color, etc.) will be applied.
+        
+        Returns:
+            bool: True if the right border style should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_RightBorder.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_RightBorder.restype=c_bool
@@ -72,8 +94,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def TopBorder(self)->bool:
-        """
-
+        """Gets or sets whether the top border style should be applied.
+        
+        When set to True, the top border formatting (style, color, etc.) will be applied.
+        
+        Returns:
+            bool: True if the top border style should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_TopBorder.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_TopBorder.restype=c_bool
@@ -87,8 +113,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def BottomBorder(self)->bool:
-        """
-
+        """Gets or sets whether the bottom border style should be applied.
+        
+        When set to True, the bottom border formatting (style, color, etc.) will be applied.
+        
+        Returns:
+            bool: True if the bottom border style should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_BottomBorder.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_BottomBorder.restype=c_bool
@@ -102,8 +132,13 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def DiagonalDownBorder(self)->bool:
-        """
-
+        """Gets or sets whether the diagonal down border style should be applied.
+        
+        When set to True, the diagonal down border formatting (style, color, etc.) will be applied.
+        Diagonal down borders run from the top-left to the bottom-right of a cell.
+        
+        Returns:
+            bool: True if the diagonal down border style should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_DiagonalDownBorder.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_DiagonalDownBorder.restype=c_bool
@@ -117,8 +152,13 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def DiagonalUpBorder(self)->bool:
-        """
-
+        """Gets or sets whether the diagonal up border style should be applied.
+        
+        When set to True, the diagonal up border formatting (style, color, etc.) will be applied.
+        Diagonal up borders run from the bottom-left to the top-right of a cell.
+        
+        Returns:
+            bool: True if the diagonal up border style should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_DiagonalUpBorder.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_DiagonalUpBorder.restype=c_bool
@@ -132,8 +172,13 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def Font(self)->bool:
-        """
-
+        """Gets or sets whether all font style elements should be applied.
+        
+        When set to True, all font formatting (size, name, color, bold, italic, etc.)
+        will be applied.
+        
+        Returns:
+            bool: True if all font style elements should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_Font.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_Font.restype=c_bool
@@ -147,8 +192,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def FontSize(self)->bool:
-        """
-
+        """Gets or sets whether the font size should be applied.
+        
+        When set to True, the font size formatting will be applied.
+        
+        Returns:
+            bool: True if the font size should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_FontSize.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_FontSize.restype=c_bool
@@ -162,8 +211,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def FontName(self)->bool:
-        """
-
+        """Gets or sets whether the font name should be applied.
+        
+        When set to True, the font name (typeface) formatting will be applied.
+        
+        Returns:
+            bool: True if the font name should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_FontName.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_FontName.restype=c_bool
@@ -177,8 +230,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def FontColor(self)->bool:
-        """
-
+        """Gets or sets whether the font color should be applied.
+        
+        When set to True, the font color formatting will be applied.
+        
+        Returns:
+            bool: True if the font color should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_FontColor.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_FontColor.restype=c_bool
@@ -192,8 +249,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def FontBold(self)->bool:
-        """
-
+        """Gets or sets whether the font bold style should be applied.
+        
+        When set to True, the bold formatting of the font will be applied.
+        
+        Returns:
+            bool: True if the font bold style should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_FontBold.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_FontBold.restype=c_bool
@@ -207,8 +268,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def FontItalic(self)->bool:
-        """
-
+        """Gets or sets whether the font italic style should be applied.
+        
+        When set to True, the italic formatting of the font will be applied.
+        
+        Returns:
+            bool: True if the font italic style should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_FontItalic.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_FontItalic.restype=c_bool
@@ -222,8 +287,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def FontUnderline(self)->bool:
-        """
-
+        """Gets or sets whether the font underline style should be applied.
+        
+        When set to True, the underline formatting of the font will be applied.
+        
+        Returns:
+            bool: True if the font underline style should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_FontUnderline.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_FontUnderline.restype=c_bool
@@ -237,8 +306,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def FontStrike(self)->bool:
-        """
-
+        """Gets or sets whether the font strikethrough style should be applied.
+        
+        When set to True, the strikethrough formatting of the font will be applied.
+        
+        Returns:
+            bool: True if the font strikethrough style should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_FontStrike.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_FontStrike.restype=c_bool
@@ -252,8 +325,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def FontScript(self)->bool:
-        """
-
+        """Gets or sets whether the font script style should be applied.
+        
+        When set to True, the script formatting (superscript or subscript) of the font will be applied.
+        
+        Returns:
+            bool: True if the font script style should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_FontScript.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_FontScript.restype=c_bool
@@ -267,8 +344,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def NumberFormat(self)->bool:
-        """
-
+        """Gets or sets whether the number format should be applied.
+        
+        When set to True, the number format (such as currency, date, percentage, etc.) will be applied.
+        
+        Returns:
+            bool: True if the number format should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_NumberFormat.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_NumberFormat.restype=c_bool
@@ -282,8 +363,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def HorizontalAlignment(self)->bool:
-        """
-
+        """Gets or sets whether the horizontal alignment should be applied.
+        
+        When set to True, the horizontal alignment formatting (left, center, right, etc.) will be applied.
+        
+        Returns:
+            bool: True if the horizontal alignment should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_HorizontalAlignment.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_HorizontalAlignment.restype=c_bool
@@ -297,8 +382,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def VerticalAlignment(self)->bool:
-        """
-
+        """Gets or sets whether the vertical alignment should be applied.
+        
+        When set to True, the vertical alignment formatting (top, middle, bottom, etc.) will be applied.
+        
+        Returns:
+            bool: True if the vertical alignment should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_VerticalAlignment.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_VerticalAlignment.restype=c_bool
@@ -312,8 +401,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def Indent(self)->bool:
-        """
-
+        """Gets or sets whether the text indentation should be applied.
+        
+        When set to True, the text indentation level formatting will be applied.
+        
+        Returns:
+            bool: True if the text indentation should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_Indent.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_Indent.restype=c_bool
@@ -327,8 +420,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def Rotation(self)->bool:
-        """
-
+        """Gets or sets whether the text rotation should be applied.
+        
+        When set to True, the text rotation formatting (angle of text) will be applied.
+        
+        Returns:
+            bool: True if the text rotation should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_Rotation.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_Rotation.restype=c_bool
@@ -342,8 +439,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def WrapText(self)->bool:
-        """
-
+        """Gets or sets whether the text wrapping should be applied.
+        
+        When set to True, the text wrapping formatting (whether text wraps within the cell) will be applied.
+        
+        Returns:
+            bool: True if the text wrapping should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_WrapText.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_WrapText.restype=c_bool
@@ -357,8 +458,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def ShrinkToFit(self)->bool:
-        """
-
+        """Gets or sets whether the shrink to fit formatting should be applied.
+        
+        When set to True, the shrink to fit formatting (whether text should be shrunk to fit in the cell) will be applied.
+        
+        Returns:
+            bool: True if the shrink to fit formatting should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_ShrinkToFit.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_ShrinkToFit.restype=c_bool
@@ -372,8 +477,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def TextDirection(self)->bool:
-        """
-
+        """Gets or sets whether the text direction should be applied.
+        
+        When set to True, the text direction formatting (left-to-right or right-to-left) will be applied.
+        
+        Returns:
+            bool: True if the text direction should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_TextDirection.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_TextDirection.restype=c_bool
@@ -387,8 +496,12 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def CellShading(self)->bool:
-        """
-
+        """Gets or sets whether the cell shading should be applied.
+        
+        When set to True, the cell shading formatting (background color and pattern) will be applied.
+        
+        Returns:
+            bool: True if the cell shading should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_CellShading.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_CellShading.restype=c_bool
@@ -402,8 +515,13 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def Locked(self)->bool:
-        """
-
+        """Gets or sets whether the cell locking should be applied.
+        
+        When set to True, the cell locking formatting (whether the cell is locked when the sheet is protected)
+        will be applied.
+        
+        Returns:
+            bool: True if the cell locking should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_Locked.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_Locked.restype=c_bool
@@ -417,8 +535,13 @@ class CellStyleFlag (SpireObject) :
 
     @property
     def HideFormula(self)->bool:
-        """
-
+        """Gets or sets whether the formula hiding should be applied.
+        
+        When set to True, the formula hiding formatting (whether formulas are hidden when the sheet is protected)
+        will be applied.
+        
+        Returns:
+            bool: True if the formula hiding should be applied; otherwise, False.
         """
         GetDllLibXls().CellStyleFlag_get_HideFormula.argtypes=[c_void_p]
         GetDllLibXls().CellStyleFlag_get_HideFormula.restype=c_bool