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

spire/presentation/ITextFrameProperties.py

@@ -8,16 +8,19 @@ import abc
 
 class ITextFrameProperties (SpireObject) :
     """
-
+    Represents text formatting and layout properties for text containers.
+    
+    Provides comprehensive control over text presentation including 
+    paragraphs, styles, margins, alignment, and special effects.
     """
     @property
 
     def Paragraphs(self)->'ParagraphCollection':
         """
-    <summary>
-        Gets the list of all paragraphs in a frame.
-            Read-only <see cref="T:Spire.Presentation.Collections.ParagraphCollection" />.
-    </summary>
+        Gets the collection of paragraphs in the text frame.
+        
+        Returns:
+            ParagraphCollection: Collection of paragraph objects.
         """
         GetDllLibPpt().ITextFrameProperties_get_Paragraphs.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_Paragraphs.restype=c_void_p
@@ -30,13 +33,12 @@ class ITextFrameProperties (SpireObject) :
 
     def Text(self)->str:
         """
-    <summary>
-        Gets or sets the plain text for a TextFrame.
-    </summary>
-<value>
-            The text.
-            </value>
+        Gets or sets the plain text content of the text frame.
+        
+        Returns:
+            str: Current text content.
         """
+
         GetDllLibPpt().ITextFrameProperties_get_Text.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_Text.restype=c_void_p
         ret =PtrToStr(CallCFunction(GetDllLibPpt().ITextFrameProperties_get_Text,self.Ptr))
@@ -45,6 +47,12 @@ class ITextFrameProperties (SpireObject) :
 
     @Text.setter
     def Text(self, value:str):
+        """
+        Sets plain text content.
+        
+        Args:
+            value (str): New text content.
+        """
         valuePtr = StrToPtr(value)
         GetDllLibPpt().ITextFrameProperties_set_Text.argtypes=[c_void_p, c_char_p]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_Text,self.Ptr,valuePtr)
@@ -53,10 +61,10 @@ class ITextFrameProperties (SpireObject) :
 
     def TextStyle(self)->'TextStyle':
         """
-    <summary>
-        Gets text's style.
-            Readonly <see cref="T:Spire.Presentation.TextStyle" />.
-    </summary>
+        Gets the default text style for the text frame.
+        
+        Returns:
+            TextStyle: Object containing text style definitions.
         """
         GetDllLibPpt().ITextFrameProperties_get_TextStyle.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_TextStyle.restype=c_void_p
@@ -68,10 +76,10 @@ class ITextFrameProperties (SpireObject) :
     @property
     def MarginLeft(self)->float:
         """
-    <summary>
-        Gets or sets the left margin (points) in a TextFrame.
-            Read/write <see cref="T:System.Double" />.
-    </summary>
+        Gets or sets the left margin (in points).
+        
+        Returns:
+            float: Current left margin value.
         """
         GetDllLibPpt().ITextFrameProperties_get_MarginLeft.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_MarginLeft.restype=c_double
@@ -80,16 +88,22 @@ class ITextFrameProperties (SpireObject) :
 
     @MarginLeft.setter
     def MarginLeft(self, value:float):
+        """
+        Sets left margin.
+        
+        Args:
+            value (float): New left margin in points.
+        """
         GetDllLibPpt().ITextFrameProperties_set_MarginLeft.argtypes=[c_void_p, c_double]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_MarginLeft,self.Ptr, value)
 
     @property
     def ColumnCount(self)->int:
         """
-    <summary>
-        Gets or sets the left margin (points) in a TextFrame.
-            Read/write <see cref="T:System.Double" />.
-    </summary>
+        Gets or sets number of text columns.
+        
+        Returns:
+            int: Current column count.
         """
         GetDllLibPpt().ITextFrameProperties_get_ColumnCount.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_ColumnCount.restype=c_int
@@ -98,16 +112,22 @@ class ITextFrameProperties (SpireObject) :
 
     @ColumnCount.setter
     def ColumnCount(self, value:int):
