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

spire/xls/RichTextObject.py

@@ -7,13 +7,21 @@ from ctypes import *
 import abc
 
 class RichTextObject (  SpireObject, IRichTextString) :
-    """
-
+    """Represents a rich text object that can contain text with multiple formatting runs.
+    
+    This class implements the IRichTextString interface and provides functionality for 
+    creating and manipulating text with different formatting applied to different parts.
+    Rich text objects can be used in cell values, comments, and other text containers in Excel.
     """
 
     def GetFont(self ,position:int)->'XlsFont':
-        """
-
+        """Gets the font used at the specified character position in the text.
+        
+        Args:
+            position (int): The zero-based character position in the text.
+            
+        Returns:
+            XlsFont: The font object used at the specified position.
         """
         
         GetDllLibXls().RichTextObject_GetFont.argtypes=[c_void_p ,c_int]
@@ -25,8 +33,12 @@ class RichTextObject (  SpireObject, IRichTextString) :
 
 
     def SetFont(self ,startPos:int,endPos:int,font:'IFont'):
-        """
-
+        """Sets the font for a range of characters in the text.
+        
+        Args:
+            startPos (int): The zero-based starting character position.
+            endPos (int): The zero-based ending character position (inclusive).
+            font (IFont): The font to apply to the specified range of characters.
         """
         intPtrfont:c_void_p = font.Ptr
 
@@ -34,19 +46,19 @@ class RichTextObject (  SpireObject, IRichTextString) :
         CallCFunction(GetDllLibXls().RichTextObject_SetFont, self.Ptr, startPos,endPos,intPtrfont)
 
     def ClearFormatting(self):
-        """
-    <summary>
-        Clears formatting.
-    </summary>
+        """Clears all formatting from the rich text.
+        
+        This method removes all formatting information while preserving the text content,
+        resulting in plain text with default formatting.
         """
         GetDllLibXls().RichTextObject_ClearFormatting.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RichTextObject_ClearFormatting, self.Ptr)
 
     def Clear(self):
-        """
-    <summary>
-        Clears all.
-    </summary>
+        """Clears both the text content and formatting.
+        
+        This method removes all text and formatting information, resulting in an empty
+        rich text object.
         """
         GetDllLibXls().RichTextObject_Clear.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RichTextObject_Clear, self.Ptr)
@@ -54,8 +66,13 @@ class RichTextObject (  SpireObject, IRichTextString) :
     @property
 
     def Text(self)->str:
-        """
-
+        """Gets or sets the plain text content of the rich text object.
+        
+        When setting this property, any existing formatting is preserved and applied
+        to the new text content where applicable.
+        
+        Returns:
+            str: The plain text content without formatting information.
         """
         GetDllLibXls().RichTextObject_get_Text.argtypes=[c_void_p]
         GetDllLibXls().RichTextObject_get_Text.restype=c_void_p
@@ -71,10 +88,13 @@ class RichTextObject (  SpireObject, IRichTextString) :
     @property
 
     def RtfText(self)->str:
-        """
-    <summary>
-        Gets Rtf Text. Read-Only.
-    </summary>
+        """Gets the text content in Rich Text Format (RTF).
+        
+        This property returns the text with all formatting information encoded in RTF format,
+        which can be used for interoperability with other applications that support RTF.
+        
+        Returns:
+            str: The text content in RTF format.
         """
         GetDllLibXls().RichTextObject_get_RtfText.argtypes=[c_void_p]
         GetDllLibXls().RichTextObject_get_RtfText.restype=c_void_p
@@ -84,10 +104,11 @@ class RichTextObject (  SpireObject, IRichTextString) :
 
     @property
     def IsFormatted(self)->bool:
-        """
-    <summary>
-        Indicates whether rich text string contains formatting Read-only.
-    </summary>
+        """Gets whether the rich text contains any formatting.
+        
+        Returns:
+            bool: True if the text contains formatting (different fonts, colors, etc.);
+                 otherwise, False.
         """
         GetDllLibXls().RichTextObject_get_IsFormatted.argtypes=[c_void_p]
         GetDllLibXls().RichTextObject_get_IsFormatted.restype=c_bool
@@ -97,8 +118,10 @@ class RichTextObject (  SpireObject, IRichTextString) :
     @property
 
     def Parent(self)->'SpireObject':
-        """
-
+        """Gets the parent object that contains this rich text object.
+        
+        Returns:
+            SpireObject: The parent object that contains this rich text object.
         """
         GetDllLibXls().RichTextObject_get_Parent.argtypes=[c_void_p]
         GetDllLibXls().RichTextObject_get_Parent.restype=c_void_p
@@ -108,23 +131,31 @@ class RichTextObject (  SpireObject, IRichTextString) :
 
 
     def BeginUpdate(self):
-        """
-
+        """Begins a batch update operation on the rich text object.
+        
+        This method marks the start of a series of changes to the rich text object.
+        Multiple changes can be made more efficiently by calling BeginUpdate
+        before making the changes and EndUpdate after all changes are complete.
         """
         GetDllLibXls().RichTextObject_BeginUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RichTextObject_BeginUpdate, self.Ptr)
 
     def EndUpdate(self):
