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

spire/xls/RtfTextWriter.py

@@ -7,13 +7,18 @@ from ctypes import *
 import abc
 
 class RtfTextWriter (SpireObject) :
-    """
-
+    """Provides functionality for writing Rich Text Format (RTF) content.
+    
+    This class encapsulates methods for creating and manipulating RTF documents,
+    including text formatting, font management, color management, and other RTF features.
+    It is used internally by Excel components that need to generate RTF content.
     """
 
     def ToString(self)->str:
-        """
-
+        """Converts the RTF content to a string representation.
+        
+        Returns:
+            str: The RTF content as a string.
         """
         GetDllLibXls().RtfTextWriter_ToString.argtypes=[c_void_p]
         GetDllLibXls().RtfTextWriter_ToString.restype=c_void_p
@@ -367,8 +372,16 @@ class RtfTextWriter (SpireObject) :
 
 
     def AddFont(self ,font:'Font')->int:
-        """
-
+        """Adds a font to the RTF document's font table.
+        
+        This method registers a font in the RTF document's font table,
+        making it available for use in text formatting.
+        
+        Args:
+            font (Font): The font to add to the font table.
+            
+        Returns:
+            int: The index of the added font in the font table.
         """
         intPtrfont:c_void_p = font.Ptr
 
@@ -379,8 +392,16 @@ class RtfTextWriter (SpireObject) :
 
 
     def AddColor(self ,color:'Color')->int:
-        """
-
+        """Adds a color to the RTF document's color table.
+        
+        This method registers a color in the RTF document's color table,
+        making it available for use in text and background formatting.
+        
+        Args:
+            color (Color): The color to add to the color table.
+            
+        Returns:
+            int: The index of the added color in the color table.
         """
         intPtrcolor:c_void_p = color.Ptr
 
@@ -390,15 +411,21 @@ class RtfTextWriter (SpireObject) :
         return ret
 
     def WriteFontTable(self):
-        """
-
+        """Writes the font table to the RTF document.
+        
+        This method outputs the RTF font table header and all registered fonts
+        to the RTF document. The font table must be written before any text
+        that uses those fonts.
         """
         GetDllLibXls().RtfTextWriter_WriteFontTable.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RtfTextWriter_WriteFontTable, self.Ptr)
 
     def WriteColorTable(self):
-        """
-
+        """Writes the color table to the RTF document.
+        
+        This method outputs the RTF color table header and all registered colors
+        to the RTF document. The color table must be written before any text
+        that uses those colors.
         """
         GetDllLibXls().RtfTextWriter_WriteColorTable.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RtfTextWriter_WriteColorTable, self.Ptr)
@@ -406,8 +433,11 @@ class RtfTextWriter (SpireObject) :
     @dispatch
 
     def WriteText(self ,font:Font,strText:str):
-        """
-
+        """Writes text with the specified font to the RTF document.
+        
+        Args:
+            font (Font): The font to apply to the text.
+            strText (str): The text to write.
         """
         intPtrfont:c_void_p = font.Ptr
 
@@ -417,8 +447,12 @@ class RtfTextWriter (SpireObject) :
     @dispatch
 
     def WriteText(self ,font:Font,foreColor:Color,strText:str):
-        """
-
+        """Writes text with the specified font and foreground color to the RTF document.
+        
+        Args:
+            font (Font): The font to apply to the text.
+            foreColor (Color): The foreground color to apply to the text.
+            strText (str): The text to write.
         """
         intPtrfont:c_void_p = font.Ptr
         intPtrforeColor:c_void_p = foreColor.Ptr
@@ -429,8 +463,13 @@ class RtfTextWriter (SpireObject) :
     @dispatch
 
     def WriteText(self ,font:Font,foreColor:Color,backColor:Color,strText:str):
-        """
-
+        """Writes text with the specified font, foreground color, and background color to the RTF document.
+        
+        Args:
+            font (Font): The font to apply to the text.
+            foreColor (Color): The foreground color to apply to the text.
+            backColor (Color): The background color to apply to the text.
+            strText (str): The text to write.
         """
         intPtrfont:c_void_p = font.Ptr
         intPtrforeColor:c_void_p = foreColor.Ptr
@@ -601,8 +640,13 @@ class RtfTextWriter (SpireObject) :
 
     @property
     def Escape(self)->bool:
-        """
-
+        """Gets or sets whether special characters should be escaped in the RTF output.
+        
+        When set to True, special characters like braces, backslashes, etc. will be
+        escaped with a backslash in the RTF output.
+        
+        Returns:
+            bool: True if special characters should be escaped; otherwise, False.
         """
         GetDllLibXls().RtfTextWriter_get_Escape.argtypes=[c_void_p]
         GetDllLibXls().RtfTextWriter_get_Escape.restype=c_bool