+        """
+        Sets number of text columns.
+        
+        Args:
+            value (int): New column count.
+        """
         GetDllLibPpt().ITextFrameProperties_set_ColumnCount.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_ColumnCount,self.Ptr, value)
 
     @property
     def ColumnSpacing(self)->float:
         """
-    <summary>
-        Gets or sets the left margin (points) in a TextFrame.
-            Read/write <see cref="T:System.Double" />.
-    </summary>
+        Gets or sets spacing between text columns.
+        
+        Returns:
+            float: Current column spacing.
         """
         GetDllLibPpt().ITextFrameProperties_get_ColumnSpacing.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_ColumnSpacing.restype=c_float
@@ -116,16 +136,22 @@ class ITextFrameProperties (SpireObject) :
 
     @ColumnSpacing.setter
     def ColumnSpacing(self, value:float):
+        """
+        Sets spacing between columns.
+        
+        Args:
+            value (float): New column spacing value.
+        """
         GetDllLibPpt().ITextFrameProperties_set_ColumnSpacing.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_ColumnSpacing,self.Ptr, value)
 
     @property
     def MarginRight(self)->float:
         """
-    <summary>
-        Gets or sets the right margin (points) in a TextFrame.
-            Read/write <see cref="T:System.Double" />.
-    </summary>
+        Gets or sets the right margin (in points).
+        
+        Returns:
+            float: Current right margin value.
         """
         GetDllLibPpt().ITextFrameProperties_get_MarginRight.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_MarginRight.restype=c_double
@@ -134,16 +160,22 @@ class ITextFrameProperties (SpireObject) :
 
     @MarginRight.setter
     def MarginRight(self, value:float):
+        """
+        Sets right margin.
+        
+        Args:
+            value (float): New right margin in points.
+        """
         GetDllLibPpt().ITextFrameProperties_set_MarginRight.argtypes=[c_void_p, c_double]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_MarginRight,self.Ptr, value)
 
     @property
     def MarginTop(self)->float:
         """
-    <summary>
-        Gets or sets the top margin (points) in a TextFrame.
-            Read/write <see cref="T:System.Double" />.
-    </summary>
+        Gets or sets the top margin (in points).
+        
+        Returns:
+            float: Current top margin value.
         """
         GetDllLibPpt().ITextFrameProperties_get_MarginTop.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_MarginTop.restype=c_double
@@ -152,16 +184,22 @@ class ITextFrameProperties (SpireObject) :
 
     @MarginTop.setter
     def MarginTop(self, value:float):
+        """
+        Sets top margin.
+        
+        Args:
+            value (float): New top margin in points.
+        """
         GetDllLibPpt().ITextFrameProperties_set_MarginTop.argtypes=[c_void_p, c_double]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_MarginTop,self.Ptr, value)
 
     @property
     def MarginBottom(self)->float:
         """
-    <summary>
-        Gets or sets the bottom margin (points) in a TextFrame.
-            Read/write <see cref="T:System.Double" />.
-    </summary>
+        Gets or sets the bottom margin (in points).
+        
+        Returns:
+            float: Current bottom margin value.
         """
         GetDllLibPpt().ITextFrameProperties_get_MarginBottom.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_MarginBottom.restype=c_double
@@ -170,6 +208,12 @@ class ITextFrameProperties (SpireObject) :
 
     @MarginBottom.setter
     def MarginBottom(self, value:float):
+        """
+        Sets bottom margin.
+        
+        Args:
+            value (float): New bottom margin in points.
+        """
         GetDllLibPpt().ITextFrameProperties_set_MarginBottom.argtypes=[c_void_p, c_double]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_MarginBottom,self.Ptr, value)
 
@@ -177,9 +221,10 @@ class ITextFrameProperties (SpireObject) :
 
     def TextRange(self)->'TextRange':
         """
-    <summary>
-        Text range of text frame.
-    </summary>
+        Gets the text range with formatting properties.
+        
+        Returns:
+            TextRange: Object containing formatted text.
         """
         GetDllLibPpt().ITextFrameProperties_get_TextRange.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_TextRange.restype=c_void_p
