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

spire/xls/XlsGradient.py

@@ -7,14 +7,19 @@ from ctypes import *
 import abc
 
 class XlsGradient (  XlsObject, IGradient) :
-    """
-
+    """Represents a gradient fill in an Excel worksheet.
+    
+    This class provides properties and methods for manipulating gradient fills in Excel,
+    including gradient colors, styles, and variants. It extends XlsObject and
+    implements the IGradient interface.
     """
     @property
 
     def BackColorObject(self)->'OColor':
-        """
-
+        """Gets the Office color object for the background color of the gradient.
+        
+        Returns:
+            OColor: An Office color object representing the background color.
         """
         GetDllLibXls().XlsGradient_get_BackColorObject.argtypes=[c_void_p]
         GetDllLibXls().XlsGradient_get_BackColorObject.restype=c_void_p
@@ -26,8 +31,10 @@ class XlsGradient (  XlsObject, IGradient) :
     @property
 
     def ForeColorObject(self)->'OColor':
-        """
-
+        """Gets the Office color object for the foreground color of the gradient.
+        
+        Returns:
+            OColor: An Office color object representing the foreground color.
         """
         GetDllLibXls().XlsGradient_get_ForeColorObject.argtypes=[c_void_p]
         GetDllLibXls().XlsGradient_get_ForeColorObject.restype=c_void_p
@@ -39,8 +46,10 @@ class XlsGradient (  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().XlsGradient_get_BackColor.argtypes=[c_void_p]
         GetDllLibXls().XlsGradient_get_BackColor.restype=c_void_p
@@ -51,14 +60,21 @@ class XlsGradient (  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.
+        """
         GetDllLibXls().XlsGradient_set_BackColor.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsGradient_set_BackColor, self.Ptr, value.Ptr)
 
     @property
 
     def ForeColor(self)->'Color':
-        """
-
+        """Gets or sets the foreground color of the gradient.
+        
+        Returns:
+            Color: A Color object representing the foreground color.
         """
         GetDllLibXls().XlsGradient_get_ForeColor.argtypes=[c_void_p]
         GetDllLibXls().XlsGradient_get_ForeColor.restype=c_void_p
@@ -69,14 +85,21 @@ class XlsGradient (  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.
+        """
         GetDllLibXls().XlsGradient_set_ForeColor.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsGradient_set_ForeColor, self.Ptr, value.Ptr)
 
     @property
 
     def BackKnownColor(self)->'ExcelColors':
-        """
-
+        """Gets or sets a predefined Excel color for the background of the gradient.
+        
+        Returns:
+            ExcelColors: An enumeration value representing the Excel color.
         """
         GetDllLibXls().XlsGradient_get_BackKnownColor.argtypes=[c_void_p]
         GetDllLibXls().XlsGradient_get_BackKnownColor.restype=c_int
@@ -86,14 +109,21 @@ class XlsGradient (  XlsObject, IGradient) :
 
     @BackKnownColor.setter
     def BackKnownColor(self, value:'ExcelColors'):
+        """Sets a predefined Excel color for the background of the gradient.
+        
+        Args:
+            value (ExcelColors): An enumeration value representing the Excel color.
+        """
         GetDllLibXls().XlsGradient_set_BackKnownColor.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsGradient_set_BackKnownColor, self.Ptr, value.value)
 
     @property
 
     def ForeKnownColor(self)->'ExcelColors':
-        """
-
+        """Gets or sets a predefined Excel color for the foreground of the gradient.
+        
+        Returns:
+            ExcelColors: An enumeration value representing the Excel color.
         """
         GetDllLibXls().XlsGradient_get_ForeKnownColor.argtypes=[c_void_p]
         GetDllLibXls().XlsGradient_get_ForeKnownColor.restype=c_int
@@ -103,14 +133,21 @@ class XlsGradient (  XlsObject, IGradient) :
 
     @ForeKnownColor.setter
     def ForeKnownColor(self, value:'ExcelColors'):
+        """Sets a predefined Excel color for the foreground of the gradient.
+        
+        Args:
+            value (ExcelColors): An enumeration value representing the Excel color.
+        """
         GetDllLibXls().XlsGradient_set_ForeKnownColor.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsGradient_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().XlsGradient_get_GradientStyle.argtypes=[c_void_p]
         GetDllLibXls().XlsGradient_get_GradientStyle.restype=c_int
@@ -120,14 +157,21 @@ class XlsGradient (  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.
+        """
         GetDllLibXls().XlsGradient_set_GradientStyle.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsGradient_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().XlsGradient_get_GradientVariant.argtypes=[c_void_p]
         GetDllLibXls().XlsGradient_get_GradientVariant.restype=c_int
@@ -137,13 +181,26 @@ class XlsGradient (  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.
+        """
         GetDllLibXls().XlsGradient_set_GradientVariant.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsGradient_set_GradientVariant, self.Ptr, value.value)
 
 
     def CompareTo(self ,twin:'IGradient')->int:
-        """
-
+        """Compares the current gradient with another gradient.
+        
+        Args:
+            twin (IGradient): The gradient to compare with the current gradient.
+            
+        Returns:
+            int: A value that indicates the relative order of the objects being compared.
+                 Less than zero: This gradient precedes twin in the sort order.
+                 Zero: This gradient occurs in the same position in the sort order as twin.
+                 Greater than zero: This gradient follows twin in the sort order.
         """
         intPtrtwin:c_void_p = twin.Ptr
 
@@ -154,8 +211,10 @@ class XlsGradient (  XlsObject, IGradient) :
 
     @dispatch
     def TwoColorGradient(self):
-        """
-
+        """Creates a two-color gradient with default settings.
+        
+        This method sets up a two-color gradient using the current foreground and background colors
+        with default style and variant settings.
         """
         GetDllLibXls().XlsGradient_TwoColorGradient.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().XlsGradient_TwoColorGradient, self.Ptr)
@@ -163,8 +222,10 @@ class XlsGradient (  XlsObject, IGradient) :
     @dispatch
 
     def TwoColorGradient(self ,style:GradientStyleType):
-        """
-
+        """Creates a two-color gradient with the specified style.
+        
+        Args:
+            style (GradientStyleType): The style to use for the gradient.
         """
         enumstyle:c_int = style.value
 
@@ -174,8 +235,11 @@ class XlsGradient (  XlsObject, IGradient) :
     @dispatch
 
     def TwoColorGradient(self ,style:GradientStyleType,variant:GradientVariantsType):
-        """
-
+        """Creates a two-color gradient with the specified style and variant.
+        
+        Args:
+            style (GradientStyleType): The style to use for the gradient.
+            variant (GradientVariantsType): The variant to use for the gradient.
         """
         enumstyle:c_int = style.value
         enumvariant:c_int = variant.value

spire/xls/XlsGradientStop.py

@@ -7,14 +7,19 @@ from ctypes import *
 import abc
 
 class XlsGradientStop (SpireObject) :
-    """
-
+    """Represents a gradient stop in an Excel gradient fill.
+    
+    This class provides properties for manipulating individual color stops within a gradient,
+    including position, color, transparency, tint, and shade. Each gradient stop defines a color
+    at a specific position in the gradient.
     """
     @property
 
     def OColor(self)->'OColor':
-        """
-
+        """Gets the Office color object for the gradient stop.
+        
+        Returns:
+            OColor: An Office color object representing the color of the gradient stop.
         """
         GetDllLibXls().XlsGradientStop_get_OColor.argtypes=[c_void_p]
         GetDllLibXls().XlsGradientStop_get_OColor.restype=c_void_p
@@ -25,8 +30,13 @@ class XlsGradientStop (SpireObject) :
 
     @property
     def Position(self)->int:
-        """
-
+        """Gets or sets the position of the gradient stop.
+        
+        The position is a value between 0 and 100, representing the percentage position
+        within the gradient.
+        
+        Returns:
+            int: The position of the gradient stop (0-100).
         """
         GetDllLibXls().XlsGradientStop_get_Position.argtypes=[c_void_p]
         GetDllLibXls().XlsGradientStop_get_Position.restype=c_int
@@ -35,13 +45,23 @@ class XlsGradientStop (SpireObject) :
 
     @Position.setter
     def Position(self, value:int):
+        """Sets the position of the gradient stop.
+        
+        Args:
+            value (int): The position of the gradient stop (0-100).
+        """
         GetDllLibXls().XlsGradientStop_set_Position.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsGradientStop_set_Position, self.Ptr, value)
 
     @property
     def Transparency(self)->int:
-        """
-
+        """Gets or sets the transparency of the gradient stop.
+        
+        The transparency is a value between 0 and 100, where 0 is fully opaque
+        and 100 is fully transparent.
+        
+        Returns:
+            int: The transparency value (0-100).
         """
         GetDllLibXls().XlsGradientStop_get_Transparency.argtypes=[c_void_p]
         GetDllLibXls().XlsGradientStop_get_Transparency.restype=c_int
@@ -50,13 +70,23 @@ class XlsGradientStop (SpireObject) :
 
     @Transparency.setter
     def Transparency(self, value:int):
+        """Sets the transparency of the gradient stop.
+        
+        Args:
+            value (int): The transparency value (0-100).
+        """
         GetDllLibXls().XlsGradientStop_set_Transparency.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsGradientStop_set_Transparency, self.Ptr, value)
 
     @property
     def Tint(self)->int:
-        """
-
+        """Gets or sets the tint of the gradient stop color.
+        
+        Tint is a positive value that lightens the color. The value represents
+        the percentage of white added to the color.
+        
+        Returns:
+            int: The tint value.
         """
         GetDllLibXls().XlsGradientStop_get_Tint.argtypes=[c_void_p]
         GetDllLibXls().XlsGradientStop_get_Tint.restype=c_int
@@ -65,13 +95,23 @@ class XlsGradientStop (SpireObject) :
 
     @Tint.setter
     def Tint(self, value:int):
+        """Sets the tint of the gradient stop color.
+        
+        Args:
+            value (int): The tint value.
+        """
         GetDllLibXls().XlsGradientStop_set_Tint.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsGradientStop_set_Tint, self.Ptr, value)
 
     @property
     def Shade(self)->int:
-        """
-
+        """Gets or sets the shade of the gradient stop color.
+        
+        Shade is a positive value that darkens the color. The value represents
+        the percentage of black added to the color.
+        
+        Returns:
+            int: The shade value.
         """
         GetDllLibXls().XlsGradientStop_get_Shade.argtypes=[c_void_p]
         GetDllLibXls().XlsGradientStop_get_Shade.restype=c_int
@@ -80,6 +120,11 @@ class XlsGradientStop (SpireObject) :
 
     @Shade.setter
     def Shade(self, value:int):
+        """Sets the shade of the gradient stop color.
+        
+        Args:
+            value (int): The shade value.
+        """
         GetDllLibXls().XlsGradientStop_set_Shade.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsGradientStop_set_Shade, self.Ptr, value)
 

spire/xls/XlsGroupBoxShape.py

@@ -7,13 +7,18 @@ from ctypes import *
 import abc
 
 class XlsGroupBoxShape (  XlsShape, IGroupBox) :
-    """
-
+    """Represents a group box shape in an Excel worksheet.
+    
+    This class provides properties and methods for manipulating group box shapes in Excel,
+    including text display, 3D shading effects, and other formatting options. It extends
+    XlsShape and implements the IGroupBox interface.
     """
     @property
     def Display3DShading(self)->bool:
-        """
-
+        """Gets or sets whether the group box displays with 3D shading.
+        
+        Returns:
+            bool: True if the group box displays with 3D shading; otherwise, False.
         """
         GetDllLibXls().XlsGroupBoxShape_get_Display3DShading.argtypes=[c_void_p]
         GetDllLibXls().XlsGroupBoxShape_get_Display3DShading.restype=c_bool
@@ -22,14 +27,21 @@ class XlsGroupBoxShape (  XlsShape, IGroupBox) :
 
     @Display3DShading.setter
     def Display3DShading(self, value:bool):
+        """Sets whether the group box displays with 3D shading.
+        
+        Args:
+            value (bool): True to display the group box with 3D shading; otherwise, False.
+        """
         GetDllLibXls().XlsGroupBoxShape_set_Display3DShading.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsGroupBoxShape_set_Display3DShading, self.Ptr, value)
 
     @property
 
     def Text(self)->str:
-        """
-
+        """Gets or sets the text displayed in the group box.
+        
+        Returns:
+            str: The text displayed in the group box.
         """
         GetDllLibXls().XlsGroupBoxShape_get_Text.argtypes=[c_void_p]
         GetDllLibXls().XlsGroupBoxShape_get_Text.restype=c_void_p
@@ -39,13 +51,20 @@ class XlsGroupBoxShape (  XlsShape, IGroupBox) :
 
     @Text.setter
     def Text(self, value:str):
+        """Sets the text displayed in the group box.
+        
+        Args:
+            value (str): The text to display in the group box.
+        """
         GetDllLibXls().XlsGroupBoxShape_set_Text.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsGroupBoxShape_set_Text, self.Ptr, value)
 
     @property
     def IsTextLocked(self)->bool:
-        """
-
+        """Gets or sets whether the text in the group box is locked.
+        
+        Returns:
+            bool: True if the text is locked; otherwise, False.
         """
         GetDllLibXls().XlsGroupBoxShape_get_IsTextLocked.argtypes=[c_void_p]
         GetDllLibXls().XlsGroupBoxShape_get_IsTextLocked.restype=c_bool
@@ -54,14 +73,21 @@ class XlsGroupBoxShape (  XlsShape, IGroupBox) :
 
     @IsTextLocked.setter
     def IsTextLocked(self, value:bool):
+        """Sets whether the text in the group box is locked.
+        
+        Args:
+            value (bool): True to lock the text; otherwise, False.
+        """
         GetDllLibXls().XlsGroupBoxShape_set_IsTextLocked.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsGroupBoxShape_set_IsTextLocked, self.Ptr, value)
 
     @property
 
     def ShapeType(self)->'ExcelShapeType':