@@ -617,8 +661,10 @@ class RtfTextWriter (SpireObject) :
     @property
 
     def Encoding(self)->'Encoding':
-        """
-
+        """Gets the character encoding used for the RTF document.
+        
+        Returns:
+            Encoding: The character encoding used for the RTF document.
         """
         GetDllLibXls().RtfTextWriter_get_Encoding.argtypes=[c_void_p]
         GetDllLibXls().RtfTextWriter_get_Encoding.restype=c_void_p

spire/xls/SaveShapeTypeOption.py

@@ -15,16 +15,14 @@ class SaveShapeTypeOption (SpireObject) :
 
         super(SaveShapeTypeOption, self).__init__(intPtr)
     """
-    <summary>
-        Specifies the shape type that needs to be converted to a picture, and defaults to all types
-    </summary>
+    Specifies the shape type that needs to be converted to a picture, and defaults to all types
+
     """
     @property
     def SaveGroupShape(self)->bool:
         """
-    <summary>
         Identifies whether Group shape converted to a picture.(Child of this group shape will not convert)
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveGroupShape.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveGroupShape.restype=c_bool
@@ -39,9 +37,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SavePicture(self)->bool:
         """
-    <summary>
         Identifies whether Picture shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SavePicture.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SavePicture.restype=c_bool
@@ -56,9 +53,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SaveTextBox(self)->bool:
         """
-    <summary>
         Identifies whether TextBox shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveTextBox.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveTextBox.restype=c_bool
@@ -73,9 +69,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SaveButton(self)->bool:
         """
-    <summary>
         Identifies whether Button shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveButton.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveButton.restype=c_bool
@@ -90,9 +85,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SaveCheckBox(self)->bool:
         """
-    <summary>
         Identifies whether CheckBox shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveCheckBox.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveCheckBox.restype=c_bool
@@ -107,9 +101,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SaveRadioButton(self)->bool:
         """
-    <summary>
         Identifies whether RadioButton shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveRadioButton.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveRadioButton.restype=c_bool
@@ -124,9 +117,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SaveGroupBox(self)->bool:
         """
-    <summary>
         Identifies whether GroupBox shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveGroupBox.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveGroupBox.restype=c_bool
@@ -141,9 +133,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SaveLabel(self)->bool:
         """
-    <summary>
         Identifies whether Label shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveLabel.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveLabel.restype=c_bool
@@ -158,9 +149,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SaveListBox(self)->bool:
         """
-    <summary>
         Identifies whether ListBox shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveListBox.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveListBox.restype=c_bool
@@ -175,9 +165,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SaveComboBox(self)->bool:
         """
-    <summary>
         Identifies whether ComboBox shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveComboBox.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveComboBox.restype=c_bool
@@ -192,9 +181,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SaveArc(self)->bool:
         """
-    <summary>
         Identifies whether Arc shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveArc.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveArc.restype=c_bool
@@ -209,9 +197,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SaveLine(self)->bool:
         """
-    <summary>
         Identifies whether Line shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveLine.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveLine.restype=c_bool
@@ -226,9 +213,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SaveOval(self)->bool:
         """
-    <summary>
         Identifies whether eOval shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveOval.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveOval.restype=c_bool
@@ -243,9 +229,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SaveRectangle(self)->bool:
         """
-    <summary>
         Identifies whether Rectangle shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveRectangle.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveRectangle.restype=c_bool
@@ -260,9 +245,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SavePrstGomShape(self)->bool:
         """
-    <summary>
         Identifies whether PrstGomShape shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SavePrstGomShape.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SavePrstGomShape.restype=c_bool
@@ -277,9 +261,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SaveDml(self)->bool:
         """
-    <summary>
         Identifies whether Dml shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveDml.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveDml.restype=c_bool
@@ -294,9 +277,8 @@ class SaveShapeTypeOption (SpireObject) :
     @property
     def SaveAll(self)->bool:
         """
-    <summary>
         Identifies whether All shape converted to a picture
