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

spire/xls/XlsFill.py

@@ -7,14 +7,19 @@ from ctypes import *
 import abc
 
 class XlsFill (SpireObject) :
-    """
-
+    """Represents a fill formatting in an Excel worksheet.
+    
+    This class provides properties and methods for manipulating fill formatting in Excel,
+    including patterns, colors, and gradient effects. It extends SpireObject and can be used
+    to create and modify cell and shape fills.
     """
     @property
 
     def OColor(self)->'OColor':
-        """
-
+        """Gets the Office color of the fill.
+        
+        Returns:
+            OColor: An object representing the Office color of the fill.
         """
         GetDllLibXls().XlsFill_get_OColor.argtypes=[c_void_p]
         GetDllLibXls().XlsFill_get_OColor.restype=c_void_p
@@ -26,8 +31,10 @@ class XlsFill (SpireObject) :
     @property
 
     def PatternColorObject(self)->'OColor':
-        """
-
+        """Gets the pattern color object of the fill.
+        
+        Returns:
+            OColor: An object representing the pattern color of the fill.
         """
         GetDllLibXls().XlsFill_get_PatternColorObject.argtypes=[c_void_p]
         GetDllLibXls().XlsFill_get_PatternColorObject.restype=c_void_p
@@ -39,8 +46,10 @@ class XlsFill (SpireObject) :
     @property
 
     def Pattern(self)->'ExcelPatternType':
-        """
-
+        """Gets or sets the pattern type of the fill.
+        
+        Returns:
+            ExcelPatternType: An enumeration value representing the pattern type.
         """
         GetDllLibXls().XlsFill_get_Pattern.argtypes=[c_void_p]
         GetDllLibXls().XlsFill_get_Pattern.restype=c_int
@@ -50,14 +59,21 @@ class XlsFill (SpireObject) :
 
     @Pattern.setter
     def Pattern(self, value:'ExcelPatternType'):
+        """Sets the pattern type of the fill.
+        
+        Args:
+            value (ExcelPatternType): An enumeration value representing the pattern type.
+        """
         GetDllLibXls().XlsFill_set_Pattern.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsFill_set_Pattern, self.Ptr, value.value)
 
     @property
 
     def GradientStyle(self)->'GradientStyleType':
-        """
-
+        """Gets or sets the gradient style of the fill.
+        
+        Returns:
+            GradientStyleType: An enumeration value representing the gradient style.
         """
         GetDllLibXls().XlsFill_get_GradientStyle.argtypes=[c_void_p]
         GetDllLibXls().XlsFill_get_GradientStyle.restype=c_int
@@ -67,14 +83,21 @@ class XlsFill (SpireObject) :
 
     @GradientStyle.setter
     def GradientStyle(self, value:'GradientStyleType'):
+        """Sets the gradient style of the fill.
+        
+        Args:
+            value (GradientStyleType): An enumeration value representing the gradient style.
+        """
         GetDllLibXls().XlsFill_set_GradientStyle.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsFill_set_GradientStyle, self.Ptr, value.value)
 
     @property
 
     def GradientVariant(self)->'GradientVariantsType':
-        """
-
+        """Gets or sets the gradient variant of the fill.
+        
+        Returns:
+            GradientVariantsType: An enumeration value representing the gradient variant.
         """
         GetDllLibXls().XlsFill_get_GradientVariant.argtypes=[c_void_p]
         GetDllLibXls().XlsFill_get_GradientVariant.restype=c_int
@@ -84,14 +107,21 @@ class XlsFill (SpireObject) :
 
     @GradientVariant.setter
     def GradientVariant(self, value:'GradientVariantsType'):
+        """Sets the gradient variant of the fill.
+        
+        Args:
+            value (GradientVariantsType): An enumeration value representing the gradient variant.
+        """
         GetDllLibXls().XlsFill_set_GradientVariant.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsFill_set_GradientVariant, self.Ptr, value.value)
 
     @property
 
     def FillType(self)->'ShapeFillType':
-        """
-
+        """Gets or sets the type of the fill.
+        
+        Returns:
+            ShapeFillType: An enumeration value representing the fill type.
         """
         GetDllLibXls().XlsFill_get_FillType.argtypes=[c_void_p]
         GetDllLibXls().XlsFill_get_FillType.restype=c_int
@@ -101,13 +131,23 @@ class XlsFill (SpireObject) :
 
     @FillType.setter
     def FillType(self, value:'ShapeFillType'):
+        """Sets the type of the fill.
+        
+        Args:
+            value (ShapeFillType): An enumeration value representing the fill type.
+        """
         GetDllLibXls().XlsFill_set_FillType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsFill_set_FillType, self.Ptr, value.value)
 
 
     def Equals(self ,obj:'SpireObject')->bool:
-        """
-
+        """Determines whether the specified object is equal to the current fill.
+        
+        Args:
+            obj (SpireObject): The object to compare with the current fill.
+            
+        Returns:
+            bool: True if the specified object is equal to the current fill; otherwise, False.
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -117,8 +157,10 @@ class XlsFill (SpireObject) :
         return ret
 
     def GetHashCode(self)->int:
-        """
-
+        """Gets the hash code for the current fill.
+        
+        Returns:
+            int: A hash code for the current fill.
         """
         GetDllLibXls().XlsFill_GetHashCode.argtypes=[c_void_p]
         GetDllLibXls().XlsFill_GetHashCode.restype=c_int
