spire-presentation 10.6.4__py3-none-win_amd64.whl → 10.7.1__py3-none-win_amd64.whl

spire/presentation/TextHighLightingOptions.py

@@ -7,9 +7,20 @@ from ctypes import *
 import abc
 
 class TextHighLightingOptions (SpireObject) :
+    """
+    Configuration options for text highlighting operations.
+    
+    Provides settings to control how text is searched and highlighted
+    during text processing operations.
+    """
 
     @dispatch
     def __init__(self):
+        """
+        Initialize a new instance with default highlighting options.
+        
+        Default options are case-insensitive and allow partial word matches.
+        """
         GetDllLibPpt().TextHighLightingOptions_Create.restype = c_void_p
         intPtr = CallCFunction(GetDllLibPpt().TextHighLightingOptions_Create)
         super(TextHighLightingOptions, self).__init__(intPtr)
@@ -19,9 +30,13 @@ class TextHighLightingOptions (SpireObject) :
     @property
     def CaseSensitive(self)->bool:
         """
-    <summary>
-        Set true to use case-sensitive search,false-otherwise. Red/write System.Boolean.
-    </summary>
+        Enable or disable case-sensitive text search.
+        
+        When set to True, searches will distinguish between uppercase and lowercase letters.
+        When False (default), searches will ignore case differences.
+        
+        Returns:
+            bool: Current case-sensitivity setting
         """
         GetDllLibPpt().TextHighLightingOptions_get_CaseSensitive.argtypes=[c_void_p]
         GetDllLibPpt().TextHighLightingOptions_get_CaseSensitive.restype=c_bool
@@ -30,15 +45,25 @@ class TextHighLightingOptions (SpireObject) :
 
     @CaseSensitive.setter
     def CaseSensitive(self, value:bool):
+        """
+        Configure case-sensitivity for text search operations.
+        
+        Args:
+            value: True for case-sensitive search, False for case-insensitive
+        """
         GetDllLibPpt().TextHighLightingOptions_set_CaseSensitive.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().TextHighLightingOptions_set_CaseSensitive,self.Ptr, value)
 
     @property
     def WholeWordsOnly(self)->bool:
         """
-    <summary>
-        Set true to match only whole words,false-otherwise. Red/write System.Boolean.
-    </summary>
+        Require whole-word matching for text search.
+        
+        When set to True, searches will only match complete words.
+        When False (default), searches will match partial words within text.
+        
+        Returns:
+            bool: Current whole-word matching setting
         """
         GetDllLibPpt().TextHighLightingOptions_get_WholeWordsOnly.argtypes=[c_void_p]
         GetDllLibPpt().TextHighLightingOptions_get_WholeWordsOnly.restype=c_bool
@@ -47,6 +72,12 @@ class TextHighLightingOptions (SpireObject) :
 
     @WholeWordsOnly.setter
     def WholeWordsOnly(self, value:bool):
+        """
+        Configure whole-word matching requirement.
+        
+        Args:
+            value: True to require whole-word matches, False to allow partial matches
+        """
         GetDllLibPpt().TextHighLightingOptions_set_WholeWordsOnly.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().TextHighLightingOptions_set_WholeWordsOnly,self.Ptr, value)
 

spire/presentation/TextHorizontalOverflowType.py

@@ -8,9 +8,12 @@ import abc
 
 class TextHorizontalOverflowType(Enum):
     """
-    <summary>
-        Represents text horizontal overflow type.
-    </summary>
+    Represents text horizontal overflow type.
+
+    Attributes:
+        none: No overflow handling specified.
+        Overflow: Text overflows horizontally.
+        Clip: Text is clipped at the boundary.
     """
     none = -1
     Overflow = 0

spire/presentation/TextLineFormat.py

@@ -8,20 +8,19 @@ import abc
 
 class TextLineFormat (  IActiveSlide, IChartGridLine) :
     """
-    <summary>
-        Represents format of a line.
-    </summary>
+    Represents the formatting properties for a line in a presentation.
     """
     @dispatch
 
     def Equals(self ,obj:SpireObject)->bool:
         """
-    <summary>
-        Indicates whether the two LineFormat instances are equal.
-    </summary>
-    <param name="obj">The LineFormat to compare with the current LineFormat.</param>
-    <returns>
-  <b>true</b> if the specified LineFormat is equal to the current LineFormat; otherwise, <b>false</b>.</returns>
+        Determines if two LineFormat objects are equivalent.
+        
+        Args:
+            obj: LineFormat object to compare with current instance
+            
+        Returns:
+            bool: True if objects are equal, False otherwise
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -34,12 +33,13 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def Equals(self ,lf:'TextLineFormat')->bool:
         """