-    </summary>
+
         """
         GetDllLibXls().SaveShapeTypeOption_get_SaveAll.argtypes=[c_void_p]
         GetDllLibXls().SaveShapeTypeOption_get_SaveAll.restype=c_bool

spire/xls/ShapeGlow.py

@@ -7,15 +7,20 @@ from ctypes import *
 import abc
 
 class ShapeGlow (  XlsObject, IGlow, ICloneParent) :
-    """
-
+    """Represents glow effect settings for a shape in Excel.
+    
+    This class implements the IGlow and ICloneParent interfaces and provides functionality
+    for configuring glow effects applied to shapes in Excel worksheets. Glow effects add
+    a colored, blurred outline around the shape to create a glowing appearance.
     """
     @property
     def SoftEdge(self)->int:
-        """
-    <summary>
-        Gets or sets the radio of soft edge.
-    </summary>
+        """Gets or sets the radius of the soft edge effect for the glow.
+        
+        The soft edge radius determines how far the glow extends from the shape's edge.
+        
+        Returns:
+            int: The radius of the soft edge effect in points.
         """
         GetDllLibXls().ShapeGlow_get_SoftEdge.argtypes=[c_void_p]
         GetDllLibXls().ShapeGlow_get_SoftEdge.restype=c_int
@@ -29,8 +34,12 @@ class ShapeGlow (  XlsObject, IGlow, ICloneParent) :
 
     @property
     def Transparency(self)->int:
-        """
-
+        """Gets or sets the transparency level of the glow effect.
+        
+        The transparency value ranges from 0 (fully opaque) to 100 (fully transparent).
+        
+        Returns:
+            int: The transparency level as a percentage (0-100).
         """
         GetDllLibXls().ShapeGlow_get_Transparency.argtypes=[c_void_p]
         GetDllLibXls().ShapeGlow_get_Transparency.restype=c_int
@@ -44,8 +53,12 @@ class ShapeGlow (  XlsObject, IGlow, ICloneParent) :
 
     @property
     def Radius(self)->int:
-        """
-
+        """Gets or sets the radius of the glow effect.
+        
+        The radius determines the overall size of the glow around the shape.
+        
+        Returns:
+            int: The radius of the glow effect in points.
         """
         GetDllLibXls().ShapeGlow_get_Radius.argtypes=[c_void_p]
         GetDllLibXls().ShapeGlow_get_Radius.restype=c_int
@@ -60,8 +73,10 @@ class ShapeGlow (  XlsObject, IGlow, ICloneParent) :
     @property
 
     def Color(self)->'Color':
-        """
-
+        """Gets or sets the color of the glow effect.
+        
+        Returns:
+            Color: The color object representing the glow color.
         """
         GetDllLibXls().ShapeGlow_get_Color.argtypes=[c_void_p]
         GetDllLibXls().ShapeGlow_get_Color.restype=c_void_p
@@ -77,15 +92,20 @@ class ShapeGlow (  XlsObject, IGlow, ICloneParent) :
 
 
     def Clone(self ,parent:'SpireObject')->'SpireObject':
-        """
-
+        """Creates a copy of the glow effect with the specified parent.
+        
+        Args:
+            parent (SpireObject): The parent object for the cloned glow effect.
+            
+        Returns:
+            SpireObject: A new SpireObject that is a copy of this glow effect.
         """
         intPtrparent:c_void_p = parent.Ptr
 
         GetDllLibXls().ShapeGlow_Clone.argtypes=[c_void_p ,c_void_p]
         GetDllLibXls().ShapeGlow_Clone.restype=c_void_p
         intPtr = CallCFunction(GetDllLibXls().ShapeGlow_Clone, self.Ptr, intPtrparent)
-        ret = None if intPtr==None else SpireObject(intPtr)
+        ret = None if intPtr==None else ShapeGlow(intPtr)
         return ret
 
 

spire/xls/ShapeReflection.py

@@ -7,13 +7,22 @@ from ctypes import *
 import abc
 
 class ShapeReflection (  XlsObject, IReflectionEffect, ICloneParent) :
-    """
-
+    """Represents reflection effect settings for a shape in Excel.
+    
+    This class implements the IReflectionEffect and ICloneParent interfaces and provides
+    functionality for configuring reflection effects applied to shapes in Excel worksheets.
+    Reflection effects create a mirror image of the shape, simulating the appearance of
+    the shape being reflected on a shiny surface.
     """
 
     def Clone(self ,parent:'SpireObject')->'SpireObject':
