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

spire/xls/XlsBitmapShape.py

@@ -7,14 +7,19 @@ from ctypes import *
 import abc
 
 class XlsBitmapShape (  XlsShape, IPictureShape) :
-    """
-
+    """Represents a bitmap/picture shape in an Excel worksheet.
+    
+    This class provides properties and methods for manipulating picture shapes in Excel,
+    including image manipulation, cropping, and formatting. It extends XlsShape and
+    implements the IPictureShape interface.
     """
 
     @dispatch
     def Remove(self ,removeImage:bool):
-        """
-
+        """Removes the bitmap shape from the worksheet.
+        
+        Args:
+            removeImage (bool): True to remove the underlying image data; False to keep it.
         """
         
         GetDllLibXls().XlsBitmapShape_Remove.argtypes=[c_void_p ,c_bool]
@@ -23,8 +28,10 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
     @property
 
     def BlipId(self)->'UInt32':
-        """
-
+        """Gets the blip identifier for the bitmap.
+        
+        Returns:
+            UInt32: The blip identifier for the bitmap.
         """
         GetDllLibXls().XlsBitmapShape_get_BlipId.argtypes=[c_void_p]
         GetDllLibXls().XlsBitmapShape_get_BlipId.restype=c_void_p
@@ -36,8 +43,10 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
     @property
 
     def ColorTo(self)->'Color':
-        """
-
+        """Gets or sets the ending color for gradient effect.
+        
+        Returns:
+            Color: The ending color for gradient effect.
         """
         GetDllLibXls().XlsBitmapShape_get_ColorTo.argtypes=[c_void_p]
         GetDllLibXls().XlsBitmapShape_get_ColorTo.restype=c_void_p
@@ -48,14 +57,21 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
 
     @ColorTo.setter
     def ColorTo(self, value:'Color'):
+        """Sets the ending color for gradient effect.
+        
+        Args:
+            value (Color): The ending color for gradient effect.
+        """
         GetDllLibXls().XlsBitmapShape_set_ColorTo.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsBitmapShape_set_ColorTo, self.Ptr, value.Ptr)
 
     @property
 
     def RefRange(self)->str:
-        """
-
+        """Gets or sets the reference range for the bitmap shape.
+        
+        Returns:
+            str: The reference range for the bitmap shape.
         """
         GetDllLibXls().XlsBitmapShape_get_RefRange.argtypes=[c_void_p]
         GetDllLibXls().XlsBitmapShape_get_RefRange.restype=c_void_p
@@ -65,13 +81,20 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
 
     @RefRange.setter
     def RefRange(self, value:str):
+        """Sets the reference range for the bitmap shape.
+        
+        Args:
+            value (str): The reference range for the bitmap shape.
+        """
         GetDllLibXls().XlsBitmapShape_set_RefRange.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsBitmapShape_set_RefRange, self.Ptr, value)
 
     @property
     def IsDDE(self)->bool:
-        """
-
+        """Gets or sets whether the bitmap is a DDE (Dynamic Data Exchange) object.
+        
+        Returns:
+            bool: True if the bitmap is a DDE object; otherwise, False.
         """
         GetDllLibXls().XlsBitmapShape_get_IsDDE.argtypes=[c_void_p]
         GetDllLibXls().XlsBitmapShape_get_IsDDE.restype=c_bool
@@ -80,13 +103,20 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
 
     @IsDDE.setter
     def IsDDE(self, value:bool):
+        """Sets whether the bitmap is a DDE (Dynamic Data Exchange) object.
+        
+        Args:
+            value (bool): True to set as DDE object; otherwise, False.
+        """
         GetDllLibXls().XlsBitmapShape_set_IsDDE.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsBitmapShape_set_IsDDE, self.Ptr, value)
 
     @property
     def IsCamera(self)->bool:
-        """
-
+        """Gets or sets whether the bitmap is a camera object.
+        
+        Returns:
+            bool: True if the bitmap is a camera object; otherwise, False.
         """
         GetDllLibXls().XlsBitmapShape_get_IsCamera.argtypes=[c_void_p]
         GetDllLibXls().XlsBitmapShape_get_IsCamera.restype=c_bool
@@ -95,14 +125,21 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
 
     @IsCamera.setter
     def IsCamera(self, value:bool):
+        """Sets whether the bitmap is a camera object.
+        
+        Args:
+            value (bool): True to set as camera object; otherwise, False.
+        """
         GetDllLibXls().XlsBitmapShape_set_IsCamera.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsBitmapShape_set_IsCamera, self.Ptr, value)
 
     @property
 
     def ColorFrom(self)->'Color':
-        """
-
+        """Gets or sets the starting color for gradient effect.
+        
+        Returns:
+            Color: The starting color for gradient effect.
         """
         GetDllLibXls().XlsBitmapShape_get_ColorFrom.argtypes=[c_void_p]
         GetDllLibXls().XlsBitmapShape_get_ColorFrom.restype=c_void_p
@@ -113,14 +150,21 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
 
     @ColorFrom.setter
     def ColorFrom(self, value:'Color'):
+        """Sets the starting color for gradient effect.
+        
+        Args:
+            value (Color): The starting color for gradient effect.
+        """
         GetDllLibXls().XlsBitmapShape_set_ColorFrom.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsBitmapShape_set_ColorFrom, self.Ptr, value.Ptr)
 
     @property
 
     def FileName(self)->str:
-        """
-
+        """Gets or sets the file name of the bitmap image.
+        
+        Returns:
+            str: The file name of the bitmap image.
         """
         GetDllLibXls().XlsBitmapShape_get_FileName.argtypes=[c_void_p]
         GetDllLibXls().XlsBitmapShape_get_FileName.restype=c_void_p
@@ -130,14 +174,21 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
 
     @FileName.setter
     def FileName(self, value:str):
+        """Sets the file name of the bitmap image.
+        
+        Args:
+            value (str): The file name of the bitmap image.
+        """
         GetDllLibXls().XlsBitmapShape_set_FileName.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsBitmapShape_set_FileName, self.Ptr, value)
 
     @property
 
     def Picture(self)->'Stream':
-        """
-
+        """Gets or sets the picture data as a stream.
+        
+        Returns:
+            Stream: The picture data as a stream.
         """
         GetDllLibXls().XlsBitmapShape_get_Picture.argtypes=[c_void_p]
         GetDllLibXls().XlsBitmapShape_get_Picture.restype=c_void_p
@@ -148,16 +199,20 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
 
     @Picture.setter
     def Picture(self, value:'Stream'):
+        """Sets the picture data from a stream.
+        
+        Args:
+            value (Stream): The picture data as a stream.
+        """
         GetDllLibXls().XlsBitmapShape_set_Picture.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsBitmapShape_set_Picture, self.Ptr, value.Ptr)
 
 
     def Compress(self ,quality:int):
-        """
-    <summary>
-        Compress the Picture quality for reduce file size
-    </summary>
-    <param name="quality">picture quality.Range is 0~100</param>
+        """Compresses the picture quality to reduce file size.
+
+        Args:
+            quality (int): Picture quality, range is 0-100 (higher values mean better quality).
         """
         
         GetDllLibXls().XlsBitmapShape_Compress.argtypes=[c_void_p ,c_int]
@@ -165,8 +220,10 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
 
     @property
     def CropLeftOffset(self)->int:
-        """
-
+        """Gets or sets the left cropping offset in pixels.
+        
+        Returns:
+            int: The left cropping offset in pixels.
         """
         GetDllLibXls().XlsBitmapShape_get_CropLeftOffset.argtypes=[c_void_p]
         GetDllLibXls().XlsBitmapShape_get_CropLeftOffset.restype=c_int
@@ -175,13 +232,20 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
 
     @CropLeftOffset.setter
     def CropLeftOffset(self, value:int):