@@ -191,10 +236,10 @@ class ITextFrameProperties (SpireObject) :
     @property
     def WordWrap(self)->bool:
         """
-<summary>
-  <b>True</b> if text is wrapped at TextFrame's margins.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        Controls whether text wraps at container margins.
+        
+        Returns:
+            bool: True if word wrap is enabled, False otherwise.
         """
         GetDllLibPpt().ITextFrameProperties_get_WordWrap.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_WordWrap.restype=c_bool
@@ -203,6 +248,12 @@ class ITextFrameProperties (SpireObject) :
 
     @WordWrap.setter
     def WordWrap(self, value:bool):
+        """
+        Enables/disables word wrapping.
+        
+        Args:
+            value (bool): True to enable wrapping, False to disable.
+        """
         GetDllLibPpt().ITextFrameProperties_set_WordWrap.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_WordWrap,self.Ptr, value)
 
@@ -210,10 +261,10 @@ class ITextFrameProperties (SpireObject) :
 
     def AnchoringType(self)->'TextAnchorType':
         """
-    <summary>
-        Gets or sets vertical anchor text in a TextFrame.
-            Read/write <see cref="T:Spire.Presentation.TextAnchorType" />.
-    </summary>
+        Gets or sets vertical text anchoring.
+        
+        Returns:
+            TextAnchorType: Current vertical anchoring type.
         """
         GetDllLibPpt().ITextFrameProperties_get_AnchoringType.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_AnchoringType.restype=c_int
@@ -223,16 +274,22 @@ class ITextFrameProperties (SpireObject) :
 
     @AnchoringType.setter
     def AnchoringType(self, value:'TextAnchorType'):
+        """
+        Sets vertical anchoring type.
+        
+        Args:
+            value (TextAnchorType): New anchoring type enum value.
+        """
         GetDllLibPpt().ITextFrameProperties_set_AnchoringType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_AnchoringType,self.Ptr, value.value)
 
     @property
     def IsCentered(self)->bool:
         """
-    <summary>
-        Indicates, whether text should be centered in box horizontally.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        Controls horizontal centering of text.
+        
+        Returns:
+            bool: True if text is horizontally centered.
         """
         GetDllLibPpt().ITextFrameProperties_get_IsCentered.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_IsCentered.restype=c_bool
@@ -241,6 +298,12 @@ class ITextFrameProperties (SpireObject) :
 
     @IsCentered.setter
     def IsCentered(self, value:bool):
+        """
+        Enables/disables horizontal centering.
+        
+        Args:
+            value (bool): True to center text horizontally.
+        """
         GetDllLibPpt().ITextFrameProperties_set_IsCentered.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_IsCentered,self.Ptr, value)
 
@@ -248,11 +311,12 @@ class ITextFrameProperties (SpireObject) :
 
     def VerticalTextType(self)->'VerticalTextType':
         """
-    <summary>
-        Indicates text orientation.
-            Read/write <see cref="P:Spire.Presentation.ITextFrameProperties.VerticalTextType" />.
-    </summary>
+        Gets or sets text orientation direction.
+        
+        Returns:
+            VerticalTextType: Current text orientation type.
         """
+
         GetDllLibPpt().ITextFrameProperties_get_VerticalTextType.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_VerticalTextType.restype=c_int
         ret = CallCFunction(GetDllLibPpt().ITextFrameProperties_get_VerticalTextType,self.Ptr)
@@ -261,6 +325,12 @@ class ITextFrameProperties (SpireObject) :
 
     @VerticalTextType.setter
     def VerticalTextType(self, value:'VerticalTextType'):
+        """
+        Sets text orientation direction.
+        
+        Args:
+            value (VerticalTextType): New orientation type enum value.
+        """
         GetDllLibPpt().ITextFrameProperties_set_VerticalTextType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_VerticalTextType,self.Ptr, value.value)
 