-        """
-
+        """Ends a batch update operation on the rich text object.
+        
+        This method should be called after BeginUpdate and all desired changes
+        have been made. It applies all pending changes to the rich text object.
         """
         GetDllLibXls().RichTextObject_EndUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RichTextObject_EndUpdate, self.Ptr)
 
 
     def Append(self ,text:str,font:'IFont'):
-        """
-
+        """Appends text with the specified font to the end of the rich text.
+        
+        Args:
+            text (str): The text to append.
+            font (IFont): The font to apply to the appended text.
         """
         intPtrfont:c_void_p = font.Ptr
 

spire/xls/RichTextShape.py

@@ -7,14 +7,22 @@ from ctypes import *
 import abc
 
 class RichTextShape (  SpireObject, IRichTextString) :
-    """
-
+    """Represents rich text within a shape in Excel.
+    
+    This class implements the IRichTextString interface and provides functionality for 
+    creating and manipulating text with different formatting applied to different parts
+    when the text is contained within a shape (like a text box or comment).
     """
     @property
 
     def Text(self)->str:
-        """
-
+        """Gets or sets the plain text content of the rich text shape.
+        
+        When setting this property, any existing formatting is preserved and applied
+        to the new text content where applicable.
+        
+        Returns:
+            str: The plain text content without formatting information.
         """
         GetDllLibXls().RichTextShape_get_Text.argtypes=[c_void_p]
         GetDllLibXls().RichTextShape_get_Text.restype=c_void_p
@@ -30,8 +38,13 @@ class RichTextShape (  SpireObject, IRichTextString) :
     @property
 
     def RtfText(self)->str:
-        """
-
+        """Gets the text content in Rich Text Format (RTF).
+        
+        This property returns the text with all formatting information encoded in RTF format,
+        which can be used for interoperability with other applications that support RTF.
+        
+        Returns:
+            str: The text content in RTF format.
         """
         GetDllLibXls().RichTextShape_get_RtfText.argtypes=[c_void_p]
         GetDllLibXls().RichTextShape_get_RtfText.restype=c_void_p
@@ -41,8 +54,11 @@ class RichTextShape (  SpireObject, IRichTextString) :
 
     @property
     def IsFormatted(self)->bool:
-        """
-
+        """Gets whether the rich text contains any formatting.
+        
+        Returns:
+            bool: True if the text contains formatting (different fonts, colors, etc.);
+                 otherwise, False.
         """
         GetDllLibXls().RichTextShape_get_IsFormatted.argtypes=[c_void_p]
         GetDllLibXls().RichTextShape_get_IsFormatted.restype=c_bool
@@ -52,8 +68,10 @@ class RichTextShape (  SpireObject, IRichTextString) :
     @property
 
     def Parent(self)->'SpireObject':
-        """
-
+        """Gets the parent shape object that contains this rich text.
+        
+        Returns:
+            SpireObject: The parent shape object that contains this rich text.
         """
         GetDllLibXls().RichTextShape_get_Parent.argtypes=[c_void_p]
         GetDllLibXls().RichTextShape_get_Parent.restype=c_void_p
@@ -64,8 +82,13 @@ class RichTextShape (  SpireObject, IRichTextString) :
 
 
     def GetFont(self ,index:int)->'IFont':
-        """
-
+        """Gets the font used at the specified character position in the text.
+        
+        Args:
+            index (int): The zero-based character position in the text.
+            
+        Returns:
+            IFont: The font object used at the specified position.
         """
         
         GetDllLibXls().RichTextShape_GetFont.argtypes=[c_void_p ,c_int]
@@ -77,8 +100,12 @@ class RichTextShape (  SpireObject, IRichTextString) :
 
 
     def SetFont(self ,startIndex:int,endIndex:int,font:'IFont'):
-        """
-
+        """Sets the font for a range of characters in the text.
+        
+        Args:
+            startIndex (int): The zero-based starting character position.
+            endIndex (int): The zero-based ending character position (inclusive).
+            font (IFont): The font to apply to the specified range of characters.
         """
         intPtrfont:c_void_p = font.Ptr
 
@@ -86,23 +113,30 @@ class RichTextShape (  SpireObject, IRichTextString) :
         CallCFunction(GetDllLibXls().RichTextShape_SetFont, self.Ptr, startIndex,endIndex,intPtrfont)
 
     def ClearFormatting(self):
-        """
-
+        """Clears all formatting from the rich text.
+        
+        This method removes all formatting information while preserving the text content,
+        resulting in plain text with default formatting.
         """
         GetDllLibXls().RichTextShape_ClearFormatting.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RichTextShape_ClearFormatting, self.Ptr)
 
     def Clear(self):