+        """Sets the left cropping offset in pixels.
+        
+        Args:
+            value (int): The left cropping offset in pixels.
+        """
         GetDllLibXls().XlsBitmapShape_set_CropLeftOffset.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsBitmapShape_set_CropLeftOffset, self.Ptr, value)
 
     @property
     def CropRightOffset(self)->int:
-        """
-
+        """Gets or sets the right cropping offset in pixels.
+        
+        Returns:
+            int: The right cropping offset in pixels.
         """
         GetDllLibXls().XlsBitmapShape_get_CropRightOffset.argtypes=[c_void_p]
         GetDllLibXls().XlsBitmapShape_get_CropRightOffset.restype=c_int
@@ -190,13 +254,20 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
 
     @CropRightOffset.setter
     def CropRightOffset(self, value:int):
+        """Sets the right cropping offset in pixels.
+        
+        Args:
+            value (int): The right cropping offset in pixels.
+        """
         GetDllLibXls().XlsBitmapShape_set_CropRightOffset.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsBitmapShape_set_CropRightOffset, self.Ptr, value)
 
     @property
     def CropBottomOffset(self)->int:
-        """
-
+        """Gets or sets the bottom cropping offset in pixels.
+        
+        Returns:
+            int: The bottom cropping offset in pixels.
         """
         GetDllLibXls().XlsBitmapShape_get_CropBottomOffset.argtypes=[c_void_p]
         GetDllLibXls().XlsBitmapShape_get_CropBottomOffset.restype=c_int
@@ -205,13 +276,20 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
 
     @CropBottomOffset.setter
     def CropBottomOffset(self, value:int):
+        """Sets the bottom cropping offset in pixels.
+        
+        Args:
+            value (int): The bottom cropping offset in pixels.
+        """
         GetDllLibXls().XlsBitmapShape_set_CropBottomOffset.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsBitmapShape_set_CropBottomOffset, self.Ptr, value)
 
     @property
     def CropTopOffset(self)->int:
-        """
-
+        """Gets or sets the top cropping offset in pixels.
+        
+        Returns:
+            int: The top cropping offset in pixels.
         """
         GetDllLibXls().XlsBitmapShape_get_CropTopOffset.argtypes=[c_void_p]
         GetDllLibXls().XlsBitmapShape_get_CropTopOffset.restype=c_int
@@ -220,14 +298,21 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
 
     @CropTopOffset.setter
     def CropTopOffset(self, value:int):
+        """Sets the top cropping offset in pixels.
+        
+        Args:
+            value (int): The top cropping offset in pixels.
+        """
         GetDllLibXls().XlsBitmapShape_set_CropTopOffset.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsBitmapShape_set_CropTopOffset, self.Ptr, value)
 
     @property
 
     def Macro(self)->str:
-        """
-
+        """Gets or sets the macro associated with the bitmap shape.
+        
+        Returns:
+            str: The macro associated with the bitmap shape.
         """
         GetDllLibXls().XlsBitmapShape_get_Macro.argtypes=[c_void_p]
         GetDllLibXls().XlsBitmapShape_get_Macro.restype=c_void_p
@@ -237,14 +322,21 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
 
     @Macro.setter
     def Macro(self, value:str):
+        """Sets the macro associated with the bitmap shape.
+        
+        Args:
+            value (str): The macro associated with the bitmap shape.
+        """
         GetDllLibXls().XlsBitmapShape_set_Macro.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsBitmapShape_set_Macro, 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().XlsBitmapShape_get_ShapeType.argtypes=[c_void_p]
         GetDllLibXls().XlsBitmapShape_get_ShapeType.restype=c_int
@@ -253,24 +345,30 @@ class XlsBitmapShape (  XlsShape, IPictureShape) :
         return objwraped
 
     def Dispose(self):
