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

spire/xls/LOGFONT.py

@@ -7,12 +7,20 @@ from ctypes import *
 import abc
 
 class LOGFONT (SpireObject) :
-    """
-
+    """Represents a logical font structure that defines the attributes of a font.
+    
+    This class encapsulates the properties of a font, including its height, width, weight,
+    orientation, and other characteristics. It is used to specify the visual attributes
+    of text in Excel worksheets and charts.
     """
     def lfHeight(self)->int:
-        """
-
+        """Gets the height of the font in logical units.
+        
+        A positive value specifies the cell height of the font. A negative value specifies
+        the character height of the font.
+        
+        Returns:
+            int: The height of the font.
         """
         GetDllLibXls().LOGFONT_lfHeight.argtypes=[c_void_p]
         GetDllLibXls().LOGFONT_lfHeight.restype=c_int
@@ -20,8 +28,10 @@ class LOGFONT (SpireObject) :
         return ret
 
     def lfWidth(self)->int:
-        """
-
+        """Gets the average width of characters in the font.
+        
+        Returns:
+            int: The average width of characters in the font.
         """
         GetDllLibXls().LOGFONT_lfWidth.argtypes=[c_void_p]
         GetDllLibXls().LOGFONT_lfWidth.restype=c_int
@@ -29,8 +39,10 @@ class LOGFONT (SpireObject) :
         return ret
 
     def lfEscapement(self)->int:
-        """
-
+        """Gets the angle, in tenths of degrees, between the baseline of a font and the x-axis.
+        
+        Returns:
+            int: The angle of escapement for the font.
         """
         GetDllLibXls().LOGFONT_lfEscapement.argtypes=[c_void_p]
         GetDllLibXls().LOGFONT_lfEscapement.restype=c_int
@@ -38,8 +50,10 @@ class LOGFONT (SpireObject) :
         return ret
 
     def lfOrientation(self)->int:
-        """
-
+        """Gets the angle, in tenths of degrees, between each character's baseline and the x-axis.
+        
+        Returns:
+            int: The orientation angle of the font.
         """
         GetDllLibXls().LOGFONT_lfOrientation.argtypes=[c_void_p]
         GetDllLibXls().LOGFONT_lfOrientation.restype=c_int
@@ -47,8 +61,14 @@ class LOGFONT (SpireObject) :
         return ret
 
     def lfWeight(self)->int:
-        """
-
+        """Gets the weight of the font in the range 0 through 1000.
+        
+        Common values are:
+        - 400: Normal
+        - 700: Bold
+        
+        Returns:
+            int: The weight of the font.
         """
         GetDllLibXls().LOGFONT_lfWeight.argtypes=[c_void_p]
         GetDllLibXls().LOGFONT_lfWeight.restype=c_int
@@ -56,8 +76,10 @@ class LOGFONT (SpireObject) :
         return ret
 
     def lfItalic(self)->int:
-        """
-
+        """Gets a value indicating whether the font is italic.
+        
+        Returns:
+            int: Nonzero if the font is italic; otherwise, 0.
         """
         GetDllLibXls().LOGFONT_lfItalic.argtypes=[c_void_p]
         GetDllLibXls().LOGFONT_lfItalic.restype=c_int
@@ -65,8 +87,10 @@ class LOGFONT (SpireObject) :
         return ret
 
     def lfUnderline(self)->int:
-        """
-
+        """Gets a value indicating whether the font is underlined.
+        
+        Returns:
+            int: Nonzero if the font is underlined; otherwise, 0.
         """
         GetDllLibXls().LOGFONT_lfUnderline.argtypes=[c_void_p]
         GetDllLibXls().LOGFONT_lfUnderline.restype=c_int
@@ -74,8 +98,10 @@ class LOGFONT (SpireObject) :
         return ret
 
     def lfStrikeOut(self)->int:
-        """
-
+        """Gets a value indicating whether the font has a strikeout.
+        
+        Returns:
+            int: Nonzero if the font has a strikeout; otherwise, 0.
         """
         GetDllLibXls().LOGFONT_lfStrikeOut.argtypes=[c_void_p]
         GetDllLibXls().LOGFONT_lfStrikeOut.restype=c_int
@@ -83,8 +109,10 @@ class LOGFONT (SpireObject) :
         return ret
 
     def lfCharSet(self)->int:
-        """
-
+        """Gets the character set of the font.
+        
+        Returns:
+            int: The character set identifier.
         """
         GetDllLibXls().LOGFONT_lfCharSet.argtypes=[c_void_p]
         GetDllLibXls().LOGFONT_lfCharSet.restype=c_int
