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

spire/presentation/ParagraphProperties.py

@@ -8,18 +8,18 @@ import abc
 
 class ParagraphProperties (  PptObject, IActiveSlide) :
     """
-    <summary>
-        Represents the properties of a paragraph.
-    </summary>
+    Represents formatting properties for paragraphs in presentation text.
     """
     @property
 
     def Depth(self)->'int':
         """
-    <summary>
-        Gets or sets a depth of a paragraph.
-            Read/write <see cref="T:System.Int16" />.
-    </summary>
+        Gets or sets the nesting depth of the paragraph.
+        
+        Higher values indicate deeper nesting in outline structures.
+        
+        Returns:
+            int: Current nesting depth (0-based)
         """
         GetDllLibPpt().ParagraphProperties_get_Depth.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_Depth.restype=c_int
@@ -29,6 +29,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     @Depth.setter
     def Depth(self, value:'int'):
+        """
+        Sets the nesting depth of the paragraph.
+        
+        Args:
+            value (int): New nesting depth value (0-based)
+        """
         GetDllLibPpt().ParagraphProperties_set_Depth.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ParagraphProperties_set_Depth,self.Ptr, value)
 
@@ -36,10 +42,10 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def BulletType(self)->'TextBulletType':
         """
-    <summary>
-        Gets or sets the bullet type of a paragraph.
-            Read/write <see cref="T:Spire.Presentation.TextBulletType" />.
-    </summary>
+        Gets or sets the bullet style type for the paragraph.
+        
+        Returns:
+            TextBulletType: Current bullet style enumeration
         """
         GetDllLibPpt().ParagraphProperties_get_BulletType.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_BulletType.restype=c_int
@@ -49,16 +55,22 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     @BulletType.setter
     def BulletType(self, value:'TextBulletType'):
+        """
+        Sets the bullet style type for the paragraph.
+        
+        Args:
+            value (TextBulletType): New bullet style enumeration
+        """
         GetDllLibPpt().ParagraphProperties_set_BulletType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ParagraphProperties_set_BulletType,self.Ptr, value.value)
 
     @property
     def BulletChar(self)->int:
         """
-    <summary>
-        Gets or sets the bullet char of a paragraph.
-            Read/write <see cref="T:System.Char" />.
-    </summary>
+        Gets or sets the character used for bullet points.
+        
+        Returns:
+            int: Unicode character code for bullet symbol
         """
         GetDllLibPpt().ParagraphProperties_get_BulletChar.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_BulletChar.restype=c_int
@@ -67,6 +79,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     @BulletChar.setter
     def BulletChar(self, value:int):
+        """
+        Sets the character used for bullet points.
+        
+        Args:
+            value (int): Unicode character code for new bullet symbol
+        """
         GetDllLibPpt().ParagraphProperties_set_BulletChar.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ParagraphProperties_set_BulletChar,self.Ptr, value)
 
@@ -74,10 +92,10 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def BulletFont(self)->'TextFont':
         """
-    <summary>
-        Gets or sets the bullet font of a paragraph.
-            Read/write <see cref="T:Spire.Presentation.TextFont" />.
-    </summary>
+        Gets or sets the font used for bullet characters.
+        
+        Returns:
+            TextFont: Current bullet font properties
         """
         GetDllLibPpt().ParagraphProperties_get_BulletFont.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_BulletFont.restype=c_void_p
@@ -88,16 +106,22 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     @BulletFont.setter
     def BulletFont(self, value:'TextFont'):
+        """
+        Sets the font used for bullet characters.
+        
+        Args:
+            value (TextFont): New bullet font properties
+        """
         GetDllLibPpt().ParagraphProperties_set_BulletFont.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().ParagraphProperties_set_BulletFont,self.Ptr, value.Ptr)
 
     @property
     def BulletSize(self)->float:
         """
-    <summary>
-        Gets or sets the bullet size of a paragraph.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the size of bullet characters relative to text.
+        
+        Returns:
+            float: Current bullet size as percentage of text size
         """
         GetDllLibPpt().ParagraphProperties_get_BulletSize.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_BulletSize.restype=c_float
@@ -106,6 +130,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     @BulletSize.setter
     def BulletSize(self, value:float):
+        """
+        Sets the size of bullet characters relative to text.
+        
+        Args:
+            value (float): New bullet size as percentage of text size
+        """
         GetDllLibPpt().ParagraphProperties_set_BulletSize.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().ParagraphProperties_set_BulletSize,self.Ptr, value)
 