-        """
-
+        """Gets the type of the shape.
+        
+        Returns:
+            ExcelShapeType: An enumeration value representing the type of the shape.
         """
         GetDllLibXls().XlsGroupBoxShape_get_ShapeType.argtypes=[c_void_p]
         GetDllLibXls().XlsGroupBoxShape_get_ShapeType.restype=c_int

spire/xls/XlsHPageBreak.py

@@ -7,15 +7,18 @@ from ctypes import *
 import abc
 
 class XlsHPageBreak (  XlsObject) :
-    """
-
+    """Represents a horizontal page break in an Excel worksheet.
+    
+    This class provides properties and methods for manipulating horizontal page breaks
+    in Excel worksheets, including position, extent, and type settings. It extends
+    the XlsObject class to provide page break specific functionality.
     """
     @property
     def Row(self)->int:
-        """
-    <summary>
-        Gets the row index. 
-    </summary>
+        """Gets the row index where the horizontal page break is located.
+        
+        Returns:
+            int: The zero-based row index of the page break.
         """
         GetDllLibXls().XlsHPageBreak_get_Row.argtypes=[c_void_p]
         GetDllLibXls().XlsHPageBreak_get_Row.restype=c_int
@@ -25,10 +28,10 @@ class XlsHPageBreak (  XlsObject) :
     @property
 
     def Type(self)->'PageBreakType':
-        """
-    <summary>
-        Type of the page break.
-    </summary>
+        """Gets or sets the type of the page break.
+        
+        Returns:
+            PageBreakType: An enumeration value representing the type of page break.
         """
         GetDllLibXls().XlsHPageBreak_get_Type.argtypes=[c_void_p]
         GetDllLibXls().XlsHPageBreak_get_Type.restype=c_int
@@ -38,15 +41,20 @@ class XlsHPageBreak (  XlsObject) :
 
     @Type.setter
     def Type(self, value:'PageBreakType'):
+        """Sets the type of the page break.
+        
+        Args:
+            value (PageBreakType): An enumeration value representing the type of page break.
+        """
         GetDllLibXls().XlsHPageBreak_set_Type.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsHPageBreak_set_Type, self.Ptr, value.value)
 
     @property
     def StartColumn(self)->int:
-        """
-    <summary>
-        Gets the start column index of this horizontal page break
-    </summary>
+        """Gets or sets the starting column index of this horizontal page break.
+        
+        Returns:
+            int: The zero-based starting column index of the page break.
         """
         GetDllLibXls().XlsHPageBreak_get_StartColumn.argtypes=[c_void_p]
         GetDllLibXls().XlsHPageBreak_get_StartColumn.restype=c_int
@@ -55,15 +63,20 @@ class XlsHPageBreak (  XlsObject) :
 
     @StartColumn.setter
     def StartColumn(self, value:int):
+        """Sets the starting column index of this horizontal page break.
+        
+        Args:
+            value (int): The zero-based starting column index of the page break.
+        """
         GetDllLibXls().XlsHPageBreak_set_StartColumn.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsHPageBreak_set_StartColumn, self.Ptr, value)
 
     @property
     def EndColumn(self)->int:
-        """
-    <summary>
-        Gets the end column index of this horizontal page break. 
-    </summary>
+        """Gets or sets the ending column index of this horizontal page break.
+        
+        Returns:
+            int: The zero-based ending column index of the page break.
         """
         GetDllLibXls().XlsHPageBreak_get_EndColumn.argtypes=[c_void_p]
         GetDllLibXls().XlsHPageBreak_get_EndColumn.restype=c_int
@@ -72,16 +85,21 @@ class XlsHPageBreak (  XlsObject) :
 
     @EndColumn.setter
     def EndColumn(self, value:int):
+        """Sets the ending column index of this horizontal page break.
+        
+        Args:
+            value (int): The zero-based ending column index of the page break.
+        """
         GetDllLibXls().XlsHPageBreak_set_EndColumn.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsHPageBreak_set_EndColumn, self.Ptr, value)
 
     @property
 
     def Extent(self)->'PageBreakExtentType':
-        """
-    <summary>
-        Returns page break extent.
-    </summary>
+        """Gets the extent type of the page break.
+        
+        Returns:
+            PageBreakExtentType: An enumeration value representing the extent of the page break.
         """
         GetDllLibXls().XlsHPageBreak_get_Extent.argtypes=[c_void_p]
         GetDllLibXls().XlsHPageBreak_get_Extent.restype=c_int
@@ -91,8 +109,13 @@ class XlsHPageBreak (  XlsObject) :
 
 
     def Clone(self ,parent:'SpireObject')->'XlsHPageBreak':
-        """
-
+        """Creates a clone of this horizontal page break.
+        
+        Args:
+            parent (SpireObject): The parent object for the cloned page break.
+            
+        Returns:
+            XlsHPageBreak: A new XlsHPageBreak object that is a copy of this instance.
         """
         intPtrparent:c_void_p = parent.Ptr