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

spire/xls/GradientArrayWrapper.py

@@ -7,14 +7,20 @@ from ctypes import *
 import abc
 
 class GradientArrayWrapper (  XlsObject, IGradient) :
-    """
-
+    """Represents a wrapper for gradient arrays in Excel.
+    
+    This class provides methods and properties for manipulating gradient effects
+    in Excel, including two-color gradients with various styles and variants.
+    It implements the IGradient interface to enable gradient formatting for
+    cell backgrounds and other elements.
     """
     @property
 
     def BackColorObject(self)->'OColor':
-        """
-
+        """Gets the background color object of the gradient.
+        
+        Returns:
+            OColor: An OColor object representing the background color.
         """
         GetDllLibXls().GradientArrayWrapper_get_BackColorObject.argtypes=[c_void_p]
         GetDllLibXls().GradientArrayWrapper_get_BackColorObject.restype=c_void_p
@@ -26,8 +32,10 @@ class GradientArrayWrapper (  XlsObject, IGradient) :
     @property
 
     def BackColor(self)->'Color':
-        """
-
+        """Gets or sets the background color of the gradient.
+        
+        Returns:
+            Color: A Color object representing the background color.
         """
         GetDllLibXls().GradientArrayWrapper_get_BackColor.argtypes=[c_void_p]
         GetDllLibXls().GradientArrayWrapper_get_BackColor.restype=c_void_p
@@ -38,14 +46,21 @@ class GradientArrayWrapper (  XlsObject, IGradient) :
 
     @BackColor.setter
     def BackColor(self, value:'Color'):
+        """Sets the background color of the gradient.
+        
+        Args:
+            value (Color): A Color object representing the background color to set.
+        """
         GetDllLibXls().GradientArrayWrapper_set_BackColor.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().GradientArrayWrapper_set_BackColor, self.Ptr, value.Ptr)
 
     @property
 
     def BackKnownColor(self)->'ExcelColors':
-        """
-
+        """Gets or sets the predefined Excel color for the gradient background.
+        
+        Returns:
+            ExcelColors: An enumeration value representing the Excel color.
         """
         GetDllLibXls().GradientArrayWrapper_get_BackKnownColor.argtypes=[c_void_p]
         GetDllLibXls().GradientArrayWrapper_get_BackKnownColor.restype=c_int
@@ -55,14 +70,21 @@ class GradientArrayWrapper (  XlsObject, IGradient) :
 
     @BackKnownColor.setter
     def BackKnownColor(self, value:'ExcelColors'):
+        """Sets the predefined Excel color for the gradient background.
+        
+        Args:
+            value (ExcelColors): An enumeration value representing the Excel color to set.
+        """
         GetDllLibXls().GradientArrayWrapper_set_BackKnownColor.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().GradientArrayWrapper_set_BackKnownColor, self.Ptr, value.value)
 
     @property
 
     def ForeColorObject(self)->'OColor':
-        """
-
+        """Gets the foreground color object of the gradient.
+        
+        Returns:
+            OColor: An OColor object representing the foreground color.
         """
         GetDllLibXls().GradientArrayWrapper_get_ForeColorObject.argtypes=[c_void_p]
         GetDllLibXls().GradientArrayWrapper_get_ForeColorObject.restype=c_void_p
@@ -74,8 +96,10 @@ class GradientArrayWrapper (  XlsObject, IGradient) :
     @property
 
     def ForeColor(self)->'Color':
-        """
-
+        """Gets or sets the foreground color of the gradient.
+        
+        Returns:
+            Color: A Color object representing the foreground color.
         """
         GetDllLibXls().GradientArrayWrapper_get_ForeColor.argtypes=[c_void_p]
         GetDllLibXls().GradientArrayWrapper_get_ForeColor.restype=c_void_p
@@ -86,14 +110,21 @@ class GradientArrayWrapper (  XlsObject, IGradient) :
 
     @ForeColor.setter
     def ForeColor(self, value:'Color'):
+        """Sets the foreground color of the gradient.
+        
+        Args:
+            value (Color): A Color object representing the foreground color to set.
+        """
         GetDllLibXls().GradientArrayWrapper_set_ForeColor.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().GradientArrayWrapper_set_ForeColor, self.Ptr, value.Ptr)
 
     @property
 
     def ForeKnownColor(self)->'ExcelColors':