-        """
-
+        """Creates a copy of the reflection effect with the specified parent.
+        
+        Args:
+            parent (SpireObject): The parent object for the cloned reflection effect.
+            
+        Returns:
+            SpireObject: A new SpireObject that is a copy of this reflection effect.
         """
         intPtrparent:c_void_p = parent.Ptr
 
@@ -26,8 +35,12 @@ class ShapeReflection (  XlsObject, IReflectionEffect, ICloneParent) :
 
     @property
     def Blur(self)->int:
-        """
-
+        """Gets or sets the blur radius of the reflection.
+        
+        The blur radius determines how blurry or sharp the reflection appears.
+        
+        Returns:
+            int: The blur radius of the reflection in points.
         """
         GetDllLibXls().ShapeReflection_get_Blur.argtypes=[c_void_p]
         GetDllLibXls().ShapeReflection_get_Blur.restype=c_int
@@ -41,8 +54,12 @@ class ShapeReflection (  XlsObject, IReflectionEffect, ICloneParent) :
 
     @property
     def Direction(self)->float:
-        """
-
+        """Gets or sets the direction angle of the reflection.
+        
+        The direction angle determines the orientation of the reflection relative to the shape.
+        
+        Returns:
+            float: The direction angle in degrees.
         """
         GetDllLibXls().ShapeReflection_get_Direction.argtypes=[c_void_p]
         GetDllLibXls().ShapeReflection_get_Direction.restype=c_double
@@ -56,8 +73,12 @@ class ShapeReflection (  XlsObject, IReflectionEffect, ICloneParent) :
 
     @property
     def Distance(self)->int:
-        """
-
+        """Gets or sets the distance of the reflection from the shape.
+        
+        The distance determines how far the reflection appears from the original shape.
+        
+        Returns:
+            int: The distance of the reflection in points.
         """
         GetDllLibXls().ShapeReflection_get_Distance.argtypes=[c_void_p]
         GetDllLibXls().ShapeReflection_get_Distance.restype=c_int
@@ -71,8 +92,12 @@ class ShapeReflection (  XlsObject, IReflectionEffect, ICloneParent) :
 
     @property
     def FadeDirection(self)->float:
-        """
-
+        """Gets or sets the fade direction angle of the reflection.
+        
+        The fade direction determines the direction in which the reflection gradually fades out.
+        
+        Returns:
+            float: The fade direction angle in degrees.
         """
         GetDllLibXls().ShapeReflection_get_FadeDirection.argtypes=[c_void_p]
         GetDllLibXls().ShapeReflection_get_FadeDirection.restype=c_double
@@ -86,8 +111,12 @@ class ShapeReflection (  XlsObject, IReflectionEffect, ICloneParent) :
 
     @property
     def RotWithShape(self)->bool:
-        """
-
+        """Gets or sets whether the reflection rotates with the shape.
+        
+        When set to True, the reflection will rotate along with the shape when the shape is rotated.
+        
+        Returns:
+            bool: True if the reflection rotates with the shape; otherwise, False.
         """
         GetDllLibXls().ShapeReflection_get_RotWithShape.argtypes=[c_void_p]
         GetDllLibXls().ShapeReflection_get_RotWithShape.restype=c_bool
@@ -101,8 +130,12 @@ class ShapeReflection (  XlsObject, IReflectionEffect, ICloneParent) :
 
     @property
     def Size(self)->int:
-        """
-
+        """Gets or sets the size of the reflection as a percentage of the original shape.
+        
+        The size determines how large the reflection appears relative to the original shape.
+        
+        Returns:
+            int: The size of the reflection as a percentage (0-100).
         """
         GetDllLibXls().ShapeReflection_get_Size.argtypes=[c_void_p]
         GetDllLibXls().ShapeReflection_get_Size.restype=c_int
@@ -116,8 +149,12 @@ class ShapeReflection (  XlsObject, IReflectionEffect, ICloneParent) :
 
     @property
     def Transparency(self)->int:
-        """
-
+        """Gets or sets the transparency level of the reflection.
+        
+        The transparency value ranges from 0 (fully opaque) to 100 (fully transparent).
+        
+        Returns:
+            int: The transparency level as a percentage (0-100).
         """
         GetDllLibXls().ShapeReflection_get_Transparency.argtypes=[c_void_p]
         GetDllLibXls().ShapeReflection_get_Transparency.restype=c_int