@@ -92,8 +120,13 @@ class LOGFONT (SpireObject) :
         return ret
 
     def lfOutPrecision(self)->int:
-        """
-
+        """Gets the output precision for the font.
+        
+        The output precision defines how closely the output must match the requested font's height,
+        width, character orientation, escapement, pitch, and font type.
+        
+        Returns:
+            int: The output precision value.
         """
         GetDllLibXls().LOGFONT_lfOutPrecision.argtypes=[c_void_p]
         GetDllLibXls().LOGFONT_lfOutPrecision.restype=c_int
@@ -101,8 +134,12 @@ class LOGFONT (SpireObject) :
         return ret
 
     def lfClipPrecision(self)->int:
-        """
-
+        """Gets the clipping precision for the font.
+        
+        The clipping precision defines how to clip characters that are partially outside the clipping region.
+        
+        Returns:
+            int: The clipping precision value.
         """
         GetDllLibXls().LOGFONT_lfClipPrecision.argtypes=[c_void_p]
         GetDllLibXls().LOGFONT_lfClipPrecision.restype=c_int
@@ -110,8 +147,13 @@ class LOGFONT (SpireObject) :
         return ret
 
     def lfQuality(self)->int:
-        """
-
+        """Gets the output quality for the font.
+        
+        The output quality defines how carefully the graphics device interface (GDI) 
+        must draw the output to match the characteristics of the selected font.
+        
+        Returns:
+            int: The output quality value.
         """
         GetDllLibXls().LOGFONT_lfQuality.argtypes=[c_void_p]
         GetDllLibXls().LOGFONT_lfQuality.restype=c_int
@@ -119,8 +161,12 @@ class LOGFONT (SpireObject) :
         return ret
 
     def lfPitchAndFamily(self)->int:
-        """
-
+        """Gets the pitch and family of the font.
+        
+        The low-order bit specifies the pitch of the font, and the high-order bit specifies the font family.
+        
+        Returns:
+            int: The pitch and family value.
         """
         GetDllLibXls().LOGFONT_lfPitchAndFamily.argtypes=[c_void_p]
         GetDllLibXls().LOGFONT_lfPitchAndFamily.restype=c_int
@@ -129,8 +175,10 @@ class LOGFONT (SpireObject) :
 
 
     def lfFaceName(self)->str:
-        """
-
+        """Gets the typeface name of the font.
+        
+        Returns:
+            str: The typeface name of the font.
         """
         GetDllLibXls().LOGFONT_lfFaceName.argtypes=[c_void_p]
         GetDllLibXls().LOGFONT_lfFaceName.restype=c_void_p

spire/xls/OColor.py

@@ -8,16 +8,14 @@ import abc
 
 class OColor (SpireObject) :
     """
-    <summary>
-        This object used to store, convert colors.
-    </summary>
+    This object used to store, convert colors.
+
     """
     @property
     def Value(self)->int:
         """
-    <summary>
         Returns color value (it can be index, rgb color, etc.)
-    </summary>
+
         """
         GetDllLibXls().OColor_get_Value.argtypes=[c_void_p]
         GetDllLibXls().OColor_get_Value.restype=c_int
@@ -27,9 +25,8 @@ class OColor (SpireObject) :
     @property
     def Tint(self)->float:
         """
-    <summary>
         Gets or sets Tint.
-    </summary>
+
         """
         GetDllLibXls().OColor_get_Tint.argtypes=[c_void_p]
         GetDllLibXls().OColor_get_Tint.restype=c_double
@@ -45,9 +42,8 @@ class OColor (SpireObject) :
 
     def ColorType(self)->'ColorType':
         """
-    <summary>
         Returns type of the stored color.
-    </summary>
+
         """
         GetDllLibXls().OColor_get_ColorType.argtypes=[c_void_p]
         GetDllLibXls().OColor_get_ColorType.restype=c_int
@@ -57,10 +53,11 @@ class OColor (SpireObject) :
 
     def GetHashCode(self)->int:
         """
-    <summary>
         Returns the hash code for this instance.