@@ -268,10 +338,10 @@ class ITextFrameProperties (SpireObject) :
 
     def AutofitType(self)->'TextAutofitType':
         """
-    <summary>
-        Gets or sets text's autofit mode.
-            Read/write <see cref="T:Spire.Presentation.TextAutofitType" />.
-    </summary>
+        Gets or sets text autofitting behavior.
+        
+        Returns:
+            TextAutofitType: Current autofit type.
         """
         GetDllLibPpt().ITextFrameProperties_get_AutofitType.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_AutofitType.restype=c_int
@@ -281,6 +351,12 @@ class ITextFrameProperties (SpireObject) :
 
     @AutofitType.setter
     def AutofitType(self, value:'TextAutofitType'):
+        """
+        Sets autofitting behavior.
+        
+        Args:
+            value (TextAutofitType): New autofit type enum value.
+        """
         GetDllLibPpt().ITextFrameProperties_set_AutofitType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_AutofitType,self.Ptr, value.value)
 
@@ -288,10 +364,10 @@ class ITextFrameProperties (SpireObject) :
 
     def Slide(self)->'ActiveSlide':
         """
-    <summary>
-        Gets the parent slide of a TextFrame.
-            Read-only <see cref="T:Spire.Presentation.ActiveSlide" />.
-    </summary>
+        Gets the parent slide of the text frame.
+        
+        Returns:
+            ActiveSlide: Parent slide object.
         """
         GetDllLibPpt().ITextFrameProperties_get_Slide.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_Slide.restype=c_void_p
@@ -304,7 +380,10 @@ class ITextFrameProperties (SpireObject) :
 
     def Presentation(self)->'Presentation':
         """
-
+        Gets the parent presentation.
+        
+        Returns:
+            Presentation: Parent presentation object.
         """
         GetDllLibPpt().ITextFrameProperties_get_Presentation.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_Presentation.restype=c_void_p
@@ -317,9 +396,10 @@ class ITextFrameProperties (SpireObject) :
 
     def Parent(self)->'SpireObject':
         """
-    <summary>
-        Reference to Parent object. Read-only.
-    </summary>
+        Gets the parent object.
+        
+        Returns:
+            SpireObject: Parent object reference.
         """
         GetDllLibPpt().ITextFrameProperties_get_Parent.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_Parent.restype=c_void_p
@@ -330,9 +410,7 @@ class ITextFrameProperties (SpireObject) :
 
     def Dispose(self):
         """
-    <summary>
-        Dispose object and free resources.
-    </summary>
+        Releases resources associated with the text frame.
         """
         GetDllLibPpt().ITextFrameProperties_Dispose.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_Dispose,self.Ptr)
@@ -341,10 +419,10 @@ class ITextFrameProperties (SpireObject) :
 
     def TextThreeD(self)->'FormatThreeD':
         """
-    <summary>
-        Gets the FormatThreeD object that 3d effect properties for text.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FormatThreeD" />.
-    </summary>
+        Gets 3D text effect properties.
+        
+        Returns:
+            FormatThreeD: Object containing 3D effect settings.
         """
         GetDllLibPpt().ITextFrameProperties_get_TextThreeD.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_TextThreeD.restype=c_void_p
@@ -356,9 +434,10 @@ class ITextFrameProperties (SpireObject) :
     @property
     def RotationAngle(self)->float:
         """
-    <summary>
-        Gets or sets the rotation angle of text frame .
-     </summary>
+        Gets or sets text rotation angle.
+        
+        Returns:
+            float: Current rotation angle in degrees.
         """
         GetDllLibPpt().ITextFrameProperties_get_RotationAngle.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_RotationAngle.restype=c_float
@@ -367,18 +446,24 @@ class ITextFrameProperties (SpireObject) :
 
     @RotationAngle.setter
     def RotationAngle(self, value:float):