-    <summary>
-        Indicates whether the two LineFormat instances are equal.
-    </summary>
-    <param name="lf">The LineFormat to compare with the current LineFormat.</param>
-    <returns>
-  <b>true</b> if the specified LineFormat is equal to the current LineFormat; otherwise, <b>false</b>.</returns>
+        Determines if two LineFormat instances are equivalent.
+        
+        Args:
+            lf: LineFormat object to compare with current instance
+            
+        Returns:
+            bool: True if objects are equal, False otherwise
         """
         intPtrlf:c_void_p = lf.Ptr
 
@@ -52,10 +52,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def FillFormat(self)->'LineFillFormat':
         """
-    <summary>
-        Gets the fill format of a line.
-            Read-only <see cref="T:Spire.Presentation.Drawing.LineFillFormat" /> .
-    </summary>
+        Gets the fill formatting properties of the line.
+        
+        Read-only access to complex fill definitions.
         """
         GetDllLibPpt().TextLineFormat_get_FillFormat.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_FillFormat.restype=c_void_p
@@ -68,9 +67,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def FillType(self)->'FillFormatType':
         """
-    <summary>
-        Gets or sets the fill format type.
-    </summary>
+        Gets or sets the base type of fill formatting.
+        
+        Determines what kind of fill (solid, gradient, pattern, etc.) is applied.
         """
         GetDllLibPpt().TextLineFormat_get_FillType.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_FillType.restype=c_int
@@ -87,10 +86,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def Gradient(self)->'GradientFillFormat':
         """
-    <summary>
-        Gets the Gradient fill format.
-            Read-only <see cref="P:Spire.Presentation.TextLineFormat.Pattern" />.
-    </summary>
+        Gets the gradient fill formatting properties.
+        
+        Read-only access to gradient fill definitions.
         """
         GetDllLibPpt().TextLineFormat_get_Gradient.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_Gradient.restype=c_void_p
@@ -103,10 +101,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def Pattern(self)->'PatternFillFormat':
         """
-    <summary>
-        Gets the pattern fill format.
-            Read-only <see cref="P:Spire.Presentation.TextLineFormat.Pattern" />.
-    </summary>
+        Gets the pattern fill formatting properties.
+        
+        Read-only access to pattern fill definitions.
         """
         GetDllLibPpt().TextLineFormat_get_Pattern.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_Pattern.restype=c_void_p
@@ -119,10 +116,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def SolidFillColor(self)->'ColorFormat':
         """
-    <summary>
-        Gets the color of a solid fill.
-            Read-only <see cref="T:Spire.Presentation.Drawing.ColorFormat" />.
-    </summary>
+        Gets the solid fill color properties.
+        
+        Read-only access to solid color fill definitions.
         """
         GetDllLibPpt().TextLineFormat_get_SolidFillColor.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_SolidFillColor.restype=c_void_p
@@ -135,10 +131,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def RotateWithShape(self)->'TriState':
         """
-    <summary>
-        Indicates whether the fill should be rotated with a shape.
-            Read/write <see cref="T:Spire.Presentation.TriState" />.
-    </summary>
+        Determines if fill rotates with shape transformation.
+        
+        Read/write property controlling fill rotation behavior.
         """
         GetDllLibPpt().TextLineFormat_get_RotateWithShape.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_RotateWithShape.restype=c_int
@@ -154,10 +149,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
     @property
     def Width(self)->float:
         """
-    <summary>
-        Gets or sets the width of a line.
-            Read/write <see cref="T:System.Double" />.
-    </summary>
+        Gets or sets the width of the line.
+        
+        Read/write property controlling line thickness.
         """
         GetDllLibPpt().TextLineFormat_get_Width.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_Width.restype=c_double
@@ -173,10 +167,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def DashStyle(self)->'LineDashStyleType':
         """
-    <summary>
-        Gets or sets the line dash style.
-            Read/write <see cref="T:Spire.Presentation.LineDashStyleType" />.
-    </summary>
+        Gets or sets the dash pattern of the line.
+        
+        Read/write property controlling line dash appearance.
         """
         GetDllLibPpt().TextLineFormat_get_DashStyle.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_DashStyle.restype=c_int
@@ -193,10 +186,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def CapStyle(self)->'LineCapStyle':
         """
-    <summary>
-        Gets or sets the line cap style.
-            Read/write <see cref="T:Spire.Presentation.LineCapStyle" />.
-    </summary>
+        Gets or sets the line end cap style.
+        
+        Read/write property controlling line end appearance.
         """
         GetDllLibPpt().TextLineFormat_get_CapStyle.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_CapStyle.restype=c_int
@@ -213,10 +205,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def Style(self)->'TextLineStyle':
         """
-    <summary>
-        Gets or sets the line style.
-            Read/write <see cref="T:Spire.Presentation.TextLineStyle" />.
-    </summary>
+        Gets or sets the overall line style.
+        
+        Read/write property controlling line appearance.
         """
         GetDllLibPpt().TextLineFormat_get_Style.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_Style.restype=c_int
@@ -233,10 +224,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def Alignment(self)->'PenAlignmentType':
         """