-    </summary>
-    <returns>A 32-bit signed integer hash code.</returns>
+
+        Returns:
+            A 32-bit signed integer hash code.
+
         """
         GetDllLibXls().OColor_GetHashCode.argtypes=[c_void_p]
         GetDllLibXls().OColor_GetHashCode.restype=c_int
@@ -70,8 +67,13 @@ class OColor (SpireObject) :
     @dispatch
 
     def SetTheme(self ,themeIndex:int,book:IWorkbook):
-        """
-
+        """Sets the color to a theme color.
+        
+        This method sets the color to a predefined theme color from the workbook's theme.
+        
+        Args:
+            themeIndex (int): The index of the theme color.
+            book (IWorkbook): The workbook containing the theme colors.
         """
         intPtrbook:c_void_p = book.Ptr
 
@@ -81,8 +83,17 @@ class OColor (SpireObject) :
     @dispatch
 
     def SetTheme(self ,themeIndex:int,book:IWorkbook,dTintValue:float):
-        """
-
+        """Sets the color to a theme color with a specified tint value.
+        
+        This method sets the color to a predefined theme color from the workbook's theme
+        and applies the specified tint value to lighten or darken the color.
+        
+        Args:
+            themeIndex (int): The index of the theme color.
+            book (IWorkbook): The workbook containing the theme colors.
+            dTintValue (float): The tint value to apply to the theme color. 
+                               Positive values lighten the color, negative values darken it.
+                               Value should be between -1.0 and 1.0.
         """
         intPtrbook:c_void_p = book.Ptr
 
@@ -105,8 +116,17 @@ class OColor (SpireObject) :
 
 
     def SetRGB(self ,rgb:'Color',book:'IWorkbook',dTintValue:float):
-        """
-
+        """Sets the color to an RGB color with a specified tint value.
+        
+        This method sets the color to the specified RGB color and applies the
+        specified tint value to lighten or darken the color.
+        
+        Args:
+            rgb (Color): The RGB color to set.
+            book (IWorkbook): The workbook context for the color.
+            dTintValue (float): The tint value to apply to the color.
+                               Positive values lighten the color, negative values darken it.
+                               Value should be between -1.0 and 1.0.
         """
         intPtrrgb:c_void_p = rgb.Ptr
         intPtrbook:c_void_p = book.Ptr
@@ -117,10 +137,11 @@ class OColor (SpireObject) :
 
     def SetKnownColor(self ,value:'ExcelColors'):
         """
-    <summary>
         Sets known color.
-    </summary>
-    <param name="value">Excel color to set.</param>
+
+        Args:
+            value: Excel color to set.
+
         """
         enumvalue:c_int = value.value
 
@@ -129,8 +150,15 @@ class OColor (SpireObject) :
 
 
     def GetKnownColor(self ,book:'Workbook')->'ExcelColors':
-        """
-
+        """Gets the Excel known color equivalent of this color.
+        
+        This method attempts to match this color to one of the predefined Excel colors.
+        
+        Args:
+            book (Workbook): The workbook context for the color.
+            
+        Returns:
+            ExcelColors: An enumeration value representing the Excel known color.
         """
         intPtrbook:c_void_p = book.Ptr
 
@@ -141,8 +169,10 @@ class OColor (SpireObject) :
         return objwraped
 
     def Dispose(self):
-        """
-
+        """Releases all resources used by the OColor object.
+        
+        This method performs necessary cleanup operations and should be called
+        when the object is no longer needed.
         """
         GetDllLibXls().OColor_Dispose.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().OColor_Dispose, self.Ptr)