@@ -113,10 +143,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def ParagraphBulletColor(self)->'ColorFormat':
         """
-    <summary>
-        Gets the color format of a bullet of a paragraph.
-            Read-only <see cref="T:Spire.Presentation.Drawing.ColorFormat" />.
-    </summary>
+        Gets the color formatting for paragraph bullets.
+        
+        Read-only property.
+        
+        Returns:
+            ColorFormat: Current bullet color properties
         """
         GetDllLibPpt().ParagraphProperties_get_ParagraphBulletColor.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_ParagraphBulletColor.restype=c_void_p
@@ -129,10 +161,10 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def BulletNumber(self)->'int':
         """
-    <summary>
-        Gets or sets the first number which is used for group of numbered bullets.
-            Read/write <see cref="T:System.Int16" />.
-    </summary>
+        Gets or sets the starting number for numbered lists.
+        
+        Returns:
+            int: Current starting number value
         """
         GetDllLibPpt().ParagraphProperties_get_BulletNumber.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_BulletNumber.restype=c_int
@@ -142,6 +174,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     @BulletNumber.setter
     def BulletNumber(self, value:'int'):
+        """
+        Sets the starting number for numbered lists.
+        
+        Args:
+            value (int): New starting number value
+        """
         GetDllLibPpt().ParagraphProperties_set_BulletNumber.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ParagraphProperties_set_BulletNumber,self.Ptr, value)
 
@@ -149,10 +187,10 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def BulletStyle(self)->'NumberedBulletStyle':
         """
-    <summary>
-        Gets or sets the style of a numbered bullet.
-            Read/write <see cref="T:Spire.Presentation.NumberedBulletStyle" />.
-    </summary>
+        Gets or sets the numbering style for numbered lists.
+        
+        Returns:
+            NumberedBulletStyle: Current numbering style enumeration
         """
         GetDllLibPpt().ParagraphProperties_get_BulletStyle.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_BulletStyle.restype=c_int
@@ -162,6 +200,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     @BulletStyle.setter
     def BulletStyle(self, value:'NumberedBulletStyle'):
+        """
+        Sets the numbering style for numbered lists.
+        
+        Args:
+            value (NumberedBulletStyle): New numbering style enumeration
+        """
         GetDllLibPpt().ParagraphProperties_set_BulletStyle.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ParagraphProperties_set_BulletStyle,self.Ptr, value.value)
 
@@ -169,10 +213,10 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def Alignment(self)->'TextAlignmentType':
         """
-    <summary>
-        Gets or sets the text alignment in a paragraph.
-            Read/write <see cref="T:Spire.Presentation.TextAlignmentType" />.
-    </summary>
+        Gets or sets the horizontal alignment of text.
+        
+        Returns:
+            TextAlignmentType: Current text alignment enumeration
         """
         GetDllLibPpt().ParagraphProperties_get_Alignment.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_Alignment.restype=c_int
@@ -182,16 +226,22 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     @Alignment.setter
     def Alignment(self, value:'TextAlignmentType'):
+        """
+        Sets the horizontal alignment of text.
+        
+        Args:
+            value (TextAlignmentType): New text alignment enumeration
+        """
         GetDllLibPpt().ParagraphProperties_set_Alignment.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ParagraphProperties_set_Alignment,self.Ptr, value.value)
 
     @property
     def LineSpacing(self)->float:
         """
-    <summary>
-        Gets or sets the amount of space between base lines in a paragraph.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the spacing between lines of text.
+        
+        Returns:
+            float: Current line spacing value in points
         """
         GetDllLibPpt().ParagraphProperties_get_LineSpacing.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_LineSpacing.restype=c_float
@@ -200,16 +250,22 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     @LineSpacing.setter
     def LineSpacing(self, value:float):
+        """
+        Sets the spacing between lines of text.
+        
+        Args:
+            value (float): New line spacing value in points
+        """
         GetDllLibPpt().ParagraphProperties_set_LineSpacing.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().ParagraphProperties_set_LineSpacing,self.Ptr, value)
 
     @property
     def SpaceBefore(self)->float:
         """
-    <summary>
-        Returns or sets the amount of space before the first line in each paragraph of the specified text, in points or lines
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets spacing before the paragraph.
+        
+        Returns:
+            float: Current spacing value before paragraph in points
         """
         GetDllLibPpt().ParagraphProperties_get_SpaceBefore.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_SpaceBefore.restype=c_float
@@ -218,16 +274,22 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     @SpaceBefore.setter
     def SpaceBefore(self, value:float):