@@ -127,8 +169,10 @@ class XlsFill (SpireObject) :
 
 
     def Clone(self)->'XlsFill':
-        """
-
+        """Creates a clone of this fill.
+        
+        Returns:
+            XlsFill: A new instance of the fill with the same formatting.
         """
         GetDllLibXls().XlsFill_Clone.argtypes=[c_void_p]
         GetDllLibXls().XlsFill_Clone.restype=c_void_p

spire/xls/XlsFont.py

@@ -7,13 +7,21 @@ from ctypes import *
 import abc
 
 class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
-    """
-
+    """Represents a font in an Excel worksheet.
+    
+    This class provides properties and methods for manipulating fonts in Excel,
+    including font style, size, color, and other formatting options. It extends XlsObject and
+    implements the IFont, IOptimizedUpdate, and ICloneParent interfaces.
     """
 
     def Clone(self ,parent:'SpireObject')->'XlsFont':
-        """
-
+        """Creates a clone of this font.
+        
+        Args:
+            parent (SpireObject): The parent object for the cloned font.
+            
+        Returns:
+            XlsFont: A new instance of the font with the same formatting.
         """
         intPtrparent:c_void_p = parent.Ptr
 
@@ -26,8 +34,16 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
 
     def CompareTo(self ,obj:'SpireObject')->int:
-        """
-
+        """Compares the current font with another object.
+        
+        Args:
+            obj (SpireObject): The object to compare with the current font.
+            
+        Returns:
+            int: A value that indicates the relative order of the objects being compared.
+                 Less than zero: This font precedes obj in the sort order.
+                 Zero: This font occurs in the same position in the sort order as obj.
+                 Greater than zero: This font follows obj in the sort order.
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -38,8 +54,10 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @property
     def IsAutoColor(self)->bool:
-        """
-
+        """Gets whether the font color is automatically determined.
+        
+        Returns:
+            bool: True if the font color is automatically determined; otherwise, False.
         """
         GetDllLibXls().XlsFont_get_IsAutoColor.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_IsAutoColor.restype=c_bool
@@ -48,8 +66,10 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @property
     def IsBold(self)->bool:
-        """
-
+        """Gets or sets whether the font is bold.
+        
+        Returns:
+            bool: True if the font is bold; otherwise, False.
         """
         GetDllLibXls().XlsFont_get_IsBold.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_IsBold.restype=c_bool
@@ -58,16 +78,21 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @IsBold.setter
     def IsBold(self, value:bool):
+        """Sets whether the font is bold.
+        
+        Args:
+            value (bool): True to make the font bold; otherwise, False.
+        """
         GetDllLibXls().XlsFont_set_IsBold.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsFont_set_IsBold, self.Ptr, value)
 
     @property
 
     def OColor(self)->'OColor':
-        """
-    <summary>
-        Returns color object.
-    </summary>
+        """Gets the Office color of the font.
+        
+        Returns:
+            OColor: An object representing the Office color of the font.
         """
         GetDllLibXls().XlsFont_get_OColor.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_OColor.restype=c_void_p
@@ -79,8 +104,10 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
     @property
 
     def KnownColor(self)->'ExcelColors':
-        """
-
+        """Gets or sets a predefined Excel color for the font.
+        
+        Returns:
+            ExcelColors: An enumeration value representing the Excel color.
         """
         GetDllLibXls().XlsFont_get_KnownColor.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_KnownColor.restype=c_int
@@ -90,14 +117,21 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @KnownColor.setter
     def KnownColor(self, value:'ExcelColors'):
+        """Sets a predefined Excel color for the font.
+        
+        Args:
+            value (ExcelColors): An enumeration value representing the Excel color.
+        """
         GetDllLibXls().XlsFont_set_KnownColor.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsFont_set_KnownColor, self.Ptr, value.value)
 
     @property
 
     def Color(self)->'Color':
-        """
-
+        """Gets or sets the color of the font.
+        
+        Returns:
+            Color: A Color object representing the font color.
         """
         GetDllLibXls().XlsFont_get_Color.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_Color.restype=c_void_p
@@ -108,13 +142,21 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @Color.setter
     def Color(self, value:'Color'):