-        """
-
+        """Gets or sets the predefined Excel color for the gradient foreground.
+        
+        Returns:
+            ExcelColors: An enumeration value representing the Excel color.
         """
         GetDllLibXls().GradientArrayWrapper_get_ForeKnownColor.argtypes=[c_void_p]
         GetDllLibXls().GradientArrayWrapper_get_ForeKnownColor.restype=c_int
@@ -103,14 +134,21 @@ class GradientArrayWrapper (  XlsObject, IGradient) :
 
     @ForeKnownColor.setter
     def ForeKnownColor(self, value:'ExcelColors'):
+        """Sets the predefined Excel color for the gradient foreground.
+        
+        Args:
+            value (ExcelColors): An enumeration value representing the Excel color to set.
+        """
         GetDllLibXls().GradientArrayWrapper_set_ForeKnownColor.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().GradientArrayWrapper_set_ForeKnownColor, self.Ptr, value.value)
 
     @property
 
     def GradientStyle(self)->'GradientStyleType':
-        """
-
+        """Gets or sets the style of the gradient.
+        
+        Returns:
+            GradientStyleType: An enumeration value representing the gradient style.
         """
         GetDllLibXls().GradientArrayWrapper_get_GradientStyle.argtypes=[c_void_p]
         GetDllLibXls().GradientArrayWrapper_get_GradientStyle.restype=c_int
@@ -120,14 +158,21 @@ class GradientArrayWrapper (  XlsObject, IGradient) :
 
     @GradientStyle.setter
     def GradientStyle(self, value:'GradientStyleType'):
+        """Sets the style of the gradient.
+        
+        Args:
+            value (GradientStyleType): An enumeration value representing the gradient style to set.
+        """
         GetDllLibXls().GradientArrayWrapper_set_GradientStyle.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().GradientArrayWrapper_set_GradientStyle, self.Ptr, value.value)
 
     @property
 
     def GradientVariant(self)->'GradientVariantsType':
-        """
-
+        """Gets or sets the variant of the gradient.
+        
+        Returns:
+            GradientVariantsType: An enumeration value representing the gradient variant.
         """
         GetDllLibXls().GradientArrayWrapper_get_GradientVariant.argtypes=[c_void_p]
         GetDllLibXls().GradientArrayWrapper_get_GradientVariant.restype=c_int
@@ -137,13 +182,23 @@ class GradientArrayWrapper (  XlsObject, IGradient) :
 
     @GradientVariant.setter
     def GradientVariant(self, value:'GradientVariantsType'):
+        """Sets the variant of the gradient.
+        
+        Args:
+            value (GradientVariantsType): An enumeration value representing the gradient variant to set.
+        """
         GetDllLibXls().GradientArrayWrapper_set_GradientVariant.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().GradientArrayWrapper_set_GradientVariant, self.Ptr, value.value)
 
 
     def CompareTo(self ,gradient:'IGradient')->int:
-        """
-
+        """Compares this gradient with another gradient.
+        
+        Args:
+            gradient (IGradient): The gradient to compare with.
+            
+        Returns:
+            int: A value that indicates the relative order of the objects being compared.
         """
         intPtrgradient:c_void_p = gradient.Ptr
 
@@ -154,8 +209,10 @@ class GradientArrayWrapper (  XlsObject, IGradient) :
 
     @dispatch
     def TwoColorGradient(self):
-        """
-
+        """Creates a two-color gradient with default style and variant.
+        
+        This method sets up a two-color gradient using the current foreground and
+        background colors with default style and variant settings.
         """
         GetDllLibXls().GradientArrayWrapper_TwoColorGradient.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().GradientArrayWrapper_TwoColorGradient, self.Ptr)
@@ -163,8 +220,11 @@ class GradientArrayWrapper (  XlsObject, IGradient) :
     @dispatch
 
     def TwoColorGradient(self ,style:GradientStyleType,variant:GradientVariantsType):
-        """
-
+        """Creates a two-color gradient with specified style and variant.
+        
+        Args:
+            style (GradientStyleType): The style of the gradient.
+            variant (GradientVariantsType): The variant of the gradient.
         """
         enumstyle:c_int = style.value
         enumvariant:c_int = variant.value