-        """
-
+        """Clears both the text content and formatting.
+        
+        This method removes all text and formatting information, resulting in an empty
+        rich text object.
         """
         GetDllLibXls().RichTextShape_Clear.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RichTextShape_Clear, self.Ptr)
 
 
     def Append(self ,text:str,font:'IFont'):
-        """
-
+        """Appends text with the specified font to the end of the rich text.
+        
+        Args:
+            text (str): The text to append.
+            font (IFont): The font to apply to the appended text.
         """
         intPtrfont:c_void_p = font.Ptr
 
@@ -110,15 +144,20 @@ class RichTextShape (  SpireObject, IRichTextString) :
         CallCFunction(GetDllLibXls().RichTextShape_Append, self.Ptr, text,intPtrfont)
 
     def BeginUpdate(self):
-        """
-
+        """Begins a batch update operation on the rich text shape.
+        
+        This method marks the start of a series of changes to the rich text shape.
+        Multiple changes can be made more efficiently by calling BeginUpdate
+        before making the changes and EndUpdate after all changes are complete.
         """
         GetDllLibXls().RichTextShape_BeginUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RichTextShape_BeginUpdate, self.Ptr)
 
     def EndUpdate(self):
-        """
-
+        """Ends a batch update operation on the rich text shape.
+        
+        This method should be called after BeginUpdate and all desired changes
+        have been made. It applies all pending changes to the rich text shape.
         """
         GetDllLibXls().RichTextShape_EndUpdate.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RichTextShape_EndUpdate, self.Ptr)
@@ -126,8 +165,13 @@ class RichTextShape (  SpireObject, IRichTextString) :
     @property
 
     def DefaultFont(self)->'XlsFont':
-        """
-
+        """Gets the default font for this rich text shape.
+        
+        The default font is used for any portion of the text that doesn't have
+        specific formatting applied.
+        
+        Returns:
+            XlsFont: The default font object for the rich text shape.
         """
         GetDllLibXls().RichTextShape_get_DefaultFont.argtypes=[c_void_p]
         GetDllLibXls().RichTextShape_get_DefaultFont.restype=c_void_p
@@ -138,8 +182,12 @@ class RichTextShape (  SpireObject, IRichTextString) :
 
     @property
     def FormattingRunsCount(self)->int:
-        """
-
+        """Gets the number of formatting runs in the rich text.
+        
+        A formatting run is a contiguous range of text that has the same formatting applied.
+        
+        Returns:
+            int: The number of formatting runs in the rich text.
         """
         GetDllLibXls().RichTextShape_get_FormattingRunsCount.argtypes=[c_void_p]
         GetDllLibXls().RichTextShape_get_FormattingRunsCount.restype=c_int
@@ -148,8 +196,13 @@ class RichTextShape (  SpireObject, IRichTextString) :
 
 
     def GetSpace(self ,FormattingRunsIndex:int)->int:
-        """
-
+        """Gets the spacing value for the specified formatting run.
+        
+        Args:
+            FormattingRunsIndex (int): The zero-based index of the formatting run.
+            
+        Returns:
+            int: The spacing value for the specified formatting run.
         """
         
         GetDllLibXls().RichTextShape_GetSpace.argtypes=[c_void_p ,c_int]
@@ -159,8 +212,11 @@ class RichTextShape (  SpireObject, IRichTextString) :
 
 
     def SetSpace(self ,FormattingRunsIndex:int,SpaceValue:int):
-        """
-
+        """Sets the spacing value for the specified formatting run.
+        
+        Args:
+            FormattingRunsIndex (int): The zero-based index of the formatting run.
+            SpaceValue (int): The spacing value to set for the formatting run.
         """
         
         GetDllLibXls().RichTextShape_SetSpace.argtypes=[c_void_p ,c_int,c_int]

spire/xls/RichTextString.py

@@ -7,16 +7,19 @@ from ctypes import *
 import abc
 
 class RichTextString (  CommonWrapper, IRichTextString, IExcelApplication) :
-    """
-
+    """Represents a base class for rich text strings in Excel.
+    
+    This class implements the IRichTextString and IExcelApplication interfaces and serves
+    as a base class for other rich text implementations. It provides core functionality
+    for creating and manipulating text with different formatting applied to different parts.
     """
     @property
 
     def Parent(self)->'SpireObject':
-        """
-    <summary>
-        Returns parent object. Read-only.
-    </summary>
+        """Gets the parent object that contains this rich text string.
+        
+        Returns:
+            SpireObject: The parent object that contains this rich text string.
         """
         GetDllLibXls().RichTextString_get_Parent.argtypes=[c_void_p]
         GetDllLibXls().RichTextString_get_Parent.restype=c_void_p