-    <summary>
         Gets or sets the line alignment.
-            Read/write <see cref="T:Spire.Presentation.Drawing.PenAlignmentType" />.
-    </summary>
+        
+        Read/write property controlling line positioning.
         """
         GetDllLibPpt().TextLineFormat_get_Alignment.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_Alignment.restype=c_int
@@ -253,10 +243,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def JoinStyle(self)->'LineJoinType':
         """
-    <summary>
-        Gets or sets the lines join style.
-            Read/write <see cref="T:Spire.Presentation.LineJoinType" />.
-    </summary>
+        Gets or sets the line join style.
+        
+        Read/write property controlling corner appearance.
         """
         GetDllLibPpt().TextLineFormat_get_JoinStyle.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_JoinStyle.restype=c_int
@@ -272,10 +261,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
     @property
     def MiterLimit(self)->float:
         """
-    <summary>
-        Gets or sets the miter limit of a line.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the miter limit for corners.
+        
+        Read/write property controlling angle sharpness.
         """
         GetDllLibPpt().TextLineFormat_get_MiterLimit.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_MiterLimit.restype=c_float
@@ -291,10 +279,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def LineBeginType(self)->'LineEndType':
         """
-    <summary>
-        Gets or sets the arrowhead style at the beginning of a line.
-            Read/write <see cref="T:Spire.Presentation.LineEndType" />.
-    </summary>
+        Gets or sets the arrowhead style at line start.
+        
+        Read/write property controlling start decoration.
         """
         GetDllLibPpt().TextLineFormat_get_LineBeginType.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_LineBeginType.restype=c_int
@@ -311,10 +298,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def LineEndType(self)->'LineEndType':
         """
-    <summary>
-        Gets or sets the arrowhead style at the end of a line.
-            Read/write <see cref="T:Spire.Presentation.LineEndType" />.
-    </summary>
+        Gets or sets the arrowhead style at line end.
+        
+        Read/write property controlling end decoration.
         """
         GetDllLibPpt().TextLineFormat_get_LineEndType.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_LineEndType.restype=c_int
@@ -331,10 +317,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def LineBeginWidth(self)->'LineEndWidth':
         """
-    <summary>
-        Gets or sets the arrowhead width at the beginning of a line.
-            Read/write <see cref="T:Spire.Presentation.LineEndWidth" />.
-    </summary>
+        Gets or sets the arrowhead width at line start.
+        
+        Read/write property controlling start decoration size.
         """
         GetDllLibPpt().TextLineFormat_get_LineBeginWidth.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_LineBeginWidth.restype=c_int
@@ -351,10 +336,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def LineEndWidth(self)->'LineEndWidth':
         """
-    <summary>
-        Gets or sets the arrowhead width at the end of a line.
-            Read/write <see cref="T:Spire.Presentation.LineEndWidth" />.
-    </summary>
+        Gets or sets the arrowhead width at line end.
+        
+        Read/write property controlling end decoration size.
         """
         GetDllLibPpt().TextLineFormat_get_LineEndWidth.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_LineEndWidth.restype=c_int
@@ -371,10 +355,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def LineBeginLength(self)->'LineEndLength':
         """
-    <summary>
-        Gets or sets the arrowhead length at the beginning of a line.
-            Read/write <see cref="T:Spire.Presentation.LineEndLength" />.
-    </summary>
+        Gets or sets the arrowhead length at line start.
+        
+        Read/write property controlling start decoration size.
         """
         GetDllLibPpt().TextLineFormat_get_LineBeginLength.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_LineBeginLength.restype=c_int
@@ -391,10 +374,9 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def LineEndLength(self)->'LineEndLength':
         """
-    <summary>
-        Gets or sets the arrowhead length at the end of a line.
-            Read/write <see cref="T:Spire.Presentation.LineEndLength" />.
-    </summary>
+        Gets or sets the arrowhead length at line end.
+        
+        Read/write property controlling end decoration size.
         """
         GetDllLibPpt().TextLineFormat_get_LineEndLength.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_get_LineEndLength.restype=c_int
@@ -409,7 +391,10 @@ class TextLineFormat (  IActiveSlide, IChartGridLine) :
 
     def GetHashCode(self)->int:
         """
-
+        Generates a hash code for the LineFormat object.
+        
+        Returns:
+            int: Hash code representing object state
         """
         GetDllLibPpt().TextLineFormat_GetHashCode.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormat_GetHashCode.restype=c_int

spire/presentation/TextLineStyle.py

@@ -8,9 +8,15 @@ import abc
 
 class TextLineStyle(Enum):
     """