-        """
-
+        """Releases all resources used by the bitmap shape.
+        
+        This method performs cleanup operations and releases memory resources used by the bitmap shape.
         """
         GetDllLibXls().XlsBitmapShape_Dispose.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().XlsBitmapShape_Dispose, self.Ptr)
 
 
     def SetHyperLink(self ,linkString:str,isExternal:bool):
-        """
-
+        """Sets a hyperlink for the bitmap shape.
+        
+        Args:
+            linkString (str): The URL or file path for the hyperlink.
+            isExternal (bool): True if the link is to an external resource; False if it's an internal link.
         """
         
         GetDllLibXls().XlsBitmapShape_SetHyperLink.argtypes=[c_void_p ,c_void_p,c_bool]
         CallCFunction(GetDllLibXls().XlsBitmapShape_SetHyperLink, self.Ptr, linkString,isExternal)
 
     def GetHyperLink(self)->'HyperLink':
-        """
-
+        """Gets the hyperlink associated with the bitmap shape.
+        
+        Returns:
+            HyperLink: An object representing the hyperlink associated with the bitmap shape.
         """
         from spire.xls import HyperLink
         GetDllLibXls().XlsBitmapShape_get_HyperLink.argtypes=[c_void_p]

spire/xls/XlsBorder.py

@@ -7,8 +7,11 @@ from ctypes import *
 import abc
 
 class XlsBorder (  XlsObject, IBorder) :
-    """
-
+    """Represents a border in an Excel worksheet.
+    
+    This class provides properties and methods for manipulating borders in Excel,
+    including accessing and modifying border colors, line styles, and diagonal lines.
+    It extends XlsObject and implements the IBorder interface.
     """
 #
 #    def GetThemeColor(self ,type:'ThemeColorType&',tint:'Double&')->bool:
@@ -26,8 +29,11 @@ class XlsBorder (  XlsObject, IBorder) :
 
 
     def SetThemeColor(self ,type:'ThemeColorType',tint:float):
-        """
-
+        """Sets a theme color for the border.
+        
+        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
 
@@ -37,10 +43,10 @@ class XlsBorder (  XlsObject, IBorder) :
     @property
 
     def KnownColor(self)->'ExcelColors':
-        """
-    <summary>
-        Returns or sets a ExcelColors value that represents the color of the border
-    </summary>
+        """Gets or sets a predefined Excel color for the border.
+        
+        Returns:
+            ExcelColors: An enumeration value representing the Excel color.
         """
         GetDllLibXls().XlsBorder_get_KnownColor.argtypes=[c_void_p]
         GetDllLibXls().XlsBorder_get_KnownColor.restype=c_int
@@ -50,15 +56,23 @@ class XlsBorder (  XlsObject, IBorder) :
 
     @KnownColor.setter
     def KnownColor(self, value:'ExcelColors'):
+        """Sets a predefined Excel color for the border.
+        
+        Args:
+            value (ExcelColors): An enumeration value representing the Excel color.
+        """
         GetDllLibXls().XlsBorder_set_KnownColor.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsBorder_set_KnownColor, self.Ptr, value.value)
 
     @property
 
     def OColor(self)->'OColor':
+        """Gets the Office color of the border.
+        
+        Returns:
+            OColor: An object representing the Office color.
         """
-
-        """
+        from spire.xls.OColor import OColor
         GetDllLibXls().XlsBorder_get_OColor.argtypes=[c_void_p]
         GetDllLibXls().XlsBorder_get_OColor.restype=c_void_p
         intPtr = CallCFunction(GetDllLibXls().XlsBorder_get_OColor, self.Ptr)
@@ -69,11 +83,12 @@ class XlsBorder (  XlsObject, IBorder) :
     @property
 
     def Color(self)->'Color':