+        """
+        Sets spacing before the paragraph.
+        
+        Args:
+            value (float): New spacing value before paragraph in points
+        """
         GetDllLibPpt().ParagraphProperties_set_SpaceBefore.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().ParagraphProperties_set_SpaceBefore,self.Ptr, value)
 
     @property
     def SpaceAfter(self)->float:
         """
-    <summary>
-        Returns or sets the amount of space after the last line in each paragraph of the specified text, in points or lines. 
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets spacing after the paragraph.
+        
+        Returns:
+            float: Current spacing value after paragraph in points
         """
         GetDllLibPpt().ParagraphProperties_get_SpaceAfter.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_SpaceAfter.restype=c_float
@@ -236,6 +298,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     @SpaceAfter.setter
     def SpaceAfter(self, value:float):
+        """
+        Sets spacing after the paragraph.
+        
+        Args:
+            value (float): New spacing value after paragraph in points
+        """
         GetDllLibPpt().ParagraphProperties_set_SpaceAfter.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().ParagraphProperties_set_SpaceAfter,self.Ptr, value)
 
@@ -243,10 +311,10 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def EastAsianLineBreak(self)->'TriState':
         """
-    <summary>
-        Indicates whether the East Asian line break is used in a paragraph.
-            Read/write <see cref="T:Spire.Presentation.TriState" />.
-    </summary>
+        Gets or sets whether to use East Asian line breaking rules.
+        
+        Returns:
+            TriState: Current East Asian line breaking setting
         """
         GetDllLibPpt().ParagraphProperties_get_EastAsianLineBreak.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_EastAsianLineBreak.restype=c_int
@@ -256,6 +324,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     @EastAsianLineBreak.setter
     def EastAsianLineBreak(self, value:'TriState'):
+        """
+        Sets whether to use East Asian line breaking rules.
+        
+        Args:
+            value (TriState): New East Asian line breaking setting
+        """
         GetDllLibPpt().ParagraphProperties_set_EastAsianLineBreak.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ParagraphProperties_set_EastAsianLineBreak,self.Ptr, value.value)
 
@@ -263,10 +337,10 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def RightToLeft(self)->'TriState':
         """
-    <summary>
-        Indicates whether the Right to Left writing is used in a paragraph.
-            Read/write <see cref="T:Spire.Presentation.TriState" />.
-    </summary>
+        Gets or sets whether text uses right-to-left reading order.
+        
+        Returns:
+            TriState: Current right-to-left text direction setting
         """
         GetDllLibPpt().ParagraphProperties_get_RightToLeft.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_RightToLeft.restype=c_int
@@ -283,10 +357,10 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def LatinLineBreak(self)->'TriState':
         """
-    <summary>
-        Indicates whether the Latin line break is used in a paragraph.
-            Read/write <see cref="T:Spire.Presentation.TriState" />.
-    </summary>
+        Gets or sets whether to use Latin line breaking rules.
+        
+        Returns:
+            TriState: Current Latin line breaking setting
         """
         GetDllLibPpt().ParagraphProperties_get_LatinLineBreak.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_LatinLineBreak.restype=c_int
@@ -303,10 +377,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def HangingPunctuation(self)->'TriState':
         """
-    <summary>
-        Indicates whether the hanging punctuation is used in a paragraph.
-            Read/write <see cref="T:Spire.Presentation.TriState" />.
-    </summary>
+        Gets or sets whether hanging punctuation is enabled.
+        
+        Hanging punctuation allows punctuation marks to extend beyond text margins.
+        
+        Returns:
+            TriState: Current hanging punctuation setting
         """
         GetDllLibPpt().ParagraphProperties_get_HangingPunctuation.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_HangingPunctuation.restype=c_int
@@ -322,10 +398,10 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
     @property
     def LeftMargin(self)->float:
         """
-    <summary>
-        Gets or sets the left margin in a paragraph.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the left margin of the paragraph.
+        
+        Returns:
+            float: Current left margin value in points
         """
         GetDllLibPpt().ParagraphProperties_get_LeftMargin.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_LeftMargin.restype=c_float
@@ -340,10 +416,10 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
     @property
     def RightMargin(self)->float:
         """
-    <summary>
-        Gets or sets the right margin in a paragraph.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the right margin of the paragraph.
+        
+        Returns:
+            float: Current right margin value in points
         """
         GetDllLibPpt().ParagraphProperties_get_RightMargin.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_RightMargin.restype=c_float
@@ -358,10 +434,10 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
     @property
     def Indent(self)->float:
         """
-    <summary>
-        Gets or sets text indentation in a paragraph.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the text indentation of the paragraph.
+        
+        Returns:
+            float: Current indentation value in points
         """
         GetDllLibPpt().ParagraphProperties_get_Indent.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_Indent.restype=c_float