@@ -173,15 +233,19 @@ class GradientArrayWrapper (  XlsObject, IGradient) :
         CallCFunction(GetDllLibXls().GradientArrayWrapper_TwoColorGradientSV, self.Ptr, enumstyle,enumvariant)
 
     def BeginUpdate(self):
-        """
-
+        """Begins a batch update operation on the gradient properties.
+        
+        This method should be called before making multiple changes to gradient properties
+        to improve performance by deferring the actual updates until EndUpdate is called.
         """
         GetDllLibXls().GradientArrayWrapper_BeginUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().GradientArrayWrapper_BeginUpdate, self.Ptr)
 
     def EndUpdate(self):
-        """
-
+        """Ends a batch update operation and applies all pending changes to gradient properties.
+        
+        This method should be called after BeginUpdate to apply all the changes made
+        to gradient properties in a single operation, improving performance.
         """
         GetDllLibXls().GradientArrayWrapper_EndUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().GradientArrayWrapper_EndUpdate, self.Ptr)

spire/xls/GradientStops.py

@@ -6,14 +6,19 @@ from spire.xls import *
 from ctypes import *
 import abc
 
-class GradientStops (SpireObject) :
-    """
-
+class GradientStops (CollectionBase[XlsGradientStop]) :
+    """Represents a collection of gradient stops in Excel.
+    
+    This class provides properties and methods for managing gradient stops,
+    which define the color transitions in a gradient fill. It allows for
+    manipulating gradient properties such as angle, type, and color stops.
     """
     @property
     def Angle(self)->int:
-        """
-
+        """Gets or sets the angle of the gradient in degrees.
+        
+        Returns:
+            int: The angle of the gradient in degrees.
         """
         GetDllLibXls().GradientStops_get_Angle.argtypes=[c_void_p]
         GetDllLibXls().GradientStops_get_Angle.restype=c_int
@@ -22,14 +27,21 @@ class GradientStops (SpireObject) :
 
     @Angle.setter
     def Angle(self, value:int):
+        """Sets the angle of the gradient in degrees.
+        
+        Args:
+            value (int): The angle of the gradient in degrees.
+        """
         GetDllLibXls().GradientStops_set_Angle.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().GradientStops_set_Angle, self.Ptr, value)
 
     @property
 
     def GradientType(self)->'GradientType':
-        """
-
+        """Gets or sets the type of the gradient.
+        
+        Returns:
+            GradientType: An enumeration value representing the gradient type.
         """
         GetDllLibXls().GradientStops_get_GradientType.argtypes=[c_void_p]
         GetDllLibXls().GradientStops_get_GradientType.restype=c_int
@@ -39,14 +51,21 @@ class GradientStops (SpireObject) :
 
     @GradientType.setter
     def GradientType(self, value:'GradientType'):
+        """Sets the type of the gradient.
+        
+        Args:
+            value (GradientType): An enumeration value representing the gradient type.
+        """
         GetDllLibXls().GradientStops_set_GradientType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().GradientStops_set_GradientType, self.Ptr, value.value)
 
     @property
 
     def FillToRect(self)->'Rectangle':
-        """
-
+        """Gets or sets the rectangle that defines the end point of the gradient.
+        
+        Returns:
+            Rectangle: A Rectangle object representing the end point of the gradient.
         """
         GetDllLibXls().GradientStops_get_FillToRect.argtypes=[c_void_p]
         GetDllLibXls().GradientStops_get_FillToRect.restype=c_void_p
@@ -57,13 +76,20 @@ class GradientStops (SpireObject) :
 
     @FillToRect.setter
     def FillToRect(self, value:'Rectangle'):
+        """Sets the rectangle that defines the end point of the gradient.
+        
+        Args:
+            value (Rectangle): A Rectangle object representing the end point of the gradient.
+        """
         GetDllLibXls().GradientStops_set_FillToRect.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().GradientStops_set_FillToRect, self.Ptr, value.Ptr)
 
     @property
     def IsDoubled(self)->bool:
-        """
-
+        """Gets a value indicating whether the gradient stops are doubled.
+        
+        Returns:
+            bool: True if the gradient stops are doubled; otherwise, False.
         """
         GetDllLibXls().GradientStops_get_IsDoubled.argtypes=[c_void_p]
         GetDllLibXls().GradientStops_get_IsDoubled.restype=c_bool
@@ -71,23 +97,32 @@ class GradientStops (SpireObject) :
         return ret
 
     def DoubleGradientStops(self):
-        """
-
+        """Doubles the gradient stops.
+        
+        This method creates a mirror image of the gradient stops, effectively
+        doubling the number of color transitions in the gradient.
         """
         GetDllLibXls().GradientStops_DoubleGradientStops.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().GradientStops_DoubleGradientStops, self.Ptr)
 
     def InvertGradientStops(self):
-        """
-
+        """Inverts the gradient stops.
+        
+        This method reverses the order of the gradient stops, effectively
+        inverting the color transitions in the gradient.
         """
         GetDllLibXls().GradientStops_InvertGradientStops.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().GradientStops_InvertGradientStops, self.Ptr)
 
 
     def ShrinkGradientStops(self)->'GradientStops':
-        """
-
+        """Shrinks the gradient stops.
+        
+        This method reduces the number of gradient stops by combining
+        similar adjacent stops.
+        
+        Returns:
+            GradientStops: A new GradientStops object with reduced stops.
         """
         GetDllLibXls().GradientStops_ShrinkGradientStops.argtypes=[c_void_p]
         GetDllLibXls().GradientStops_ShrinkGradientStops.restype=c_void_p
@@ -98,8 +133,10 @@ class GradientStops (SpireObject) :
 
 
     def Clone(self)->'GradientStops':
-        """
-
+        """Creates a clone of this GradientStops object.
+        
+        Returns:
+            GradientStops: A new GradientStops object that is a copy of this instance.
         """
         GetDllLibXls().GradientStops_Clone.argtypes=[c_void_p]
         GetDllLibXls().GradientStops_Clone.restype=c_void_p
@@ -111,8 +148,10 @@ class GradientStops (SpireObject) :
     @dispatch
 
     def Add(self ,stop:XlsGradientStop):
-        """
-
+        """Adds a gradient stop to the collection.
+        
+        Args:
+            stop (XlsGradientStop): The gradient stop to add.
         """
         intPtrstop:c_void_p = stop.Ptr
 
@@ -122,8 +161,17 @@ class GradientStops (SpireObject) :
     @dispatch
 
     def Add(self ,color:Color,position:int,transparency:int,tint:int,shade:int)->XlsGradientStop:
-        """
-
+        """Adds a gradient stop with specified properties to the collection.
+        
+        Args:
+            color (Color): The color of the gradient stop.
+            position (int): The position of the gradient stop.
+            transparency (int): The transparency level of the gradient stop.
+            tint (int): The tint value of the gradient stop.
+            shade (int): The shade value of the gradient stop.
+            
+        Returns:
+            XlsGradientStop: The newly created gradient stop.
         """
         intPtrcolor:c_void_p = color.Ptr
 
@@ -136,8 +184,10 @@ class GradientStops (SpireObject) :
 
 
     def Serialize(self ,stream:'Stream'):
-        """
-
+        """Serializes the gradient stops to a stream.
+        
+        Args:
+            stream (Stream): The stream to which the gradient stops will be serialized.
         """
         intPtrstream:c_void_p = stream.Ptr
 

spire/xls/GradientType.py

@@ -7,8 +7,16 @@ from ctypes import *
 import abc
 
 class GradientType(Enum):
-    """
-
+    """Represents the types of gradients available in Excel.
+    
+    This enumeration defines the various gradient types that can be applied
+    to Excel cell backgrounds, shapes, and other elements that support gradient fills.
+    
+    Attributes:
+        Liniar: A linear gradient that transitions colors in a straight line.
+        Circle: A circular gradient that transitions colors from the center outward in a circular pattern.
+        Rect: A rectangular gradient that transitions colors from the center outward in a rectangular pattern.
+        Shape: A gradient that follows the shape of the object to which it is applied.
     """
     Liniar = 0
     Circle = 1

spire/xls/GroupShape.py

@@ -12,9 +12,8 @@ class GroupShape (XlsShape) :
     """
     def UnGroup(self):
         """
-    <summary>
         UnGroup current group shape.
-    </summary>
+
         """
         GetDllLibXls().GroupShape_UnGroup.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().GroupShape_UnGroup, self.Ptr)