-    <summary>
-        Represents the style of a line.
-    </summary>
+    Represents the style of a line.
+    
+    Attributes:
+        none: No line style.
+        Single: Single line style.
+        ThinThin: Double line with two thin lines.
+        ThinThick: Double line with thin then thick lines.
+        ThickThin: Double line with thick then thin lines.
+        ThickBetweenThin: Double line with thick between thin lines.
     """
     none = -1
     Single = 0

spire/presentation/TextParagraph.py

@@ -5,27 +5,36 @@ from spire.presentation.common import *
 from spire.presentation import *
 from ctypes import *
 from spire.presentation.ParagraphProperties import ParagraphProperties
-from spire.presentation.TextRangeCollection import TextRangeCollection
+from spire.presentation.collections.TextRangeCollection import TextRangeCollection
 
 class TextParagraph (  ParagraphProperties) :
+    """
+    Represents a paragraph of text within a presentation.
+    
+    Provides properties and methods to manage paragraph formatting,
+    text content, and text ranges within the paragraph.
+    """
 
     @dispatch
     def __init__(self):
+        """
+        Initializes a new instance of the TextParagraph class with default properties.
+        """
         GetDllLibPpt().TextParagraph_Creat.restype = c_void_p
         intPtr = CallCFunction(GetDllLibPpt().TextParagraph_Creat)
         super(TextParagraph, self).__init__(intPtr)
-    """
-    <summary>
-        Represents a paragraph of a text.
-    </summary>
-    """
+    
     @property
 
     def FirstTextRange(self)->'TextRange':
         """
-    <summary>
-        First text range of text paragraph.
-    </summary>
+        Gets the first text range in the paragraph.
+        
+        This property provides access to the initial text range
+        within the paragraph for formatting and content manipulation.
+        
+        Returns:
+            TextRange: The first text range object in the paragraph
         """
         GetDllLibPpt().TextParagraph_get_FirstTextRange.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraph_get_FirstTextRange.restype=c_void_p
@@ -38,10 +47,13 @@ class TextParagraph (  ParagraphProperties) :
 
     def TextRanges(self)->'TextRangeCollection':
         """
-    <summary>
-        Gets the collection of a text range.
-            Readonly <see cref="T:Spire.Presentation.Collections.TextRangeCollection" />.
-    </summary>
+        Gets the collection of text ranges within the paragraph.
+        
+        This read-only property provides access to all text ranges
+        contained in the paragraph for comprehensive text management.
+        
+        Returns:
+            TextRangeCollection: Collection of text range objects
         """
         GetDllLibPpt().TextParagraph_get_TextRanges.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraph_get_TextRanges.restype=c_void_p
@@ -54,10 +66,14 @@ class TextParagraph (  ParagraphProperties) :
 
     def ParagraphProperties(self)->'TextParagraphProperties':
         """
-    <summary>
-        Gets the formatting of paragraph.
-            Readonly <see cref="T:Spire.Presentation.TextParagraphProperties" />.
-    </summary>
+        Gets the formatting properties of the paragraph.
+        
+        This read-only property provides access to the complete set
+        of paragraph formatting options including alignment, indentation,
+        and spacing settings.
+        
+        Returns:
+            TextParagraphProperties: Formatting properties of the paragraph
         """
         GetDllLibPpt().TextParagraph_get_ParagraphProperties.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraph_get_ParagraphProperties.restype=c_void_p
@@ -70,12 +86,13 @@ class TextParagraph (  ParagraphProperties) :
 
     def Text(self)->str:
         """
-    <summary>
-        Gets or sets the the plain text of a paragraph.
-    </summary>
-<value>
-            The text.
-            </value>
+        Gets or sets the plain text content of the paragraph.
+        
+        This property allows access to the unformatted text content
+        of the entire paragraph, including all text ranges.
+        
+        Returns:
+            str: Current plain text content of the paragraph
         """
         GetDllLibPpt().TextParagraph_get_Text.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraph_get_Text.restype=c_void_p
@@ -85,6 +102,12 @@ class TextParagraph (  ParagraphProperties) :
 
     @Text.setter
     def Text(self, value:str):
+        """
+        Sets the plain text content of the paragraph.
+        
+        Args:
+            value: New plain text content for the paragraph
+        """
         valuePtr = StrToPtr(value)
         GetDllLibPpt().TextParagraph_set_Text.argtypes=[c_void_p, c_char_p]
         CallCFunction(GetDllLibPpt().TextParagraph_set_Text,self.Ptr,valuePtr)
@@ -92,7 +115,13 @@ class TextParagraph (  ParagraphProperties) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines if two TextParagraph objects are equivalent.
+        
+        Args:
+            obj: TextParagraph object to compare with current instance
+            
+        Returns:
+            bool: True if objects are equal, False otherwise
         """
         intPtrobj:c_void_p = obj.Ptr