-        """
-    <summary>
-        Returns or sets the primary color of the object, as shown in the table in the remarks section. Use the RGB function to create a color value. 
-            Read/write Color.
-    </summary>
+        """Gets or sets the primary color of the border.
+        
+        Use the RGB function to create a color value.
+        
+        Returns:
+            Color: A Color object representing the border color.
         """
         GetDllLibXls().XlsBorder_get_Color.argtypes=[c_void_p]
         GetDllLibXls().XlsBorder_get_Color.restype=c_void_p
@@ -84,16 +99,21 @@ class XlsBorder (  XlsObject, IBorder) :
 
     @Color.setter
     def Color(self, value:'Color'):
+        """Sets the primary color of the border.
+        
+        Args:
+            value (Color): A Color object representing the border color.
+        """
         GetDllLibXls().XlsBorder_set_Color.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsBorder_set_Color, self.Ptr, value.Ptr)
 
     @property
 
     def LineStyle(self)->'LineStyleType':
-        """
-    <summary>
-        Returns or sets the line style for the border. Read/write LineStyleType.
-    </summary>
+        """Gets or sets the line style for the border.
+        
+        Returns:
+            LineStyleType: An enumeration value representing the line style.
         """
         GetDllLibXls().XlsBorder_get_LineStyle.argtypes=[c_void_p]
         GetDllLibXls().XlsBorder_get_LineStyle.restype=c_int
@@ -103,15 +123,20 @@ class XlsBorder (  XlsObject, IBorder) :
 
     @LineStyle.setter
     def LineStyle(self, value:'LineStyleType'):
+        """Sets the line style for the border.
+        
+        Args:
+            value (LineStyleType): An enumeration value representing the line style.
+        """
         GetDllLibXls().XlsBorder_set_LineStyle.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsBorder_set_LineStyle, self.Ptr, value.value)
 
     @property
     def ShowDiagonalLine(self)->bool:
-        """
-    <summary>
-        Indicates whether shows diagonal line.
-    </summary>
+        """Gets or sets a value indicating whether to show diagonal lines.
+        
+        Returns:
+            bool: True if diagonal lines are shown; otherwise, False.
         """
         GetDllLibXls().XlsBorder_get_ShowDiagonalLine.argtypes=[c_void_p]
         GetDllLibXls().XlsBorder_get_ShowDiagonalLine.restype=c_bool
@@ -120,14 +145,21 @@ class XlsBorder (  XlsObject, IBorder) :
 
     @ShowDiagonalLine.setter
     def ShowDiagonalLine(self, value:bool):
+        """Sets a value indicating whether to show diagonal lines.
+        
+        Args:
+            value (bool): True to show diagonal lines; otherwise, False.
+        """
         GetDllLibXls().XlsBorder_set_ShowDiagonalLine.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsBorder_set_ShowDiagonalLine, self.Ptr, value)
 
     @property
 
     def BorderIndex(self)->'BordersLineType':
-        """
-
+        """Gets the border index indicating which side of the cell this border represents.
+        
+        Returns:
+            BordersLineType: An enumeration value representing the border position.
         """
         GetDllLibXls().XlsBorder_get_BorderIndex.argtypes=[c_void_p]
         GetDllLibXls().XlsBorder_get_BorderIndex.restype=c_int
@@ -138,8 +170,13 @@ class XlsBorder (  XlsObject, IBorder) :
     @staticmethod
 
     def ColorToExcelColor(color:'ExcelColors')->'ExcelColors':
-        """
-
+        """Converts a color to an Excel color.
+        
+        Args:
+            color (ExcelColors): The color to convert.
+            
+        Returns:
+            ExcelColors: The converted Excel color.
         """
         enumcolor:c_int = color.value
 
@@ -151,8 +188,10 @@ class XlsBorder (  XlsObject, IBorder) :
 
 
     def CopyFrom(self ,baseBorder:'IBorder'):
-        """
-
+        """Copies properties from another border.
+        
+        Args:
+            baseBorder (IBorder): The source border to copy properties from.
         """
         intPtrbaseBorder:c_void_p = baseBorder.Ptr
 
@@ -161,8 +200,11 @@ class XlsBorder (  XlsObject, IBorder) :
 
 
     def setLineStyleAndColor(self ,borderLine:'LineStyleType',borderColor:'ExcelColors'):
-        """
-
+        """Sets both the line style and color of the border in a single operation.
+        
+        Args:
+            borderLine (LineStyleType): The line style to set.
+            borderColor (ExcelColors): The color to set.
         """
         enumborderLine:c_int = borderLine.value
         enumborderColor:c_int = borderColor.value