+        """Sets the color of the font.
+        
+        Args:
+            value (Color): A Color object representing the font color.
+        """
         GetDllLibXls().XlsFont_set_Color.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsFont_set_Color, self.Ptr, value.Ptr)
 
 
     def SetThemeColor(self ,type:'ThemeColorType',tint:float):
-        """
-
+        """Sets a theme color for the font.
+        
+        Args:
+            type (ThemeColorType): The theme color type to set.
+            tint (float): The tint value to apply to the theme color.
         """
         enumtype:c_int = type.value
 
@@ -137,8 +179,10 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @property
     def IsItalic(self)->bool:
-        """
-
+        """Gets or sets whether the font is italic.
+        
+        Returns:
+            bool: True if the font is italic; otherwise, False.
         """
         GetDllLibXls().XlsFont_get_IsItalic.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_IsItalic.restype=c_bool
@@ -147,13 +191,20 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @IsItalic.setter
     def IsItalic(self, value:bool):
+        """Sets whether the font is italic.
+        
+        Args:
+            value (bool): True to make the font italic; otherwise, False.
+        """
         GetDllLibXls().XlsFont_set_IsItalic.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsFont_set_IsItalic, self.Ptr, value)
 
     @property
     def Size(self)->float:
-        """
-
+        """Gets or sets the size of the font in points.
+        
+        Returns:
+            float: The size of the font in points.
         """
         GetDllLibXls().XlsFont_get_Size.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_Size.restype=c_double
@@ -162,13 +213,20 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @Size.setter
     def Size(self, value:float):
+        """Sets the size of the font in points.
+        
+        Args:
+            value (float): The size of the font in points.
+        """
         GetDllLibXls().XlsFont_set_Size.argtypes=[c_void_p, c_double]
         CallCFunction(GetDllLibXls().XlsFont_set_Size, self.Ptr, value)
 
     @property
     def IsStrikethrough(self)->bool:
-        """
-
+        """Gets or sets whether the font has a strikethrough.
+        
+        Returns:
+            bool: True if the font has a strikethrough; otherwise, False.
         """
         GetDllLibXls().XlsFont_get_IsStrikethrough.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_IsStrikethrough.restype=c_bool
@@ -177,13 +235,20 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @IsStrikethrough.setter
     def IsStrikethrough(self, value:bool):
+        """Sets whether the font has a strikethrough.
+        
+        Args:
+            value (bool): True to apply a strikethrough to the font; otherwise, False.
+        """
         GetDllLibXls().XlsFont_set_IsStrikethrough.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsFont_set_IsStrikethrough, self.Ptr, value)
 
     @property
     def IsSubscript(self)->bool:
-        """
-
+        """Gets or sets whether the font is subscript.
+        
+        Returns:
+            bool: True if the font is subscript; otherwise, False.
         """
         GetDllLibXls().XlsFont_get_IsSubscript.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_IsSubscript.restype=c_bool
@@ -192,14 +257,21 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @IsSubscript.setter
     def IsSubscript(self, value:bool):
+        """Sets whether the font is subscript.
+        
+        Args:
+            value (bool): True to make the font subscript; otherwise, False.
+        """
         GetDllLibXls().XlsFont_set_IsSubscript.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsFont_set_IsSubscript, self.Ptr, value)
 
     @property
 
     def StrikethroughType(self)->str:
-        """
-
+        """Gets or sets the type of strikethrough for the font.
+        
+        Returns:
+            str: The type of strikethrough for the font.
         """
         GetDllLibXls().XlsFont_get_StrikethroughType.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_StrikethroughType.restype=c_void_p
@@ -209,13 +281,20 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @StrikethroughType.setter
     def StrikethroughType(self, value:str):
+        """Sets the type of strikethrough for the font.
+        
+        Args:
+            value (str): The type of strikethrough for the font.
+        """
         GetDllLibXls().XlsFont_set_StrikethroughType.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsFont_set_StrikethroughType, self.Ptr, value)
 
     @property
     def IsSuperscript(self)->bool:
-        """
-
+        """Gets or sets whether the font is superscript.
+        
+        Returns:
+            bool: True if the font is superscript; otherwise, False.
         """
         GetDllLibXls().XlsFont_get_IsSuperscript.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_IsSuperscript.restype=c_bool
@@ -224,14 +303,21 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @IsSuperscript.setter
     def IsSuperscript(self, value:bool):
+        """Sets whether the font is superscript.
+        
+        Args:
+            value (bool): True to make the font superscript; otherwise, False.
+        """
         GetDllLibXls().XlsFont_set_IsSuperscript.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsFont_set_IsSuperscript, self.Ptr, value)
 
     @property
 
     def Underline(self)->'FontUnderlineType':
-        """
-
+        """Gets or sets the type of underline for the font.
+        
+        Returns:
+            FontUnderlineType: An enumeration value representing the underline type.
         """
         GetDllLibXls().XlsFont_get_Underline.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_Underline.restype=c_int