@@ -150,11 +180,14 @@ class OColor (SpireObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-    <summary>
         Determines whether the specified Object is equal to the current Object.
-    </summary>
-    <param name="obj">The Object to compare with the current Object.</param>
-    <returns>true if the specified Object is equal to the current Object; otherwise, false.</returns>
+
+        Args:
+            obj: The Object to compare with the current Object.
+
+        Returns:
+            true if the specified Object is equal to the current Object; otherwise, false.
+
         """
         intPtrobj:c_void_p = obj.Ptr
 

spire/xls/OdsPageBackground.py

@@ -14,9 +14,8 @@ class OdsPageBackground (SpireObject) :
 
     def Type(self)->'OdsPageBackgroundType':
         """
-    <summary>
         Gets the type of background. Read-only.
-    </summary>
+
         """
         GetDllLibXls().OdsPageBackground_get_Type.argtypes=[c_void_p]
         GetDllLibXls().OdsPageBackground_get_Type.restype=c_int
@@ -28,9 +27,8 @@ class OdsPageBackground (SpireObject) :
 
     def Color(self)->'Color':
         """
-    <summary>
         Gets/sets the color of background.
-    </summary>
+
         """
         GetDllLibXls().OdsPageBackground_get_Color.argtypes=[c_void_p]
         GetDllLibXls().OdsPageBackground_get_Color.restype=c_void_p
@@ -74,9 +72,8 @@ class OdsPageBackground (SpireObject) :
 
     def ImageLink(self)->str:
         """
-    <summary>
         Gets/sets the link file path of image.
-    </summary>
+
         """
         GetDllLibXls().OdsPageBackground_get_ImageLink.argtypes=[c_void_p]
         GetDllLibXls().OdsPageBackground_get_ImageLink.restype=c_void_p
@@ -93,9 +90,8 @@ class OdsPageBackground (SpireObject) :
 
     def ImageType(self)->'OdsPageBackgroundImageType':
         """
-    <summary>
         Gets/sets the image type of image background.
-    </summary>
+
         """
         GetDllLibXls().OdsPageBackground_get_ImageType.argtypes=[c_void_p]
         GetDllLibXls().OdsPageBackground_get_ImageType.restype=c_int
@@ -112,9 +108,8 @@ class OdsPageBackground (SpireObject) :
 
     def ImagePositonType(self)->'OdsPageBackgroundImagePositionType':
         """
-    <summary>
         Gets/sets the position type of image background.
-    </summary>
+
         """
         GetDllLibXls().OdsPageBackground_get_ImagePositonType.argtypes=[c_void_p]
         GetDllLibXls().OdsPageBackground_get_ImagePositonType.restype=c_int

spire/xls/PageColRow.py

@@ -7,12 +7,17 @@ from ctypes import *
 import abc
 
 class PageColRow (SpireObject) :
-    """
-
+    """Represents the column and row information for a page in Excel.
+    
+    This class encapsulates the starting and ending row and column indices for a page
+    in an Excel worksheet. It is used to define the boundaries of a page for printing
+    and pagination purposes.
     """
     def StartRow(self)->int:
-        """
-
+        """Gets the starting row index of the page.
+        
+        Returns:
+            int: The zero-based index of the first row on the page.
         """
         GetDllLibXls().PageColRow_StartRow.argtypes=[c_void_p]
         GetDllLibXls().PageColRow_StartRow.restype=c_int
@@ -20,8 +25,10 @@ class PageColRow (SpireObject) :
         return ret
 
     def EndRow(self)->int:
-        """
-
+        """Gets the ending row index of the page.
+        
+        Returns:
+            int: The zero-based index of the last row on the page.
         """
         GetDllLibXls().PageColRow_EndRow.argtypes=[c_void_p]
         GetDllLibXls().PageColRow_EndRow.restype=c_int
@@ -29,8 +36,10 @@ class PageColRow (SpireObject) :
         return ret
 
     def StartCol(self)->int:
-        """
-
+        """Gets the starting column index of the page.
+        
+        Returns:
+            int: The zero-based index of the first column on the page.
         """
         GetDllLibXls().PageColRow_StartCol.argtypes=[c_void_p]
         GetDllLibXls().PageColRow_StartCol.restype=c_int
@@ -38,8 +47,10 @@ class PageColRow (SpireObject) :
         return ret
 
     def EndCol(self)->int:
-        """
-
+        """Gets the ending column index of the page.
+        
+        Returns:
+            int: The zero-based index of the last column on the page.
         """
         GetDllLibXls().PageColRow_EndCol.argtypes=[c_void_p]
         GetDllLibXls().PageColRow_EndCol.restype=c_int

spire/xls/PageSetup.py

@@ -8,7 +8,6 @@ import abc
 
 class PageSetup (  XlsPageSetup) :
     """
-    <summary>
-        Represents the page setup description. The PageSetup object contains all page setup attributes (left margin, bottom margin, paper size, and so on) as properties.
-    </summary>
+    Represents the page setup description. The PageSetup object contains all page setup attributes (left margin, bottom margin, paper size, and so on) as properties.
+
     """

spire/xls/PaperSizeEntry.py

@@ -12,7 +12,10 @@ class PaperSizeEntry (SpireObject) :
     """
     def Width(self)->float:
         """
+        Gets the width of the paper size.
 
+        Returns:
+            float: The width of the paper size.
         """
         GetDllLibXls().PaperSizeEntry_Width.argtypes=[c_void_p]
         GetDllLibXls().PaperSizeEntry_Width.restype=c_double
@@ -21,7 +24,10 @@ class PaperSizeEntry (SpireObject) :
 
     def Height(self)->float:
         """
+        Gets the height of the paper size.
 
+        Returns:
+            float: The height of the paper size.
         """
         GetDllLibXls().PaperSizeEntry_Height.argtypes=[c_void_p]
         GetDllLibXls().PaperSizeEntry_Height.restype=c_double

spire/xls/PicStretch.py

@@ -7,14 +7,22 @@ from ctypes import *
 import abc
 
 class PicStretch (SpireObject) :
-    """
-
+    """Represents picture stretching settings for a fill picture in Excel.
+    
+    This class encapsulates the properties that control how a picture is stretched or positioned
+    when used as a fill for shapes, cells, or other Excel objects. It allows for configuring
+    the picture's positioning, scaling, and display type.
     """
     @property
 
     def Type(self)->'FillPictureType':
-        """
-
+        """Gets or sets the type of picture fill.
+        
+        Determines how the picture is displayed within the filled area, such as
+        stretched, tiled, or positioned at specific locations.
+        
+        Returns:
+            FillPictureType: An enumeration value representing the picture fill type.
         """
         GetDllLibXls().PicStretch_get_Type.argtypes=[c_void_p]
         GetDllLibXls().PicStretch_get_Type.restype=c_int
@@ -29,8 +37,13 @@ class PicStretch (SpireObject) :
 
     @property
     def Scale(self)->float:
-        """
-
+        """Gets or sets the scale factor for the picture.
+        
+        A value of 1.0 represents 100% (original size). Values greater than 1.0 enlarge
+        the picture, while values less than 1.0 reduce it.
+        
+        Returns:
+            float: The scale factor as a decimal value.
         """
         GetDllLibXls().PicStretch_get_Scale.argtypes=[c_void_p]
         GetDllLibXls().PicStretch_get_Scale.restype=c_double
@@ -44,8 +57,13 @@ class PicStretch (SpireObject) :
 
     @property
     def Left(self)->float:
-        """
-
+        """Gets or sets the left offset of the picture as a percentage of the fill area.
+        
+        A value of 0.0 aligns the left edge of the picture with the left edge of the fill area.
+        Values are between 0.0 and 1.0, where 1.0 represents 100% of the fill area width.
+        
+        Returns:
+            float: The left offset as a decimal value.
         """
         GetDllLibXls().PicStretch_get_Left.argtypes=[c_void_p]
         GetDllLibXls().PicStretch_get_Left.restype=c_double
@@ -59,8 +77,13 @@ class PicStretch (SpireObject) :
 
     @property
     def Top(self)->float:
-        """
-
+        """Gets or sets the top offset of the picture as a percentage of the fill area.
+        
+        A value of 0.0 aligns the top edge of the picture with the top edge of the fill area.
+        Values are between 0.0 and 1.0, where 1.0 represents 100% of the fill area height.
+        
+        Returns:
+            float: The top offset as a decimal value.
         """
         GetDllLibXls().PicStretch_get_Top.argtypes=[c_void_p]
         GetDllLibXls().PicStretch_get_Top.restype=c_double
@@ -74,8 +97,13 @@ class PicStretch (SpireObject) :
 
     @property
     def Bottom(self)->float:
-        """
-
+        """Gets or sets the bottom offset of the picture as a percentage of the fill area.
+        
+        A value of 1.0 aligns the bottom edge of the picture with the bottom edge of the fill area.
+        Values are between 0.0 and 1.0, where 1.0 represents 100% of the fill area height.
+        
+        Returns:
+            float: The bottom offset as a decimal value.
         """
         GetDllLibXls().PicStretch_get_Bottom.argtypes=[c_void_p]
         GetDllLibXls().PicStretch_get_Bottom.restype=c_double
@@ -89,8 +117,13 @@ class PicStretch (SpireObject) :
 
     @property
     def Right(self)->float:
-        """
-
+        """Gets or sets the right offset of the picture as a percentage of the fill area.
+        
+        A value of 1.0 aligns the right edge of the picture with the right edge of the fill area.
+        Values are between 0.0 and 1.0, where 1.0 represents 100% of the fill area width.
+        
+        Returns:
+            float: The right offset as a decimal value.
         """
         GetDllLibXls().PicStretch_get_Right.argtypes=[c_void_p]
         GetDllLibXls().PicStretch_get_Right.restype=c_double