@@ -376,10 +452,10 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
     @property
     def DefaultTabSize(self)->float:
         """
-    <summary>
-        Gets or sets default tabulation size.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the default tab stop size.
+        
+        Returns:
+            float: Current default tab size in points
         """
         GetDllLibPpt().ParagraphProperties_get_DefaultTabSize.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_DefaultTabSize.restype=c_float
@@ -395,10 +471,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def Tabs(self)->'TabStopCollection':
         """
-    <summary>
-        Gets tabulations of a paragraph.
-            Read-only <see cref="T:Spire.Presentation.Collections.TabStopCollection" />.
-    </summary>
+        Gets the collection of custom tab stops for the paragraph.
+        
+        Read-only property.
+        
+        Returns:
+            TabStopCollection: Collection of custom tab stops
         """
         GetDllLibPpt().ParagraphProperties_get_Tabs.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_Tabs.restype=c_void_p
@@ -411,10 +489,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def FontAlignment(self)->'FontAlignmentType':
         """
-    <summary>
-        Gets or sets a font alignment in a paragraph.
-            Read/write <see cref="T:Spire.Presentation.FontAlignmentType" />.
-    </summary>
+        Gets or sets the vertical font alignment.
+        
+        Controls how characters are positioned relative to the text baseline.
+        
+        Returns:
+            FontAlignmentType: Current font alignment enumeration
         """
         GetDllLibPpt().ParagraphProperties_get_FontAlignment.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_FontAlignment.restype=c_int
@@ -431,10 +511,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def BulletPicture(self)->'PictureShape':
         """
-    <summary>
-        Gets a Picture used as a bullet in a paragraph.
-            Read-only <see cref="T:Spire.Presentation.PictureShape" />.
-    </summary>
+        Gets the picture used as a custom bullet.
+        
+        Read-only property.
+        
+        Returns:
+            PictureShape: Picture object used as bullet
         """
         GetDllLibPpt().ParagraphProperties_get_BulletPicture.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_BulletPicture.restype=c_void_p
@@ -447,10 +529,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def DefaultCharacterProperties(self)->'TextCharacterProperties':
         """
-    <summary>
-        Gets default character properties of a paragraph.
-            Read-only <see cref="T:Spire.Presentation.TextCharacterProperties" />.
-    </summary>
+        Gets the default character formatting properties.
+        
+        Read-only property.
+        
+        Returns:
+            TextCharacterProperties: Default character formatting properties
         """
         GetDllLibPpt().ParagraphProperties_get_DefaultCharacterProperties.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_DefaultCharacterProperties.restype=c_void_p
@@ -462,10 +546,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
     @property
     def HasBullet(self)->bool:
         """
-    <summary>
-        Indicates whether a paragraph has a bullet.
-            Read-only <see cref="T:System.Boolean" />.
-    </summary>
+        Indicates whether the paragraph has a bullet.
+        
+        Read-only property.
+        
+        Returns:
+            bool: True if paragraph has bullet formatting, False otherwise
         """
         GetDllLibPpt().ParagraphProperties_get_HasBullet.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_HasBullet.restype=c_bool
@@ -475,7 +561,10 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
     @property
     def CustomBulletColor(self)->bool:
         """
-
+        Indicates whether a custom bullet color is used.
+        
+        Returns:
+            bool: True if custom bullet color is applied, False otherwise
         """
         GetDllLibPpt().ParagraphProperties_get_CustomBulletColor.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_CustomBulletColor.restype=c_bool
@@ -491,10 +580,12 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def BulletColor(self)->'ColorFormat':
         """
-    <summary>
-        Gets or sets the color of a bullet.
-            Read-only <see cref="T:Spire.Presentation.Drawing.ColorFormat" />.
-    </summary>
+        Gets the color formatting for bullets.
+        
+        Read-only property.
+        
+        Returns:
+            ColorFormat: Bullet color properties
         """
         GetDllLibPpt().ParagraphProperties_get_BulletColor.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_BulletColor.restype=c_void_p
@@ -506,7 +597,10 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
     @property
     def CustomBulletFont(self)->bool:
         """
-
+        Indicates whether a custom bullet font is used.
+        
+        Returns:
+            bool: True if custom bullet font is applied, False otherwise
         """
         GetDllLibPpt().ParagraphProperties_get_CustomBulletFont.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphProperties_get_CustomBulletFont.restype=c_bool
@@ -521,7 +615,13 @@ class ParagraphProperties (  PptObject, IActiveSlide) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the current object is equal to another object.
+        
+        Args:
+            obj: The object to compare with.
+        
+        Returns:
+            True if the objects are equal; otherwise, False.
         """
         intPtrobj:c_void_p = obj.Ptr