@@ -241,14 +327,21 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @Underline.setter
     def Underline(self, value:'FontUnderlineType'):
+        """Sets the type of underline for the font.
+        
+        Args:
+            value (FontUnderlineType): An enumeration value representing the underline type.
+        """
         GetDllLibXls().XlsFont_set_Underline.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsFont_set_Underline, self.Ptr, value.value)
 
     @property
 
     def FontName(self)->str:
-        """
-
+        """Gets or sets the name of the font.
+        
+        Returns:
+            str: The name of the font.
         """
         GetDllLibXls().XlsFont_get_FontName.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_FontName.restype=c_void_p
@@ -258,14 +351,21 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @FontName.setter
     def FontName(self, value:str):
+        """Sets the name of the font.
+        
+        Args:
+            value (str): The name of the font.
+        """
         GetDllLibXls().XlsFont_set_FontName.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsFont_set_FontName, self.Ptr, value)
 
     @property
 
     def VerticalAlignment(self)->'FontVertialAlignmentType':
-        """
-
+        """Gets or sets the vertical alignment of the font.
+        
+        Returns:
+            FontVertialAlignmentType: An enumeration value representing the vertical alignment type.
         """
         GetDllLibXls().XlsFont_get_VerticalAlignment.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_VerticalAlignment.restype=c_int
@@ -275,14 +375,21 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @VerticalAlignment.setter
     def VerticalAlignment(self, value:'FontVertialAlignmentType'):
+        """Sets the vertical alignment of the font.
+        
+        Args:
+            value (FontVertialAlignmentType): An enumeration value representing the vertical alignment type.
+        """
         GetDllLibXls().XlsFont_set_VerticalAlignment.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsFont_set_VerticalAlignment, self.Ptr, value.value)
 
     @property
 
     def Scheme(self)->str:
-        """
-
+        """Gets or sets the font scheme.
+        
+        Returns:
+            str: The font scheme.
         """
         GetDllLibXls().XlsFont_get_Scheme.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_Scheme.restype=c_void_p
@@ -292,14 +399,21 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
     @Scheme.setter
     def Scheme(self, value:str):
+        """Sets the font scheme.
+        
+        Args:
+            value (str): The font scheme to set.
+        """
         GetDllLibXls().XlsFont_set_Scheme.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsFont_set_Scheme, self.Ptr, value)
 
     @dispatch
 
     def GenerateNativeFont(self)->Font:
-        """
-
+        """Generates a native Font object from this XlsFont.
+        
+        Returns:
+            Font: A native Font object with the properties of this XlsFont.
         """
         GetDllLibXls().XlsFont_GenerateNativeFont.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_GenerateNativeFont.restype=c_void_p
@@ -311,8 +425,13 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
     @dispatch
 
     def GenerateNativeFont(self ,size:float)->Font:
-        """
-
+        """Generates a native Font object from this XlsFont with a specified size.
+        
+        Args:
+            size (float): The size of the font in points.
+            
+        Returns:
+            Font: A native Font object with the properties of this XlsFont and the specified size.
         """
         
         GetDllLibXls().XlsFont_GenerateNativeFontS.argtypes=[c_void_p ,c_float]
@@ -323,15 +442,19 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
 
     def BeginUpdate(self):
-        """
-
+        """Begins a series of operations that modify the font.
+        
+        This method should be called before making multiple changes to the font
+        to improve performance.
         """
         GetDllLibXls().XlsFont_BeginUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().XlsFont_BeginUpdate, self.Ptr)
 
     def EndUpdate(self):
-        """
-
+        """Ends a series of operations that modify the font.
+        
+        This method should be called after making multiple changes to the font
+        to apply the changes and improve performance.
         """
         GetDllLibXls().XlsFont_EndUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().XlsFont_EndUpdate, self.Ptr)
@@ -339,8 +462,10 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
     @property
 
     def Font(self)->'XlsFont':
-        """
-
+        """Gets the font object.
+        
+        Returns:
+            XlsFont: The font object.
         """
         GetDllLibXls().XlsFont_get_Font.argtypes=[c_void_p]
         GetDllLibXls().XlsFont_get_Font.restype=c_void_p
@@ -351,8 +476,13 @@ class XlsFont (  XlsObject, IFont, IOptimizedUpdate, ICloneParent) :
 
 
     def MeasureString(self ,strValue:str)->'SizeF':
-        """
-
+        """Measures the size of a string when drawn with this font.
+        
+        Args:
+            strValue (str): The string to measure.
+            
+        Returns:
+            SizeF: The size of the string in the current font.
         """
         
         GetDllLibXls().XlsFont_MeasureString.argtypes=[c_void_p ,c_void_p]