spire/xls/HPageBreak.py

@@ -14,10 +14,10 @@ class HPageBreak (  XlsHPageBreak) :
 
     def Location(self)->'CellRange':
         """
-    <summary>
         Location of the page break.
-    </summary>
+
         """
+        from spire.xls.CellRange import CellRange
         GetDllLibXls().HPageBreak_get_Location.argtypes=[c_void_p]
         GetDllLibXls().HPageBreak_get_Location.restype=c_void_p
         intPtr = CallCFunction(GetDllLibXls().HPageBreak_get_Location, self.Ptr)

spire/xls/HTMLOptions.py

@@ -53,10 +53,8 @@ class HTMLOptions (SpireObject) :
 
     def ImageLocationType(self)->'ImageLocationTypes':
         """
-    <summary>
-        Gets or sets the Image Location type.
-            GlobalAbsolute or Relative to Table
-    </summary>
+        Gets or sets the Image Location type. GlobalAbsolute or Relative to Table
+
         """
         GetDllLibXls().HTMLOptions_get_ImageLocationType.argtypes=[c_void_p]
         GetDllLibXls().HTMLOptions_get_ImageLocationType.restype=c_int
@@ -72,13 +70,8 @@ class HTMLOptions (SpireObject) :
     @property
     def ImageEmbedded(self)->bool:
         """
-    <summary>
-        If false,indicates exporting the image as a single file; 
-            If true, embedding the image into the html code using Data URI scheme.
-            The default value is false.
-            Note: Internet Explorer 8 limits data URIs to a maximum length of 32KB.
-    </summary>
-<value>The value of the HTML export image style sheet.</value>
+        If false,indicates exporting the image as a single file; If true, embedding the image into the html code using Data URI scheme. The default value is false. Note: Internet Explorer 8 limits data URIs to a maximum length of 32KB.
+
         """
         GetDllLibXls().HTMLOptions_get_ImageEmbedded.argtypes=[c_void_p]
         GetDllLibXls().HTMLOptions_get_ImageEmbedded.restype=c_bool
@@ -94,9 +87,8 @@ class HTMLOptions (SpireObject) :
 
     def StyleDefine(self)->'StyleDefineType':
         """
-    <summary>
         where is the style defined; default : head
-    </summary>
+
         """
         GetDllLibXls().HTMLOptions_get_StyleDefine.argtypes=[c_void_p]
         GetDllLibXls().HTMLOptions_get_StyleDefine.restype=c_int
@@ -112,12 +104,8 @@ class HTMLOptions (SpireObject) :
     @property
     def IsFixedTableColWidth(self)->bool:
         """
-    <summary>
-        Gets or sets whether the width of td is fixed :
-            If true, the width of td is fixed, same as width of column in excel view.
-            If false, the width of td is not fixed.
-            Default is false.
-    </summary>
+        Gets or sets whether the width of td is fixed : If true, the width of td is fixed, same as width of column in excel view. If false, the width of td is not fixed. Default is false.
+
         """
         GetDllLibXls().HTMLOptions_get_IsFixedTableColWidth.argtypes=[c_void_p]
         GetDllLibXls().HTMLOptions_get_IsFixedTableColWidth.restype=c_bool

spire/xls/HyperLink.py

@@ -14,10 +14,10 @@ class HyperLink (  XlsHyperLink) :
 
     def Range(self)->'CellRange':
         """
-    <summary>
         Returns a Range object that represents the range the specified hyperlink is attached to.
-    </summary>
+
         """
+        from spire.xls.CellRange import CellRange
         GetDllLibXls().HyperLink_get_Range.argtypes=[c_void_p]
         GetDllLibXls().HyperLink_get_Range.restype=c_void_p
         intPtr = CallCFunction(GetDllLibXls().HyperLink_get_Range, self.Ptr)