@@ -27,8 +30,13 @@ class RichTextString (  CommonWrapper, IRichTextString, IExcelApplication) :
 
 
     def GetFont(self ,index:int)->'IFont':
-        """
-
+        """Gets the font used at the specified character position in the text.
+        
+        Args:
+            index (int): The zero-based character position in the text.
+            
+        Returns:
+            IFont: The font object used at the specified position.
         """
         
         GetDllLibXls().RichTextString_GetFont.argtypes=[c_void_p ,c_int]
@@ -40,8 +48,12 @@ class RichTextString (  CommonWrapper, IRichTextString, IExcelApplication) :
 
 
     def SetFont(self ,startIndex:int,endIndex:int,font:'IFont'):
-        """
-
+        """Sets the font for a range of characters in the text.
+        
+        Args:
+            startIndex (int): The zero-based starting character position.
+            endIndex (int): The zero-based ending character position (inclusive).
+            font (IFont): The font to apply to the specified range of characters.
         """
         intPtrfont:c_void_p = font.Ptr
 
@@ -49,23 +61,30 @@ class RichTextString (  CommonWrapper, IRichTextString, IExcelApplication) :
         CallCFunction(GetDllLibXls().RichTextString_SetFont, self.Ptr, startIndex,endIndex,intPtrfont)
 
     def ClearFormatting(self):
-        """
-
+        """Clears all formatting from the rich text.
+        
+        This method removes all formatting information while preserving the text content,
+        resulting in plain text with default formatting.
         """
         GetDllLibXls().RichTextString_ClearFormatting.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RichTextString_ClearFormatting, self.Ptr)
 
     def Clear(self):
-        """
-
+        """Clears both the text content and formatting.
+        
+        This method removes all text and formatting information, resulting in an empty
+        rich text string.
         """
         GetDllLibXls().RichTextString_Clear.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().RichTextString_Clear, self.Ptr)
 
 
     def Append(self ,text:str,font:'IFont'):
-        """
-
+        """Appends text with the specified font to the end of the rich text.
+        
+        Args:
+            text (str): The text to append.
+            font (IFont): The font to apply to the appended text.
         """
         intPtrfont:c_void_p = font.Ptr
 
@@ -75,8 +94,13 @@ class RichTextString (  CommonWrapper, IRichTextString, IExcelApplication) :
     @property
 
     def Text(self)->str:
-        """
-
+        """Gets or sets the plain text content of the rich text string.
+        
+        When setting this property, any existing formatting is preserved and applied
+        to the new text content where applicable.
+        
+        Returns:
+            str: The plain text content without formatting information.
         """
         GetDllLibXls().RichTextString_get_Text.argtypes=[c_void_p]
         GetDllLibXls().RichTextString_get_Text.restype=c_void_p
@@ -92,8 +116,13 @@ class RichTextString (  CommonWrapper, IRichTextString, IExcelApplication) :
     @property
 
     def RtfText(self)->str:
-        """
-
+        """Gets the text content in Rich Text Format (RTF).
+        
+        This property returns the text with all formatting information encoded in RTF format,
+        which can be used for interoperability with other applications that support RTF.
+        
+        Returns:
+            str: The text content in RTF format.
         """
         GetDllLibXls().RichTextString_get_RtfText.argtypes=[c_void_p]
         GetDllLibXls().RichTextString_get_RtfText.restype=c_void_p
@@ -103,8 +132,11 @@ class RichTextString (  CommonWrapper, IRichTextString, IExcelApplication) :
 
     @property
     def IsFormatted(self)->bool:
-        """
-
+        """Gets whether the rich text contains any formatting.
+        
+        Returns:
+            bool: True if the text contains formatting (different fonts, colors, etc.);
+                 otherwise, False.
         """
         GetDllLibXls().RichTextString_get_IsFormatted.argtypes=[c_void_p]
         GetDllLibXls().RichTextString_get_IsFormatted.restype=c_bool
@@ -114,8 +146,13 @@ class RichTextString (  CommonWrapper, IRichTextString, IExcelApplication) :
     @property
 
     def DefaultFont(self)->'XlsFont':
-        """
-
+        """Gets the default font for this rich text string.
+        
+        The default font is used for any portion of the text that doesn't have
+        specific formatting applied.
+        
+        Returns:
+            XlsFont: The default font object for the rich text string.
         """
         GetDllLibXls().RichTextString_get_DefaultFont.argtypes=[c_void_p]
         GetDllLibXls().RichTextString_get_DefaultFont.restype=c_void_p