+        """
+        Sets text rotation angle.
+        
+        Args:
+            value (float): New rotation angle in degrees.
+        """
         GetDllLibPpt().ITextFrameProperties_set_RotationAngle.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_RotationAngle,self.Ptr, value)
 
 
     def HighLightText(self ,text:str,color:'Color',options:'TextHighLightingOptions'):
         """
-    <summary>
-        Highlight all matches of sample in text frame text using specified color.
-    </summary>
-    <param name="text">Text sample to highlight</param>
-    <param name="color">Highlighting color</param>
-    <param name="options">Highlighting options</param>
+        Highlights all occurrences of specified text.
+        
+        Args:
+            text (str): Text to highlight
+            color (Color): Highlight color
+            options (TextHighLightingOptions): Highlighting options
         """
         intPtrcolor:c_void_p = color.Ptr
         intPtroptions:c_void_p = options.Ptr
@@ -390,9 +475,10 @@ class ITextFrameProperties (SpireObject) :
     @property
     def RightToLeftColumns(self)->bool:
         """
-    <summary>
-        columns style right to left.
-    </summary>
+        Controls right-to-left column direction.
+        
+        Returns:
+            bool: True if columns use right-to-left flow.
         """
         GetDllLibPpt().ITextFrameProperties_get_RightToLeftColumns.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_RightToLeftColumns.restype=c_bool
@@ -401,6 +487,12 @@ class ITextFrameProperties (SpireObject) :
 
     @RightToLeftColumns.setter
     def RightToLeftColumns(self, value:bool):
+        """
+        Sets column flow direction.
+        
+        Args:
+            value (bool): True for right-to-left column flow.
+        """
         GetDllLibPpt().ITextFrameProperties_set_RightToLeftColumns.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_RightToLeftColumns,self.Ptr, value)
 
@@ -408,10 +500,10 @@ class ITextFrameProperties (SpireObject) :
 
     def TextShapeType(self)->'TextShapeType':
         """
-    <summary>
-        Gets or sets shape type of text.
-             Read/write <see cref="P:Spire.Presentation.ITextFrameProperties.TextShapeType" />.
-    </summary>
+        Gets or sets text container shape type.
+        
+        Returns:
+            TextShapeType: Current text container shape type.
         """
         GetDllLibPpt().ITextFrameProperties_get_TextShapeType.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_get_TextShapeType.restype=c_int
@@ -421,13 +513,22 @@ class ITextFrameProperties (SpireObject) :
 
     @TextShapeType.setter
     def TextShapeType(self, value:'TextShapeType'):
+        """
+        Sets text container shape type.
+        
+        Args:
+            value (TextShapeType): New shape type enum value.
+        """
         GetDllLibPpt().ITextFrameProperties_set_TextShapeType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ITextFrameProperties_set_TextShapeType,self.Ptr, value.value)
 
 
     def GetLayoutLines(self)->List['LineText']:
         """
-
+        Gets laid out text lines information.
+        
+        Returns:
+            List[LineText]: Collection of line text objects.
         """
         GetDllLibPpt().ITextFrameProperties_GetLayoutLines.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_GetLayoutLines.restype=IntPtrArray
@@ -438,7 +539,10 @@ class ITextFrameProperties (SpireObject) :
 
     def GetTextLocation(self)->PointF:
         """
-
+        Gets the position of the text frame.
+        
+        Returns:
+            PointF: (x, y) coordinates of text position.
         """
         GetDllLibPpt().ITextFrameProperties_GetTextLocation.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_GetTextLocation.restype=c_void_p
@@ -449,7 +553,10 @@ class ITextFrameProperties (SpireObject) :
 
     def GetTextSize(self)->SizeF:
         """
-
+        Gets dimensions of the text frame.
+        
+        Returns:
+            SizeF: (width, height) dimensions of text area.
         """
         GetDllLibPpt().ITextFrameProperties_GetTextSize.argtypes=[c_void_p]
         GetDllLibPpt().ITextFrameProperties_GetTextSize.restype=c_void_p