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

spire/xls/XlsComment.py

@@ -7,14 +7,19 @@ from ctypes import *
 import abc
 
 class XlsComment (  XlsShape, IComment, ITextBox) :
-    """
-
+    """Represents a comment in an Excel worksheet.
+    
+    This class provides properties and methods for manipulating comments in Excel,
+    including text formatting, alignment, visibility, and positioning. It extends XlsShape and
+    implements the IComment and ITextBox interfaces.
     """
     @property
 
     def ShapeType(self)->'ExcelShapeType':
-        """
-
+        """Gets the type of the shape.
+        
+        Returns:
+            ExcelShapeType: An enumeration value representing the type of the shape.
         """
         GetDllLibXls().XlsComment_get_ShapeType.argtypes=[c_void_p]
         GetDllLibXls().XlsComment_get_ShapeType.restype=c_int
@@ -25,8 +30,10 @@ class XlsComment (  XlsShape, IComment, ITextBox) :
     @property
 
     def Author(self)->str:
-        """
-
+        """Gets or sets the author of the comment.
+        
+        Returns:
+            str: The name of the author who created the comment.
         """
         GetDllLibXls().XlsComment_get_Author.argtypes=[c_void_p]
         GetDllLibXls().XlsComment_get_Author.restype=c_void_p
@@ -36,13 +43,20 @@ class XlsComment (  XlsShape, IComment, ITextBox) :
 
     @Author.setter
     def Author(self, value:str):
+        """Sets the author of the comment.
+        
+        Args:
+            value (str): The name of the author to set for the comment.
+        """
         GetDllLibXls().XlsComment_set_Author.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsComment_set_Author, self.Ptr, value)
 
     @property
     def AutoSize(self)->bool:
-        """
-
+        """Gets or sets whether the comment is automatically sized.
+        
+        Returns:
+            bool: True if the comment is automatically sized; otherwise, False.
         """
         GetDllLibXls().XlsComment_get_AutoSize.argtypes=[c_void_p]
         GetDllLibXls().XlsComment_get_AutoSize.restype=c_bool
@@ -51,13 +65,20 @@ class XlsComment (  XlsShape, IComment, ITextBox) :
 
     @AutoSize.setter
     def AutoSize(self, value:bool):
+        """Sets whether the comment is automatically sized.
+        
+        Args:
+            value (bool): True to automatically size the comment; otherwise, False.
+        """
         GetDllLibXls().XlsComment_set_AutoSize.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsComment_set_AutoSize, self.Ptr, value)
 
     @property
     def Column(self)->int:
-        """
-
+        """Gets or sets the column index of the cell containing the comment.
+        
+        Returns:
+            int: The zero-based column index.
         """
         GetDllLibXls().XlsComment_get_Column.argtypes=[c_void_p]
         GetDllLibXls().XlsComment_get_Column.restype=c_int
@@ -66,13 +87,20 @@ class XlsComment (  XlsShape, IComment, ITextBox) :
 
     @Column.setter
     def Column(self, value:int):
+        """Sets the column index of the cell containing the comment.
+        
+        Args:
+            value (int): The zero-based column index.
+        """
         GetDllLibXls().XlsComment_set_Column.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsComment_set_Column, self.Ptr, value)
 
     @property
     def Row(self)->int:
-        """
-
+        """Gets or sets the row index of the cell containing the comment.
+        
+        Returns:
+            int: The zero-based row index.
         """
         GetDllLibXls().XlsComment_get_Row.argtypes=[c_void_p]
         GetDllLibXls().XlsComment_get_Row.restype=c_int
@@ -81,14 +109,21 @@ class XlsComment (  XlsShape, IComment, ITextBox) :
 
     @Row.setter
     def Row(self, value:int):
+        """Sets the row index of the cell containing the comment.
+        
+        Args:
+            value (int): The zero-based row index.
+        """
         GetDllLibXls().XlsComment_set_Row.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsComment_set_Row, self.Ptr, value)
 
     @property
 
     def Text(self)->str:
-        """
-
+        """Gets or sets the text content of the comment.
+        
+        Returns:
+            str: The text content of the comment.
         """
         GetDllLibXls().XlsComment_get_Text.argtypes=[c_void_p]
         GetDllLibXls().XlsComment_get_Text.restype=c_void_p
@@ -98,13 +133,20 @@ class XlsComment (  XlsShape, IComment, ITextBox) :
 
     @Text.setter
     def Text(self, value:str):
+        """Sets the text content of the comment.
+        
+        Args:
+            value (str): The text content to set for the comment.
+        """
         GetDllLibXls().XlsComment_set_Text.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsComment_set_Text, self.Ptr, value)
 
     @property
     def IsTextLocked(self)->bool:
-        """
-
+        """Gets or sets whether the text in the comment is locked.
+        
+        Returns:
+            bool: True if the text is locked; otherwise, False.
         """
         GetDllLibXls().XlsComment_get_IsTextLocked.argtypes=[c_void_p]
         GetDllLibXls().XlsComment_get_IsTextLocked.restype=c_bool
@@ -113,14 +155,21 @@ class XlsComment (  XlsShape, IComment, ITextBox) :
 
     @IsTextLocked.setter
     def IsTextLocked(self, value:bool):
+        """Sets whether the text in the comment is locked.
+        
+        Args:
+            value (bool): True to lock the text; otherwise, False.
+        """
         GetDllLibXls().XlsComment_set_IsTextLocked.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsComment_set_IsTextLocked, self.Ptr, value)
 
     @property
 
     def TextRotation(self)->'TextRotationType':
-        """
-
+        """Gets or sets the rotation of the text in the comment.
+        
+        Returns:
+            TextRotationType: An enumeration value representing the text rotation type.
         """
         GetDllLibXls().XlsComment_get_TextRotation.argtypes=[c_void_p]
         GetDllLibXls().XlsComment_get_TextRotation.restype=c_int
@@ -130,14 +179,21 @@ class XlsComment (  XlsShape, IComment, ITextBox) :
 
     @TextRotation.setter
     def TextRotation(self, value:'TextRotationType'):
+        """Sets the rotation of the text in the comment.
+        
+        Args:
+            value (TextRotationType): An enumeration value representing the text rotation type.
+        """
         GetDllLibXls().XlsComment_set_TextRotation.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsComment_set_TextRotation, self.Ptr, value.value)
 
     @property
 
     def RichText(self)->'IRichTextString':
-        """
-
+        """Gets the rich text formatting of the comment text.
+        
+        Returns:
+            IRichTextString: An object representing the rich text formatting.
         """
         GetDllLibXls().XlsComment_get_RichText.argtypes=[c_void_p]
         GetDllLibXls().XlsComment_get_RichText.restype=c_void_p
@@ -149,8 +205,10 @@ class XlsComment (  XlsShape, IComment, ITextBox) :
     @property
 
     def HAlignment(self)->'CommentHAlignType':
-        """
-
+        """Gets or sets the horizontal alignment of the text in the comment.
+        
+        Returns:
+            CommentHAlignType: An enumeration value representing the horizontal alignment.
         """
         GetDllLibXls().XlsComment_get_HAlignment.argtypes=[c_void_p]
         GetDllLibXls().XlsComment_get_HAlignment.restype=c_int
@@ -160,12 +218,16 @@ class XlsComment (  XlsShape, IComment, ITextBox) :
 
     @HAlignment.setter
     def HAlignment(self, value:'CommentHAlignType'):
+        """Sets the horizontal alignment of the text in the comment.
+        
+        Args:
+            value (CommentHAlignType): An enumeration value representing the horizontal alignment.
+        """
         GetDllLibXls().XlsComment_set_HAlignment.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsComment_set_HAlignment, self.Ptr, value.value)
 
     def Remove(self):
-        """
-
+        """Removes the comment from the worksheet.
         """
         GetDllLibXls().XlsComment_Remove.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().XlsComment_Remove, self.Ptr)
@@ -173,8 +235,10 @@ class XlsComment (  XlsShape, IComment, ITextBox) :
     @property
 
     def VAlignment(self)->'CommentVAlignType':
-        """
-
+        """Gets or sets the vertical alignment of the text in the comment.
+        
+        Returns:
+            CommentVAlignType: An enumeration value representing the vertical alignment.
         """
         GetDllLibXls().XlsComment_get_VAlignment.argtypes=[c_void_p]
         GetDllLibXls().XlsComment_get_VAlignment.restype=c_int
@@ -184,13 +248,20 @@ class XlsComment (  XlsShape, IComment, ITextBox) :
 
     @VAlignment.setter
     def VAlignment(self, value:'CommentVAlignType'):
+        """Sets the vertical alignment of the text in the comment.
+        
+        Args:
+            value (CommentVAlignType): An enumeration value representing the vertical alignment.
+        """
         GetDllLibXls().XlsComment_set_VAlignment.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsComment_set_VAlignment, self.Ptr, value.value)
 
     @property
     def IsVisible(self)->bool:
-        """
-
+        """Gets or sets whether the comment is visible.
+        
+        Returns:
+            bool: True if the comment is visible; otherwise, False.
         """
         GetDllLibXls().XlsComment_get_IsVisible.argtypes=[c_void_p]
         GetDllLibXls().XlsComment_get_IsVisible.restype=c_bool
@@ -199,14 +270,21 @@ class XlsComment (  XlsShape, IComment, ITextBox) :
 
     @IsVisible.setter
     def IsVisible(self, value:bool):
+        """Sets whether the comment is visible.
+        
+        Args:
+            value (bool): True to make the comment visible; otherwise, False.
+        """
         GetDllLibXls().XlsComment_set_IsVisible.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsComment_set_IsVisible, self.Ptr, value)
 
     @property
 
     def Fill(self)->'IShapeFill':
-        """
-
+        """Gets the fill formatting of the comment.
+        
+        Returns:
+            IShapeFill: An object representing the fill formatting.
         """
         GetDllLibXls().XlsComment_get_Fill.argtypes=[c_void_p]
         GetDllLibXls().XlsComment_get_Fill.restype=c_void_p

spire/xls/XlsDataValidationTable.py

@@ -7,14 +7,19 @@ from ctypes import *
 import abc
 
 class XlsDataValidationTable (  SpireObject, IDataValidationTable) :
-    """
-
+    """Represents a table of data validations in an Excel worksheet.
+    
+    This class provides properties and methods for accessing and manipulating data validations
+    in an Excel worksheet, including finding, removing, and cloning validations.
+    It extends SpireObject and implements the IDataValidationTable interface.
     """
     @property
 
     def Worksheet(self)->'Worksheet':
-        """
-
+        """Gets the worksheet containing this data validation table.
+        
+        Returns:
+            Worksheet: The worksheet object containing this data validation table.
         """
         GetDllLibXls().XlsDataValidationTable_get_Worksheet.argtypes=[c_void_p]
         GetDllLibXls().XlsDataValidationTable_get_Worksheet.restype=c_void_p
@@ -26,8 +31,10 @@ class XlsDataValidationTable (  SpireObject, IDataValidationTable) :
     @property
 
     def Workbook(self)->'Workbook':
-        """
-
+        """Gets the workbook containing this data validation table.
+        
+        Returns:
+            Workbook: The workbook object containing this data validation table.
         """
         GetDllLibXls().XlsDataValidationTable_get_Workbook.argtypes=[c_void_p]
         GetDllLibXls().XlsDataValidationTable_get_Workbook.restype=c_void_p
@@ -38,8 +45,13 @@ class XlsDataValidationTable (  SpireObject, IDataValidationTable) :
 
 
     def get_Item(self ,index:int)->'XlsDataValidationCollection':
-        """
-
+        """Gets the data validation collection at the specified index.
+        
+        Args:
+            index (int): The zero-based index of the data validation collection.
+            
+        Returns:
+            XlsDataValidationCollection: The data validation collection at the specified index.
         """
         
         GetDllLibXls().XlsDataValidationTable_get_Item.argtypes=[c_void_p ,c_int]
@@ -51,8 +63,10 @@ class XlsDataValidationTable (  SpireObject, IDataValidationTable) :
 
     @property
     def ShapesCount(self)->int:
-        """
-
+        """Gets the number of data validation shapes in the table.
+        
+        Returns:
+            int: The number of data validation shapes.
         """
         GetDllLibXls().XlsDataValidationTable_get_ShapesCount.argtypes=[c_void_p]
         GetDllLibXls().XlsDataValidationTable_get_ShapesCount.restype=c_int
@@ -61,8 +75,13 @@ class XlsDataValidationTable (  SpireObject, IDataValidationTable) :
 
 
     def FindDataValidation(self ,iCellIndex:int)->'IDataValidation':
-        """
-
+        """Finds the data validation for a cell with the specified index.
+        
+        Args:
+            iCellIndex (int): The index of the cell.
+            
+        Returns:
+            IDataValidation: The data validation object for the specified cell, or None if not found.
         """
         
         GetDllLibXls().XlsDataValidationTable_FindDataValidation.argtypes=[c_void_p ,c_long]
@@ -74,8 +93,11 @@ class XlsDataValidationTable (  SpireObject, IDataValidationTable) :
 
 
     def Remove(self ,rectangles:List[Rectangle]):
-        """
-
+        """Removes data validations from the specified rectangular regions.
+        
+        Args:
+            rectangles (List[Rectangle]): A list of Rectangle objects representing the regions
+                from which to remove data validations.
         """
         #arrayrectangles:ArrayTyperectangles = ""
         countrectangles = len(rectangles)
@@ -91,8 +113,13 @@ class XlsDataValidationTable (  SpireObject, IDataValidationTable) :
 
 
     def Clone(self ,parent:'SpireObject')->'SpireObject':
-        """
-
+        """Creates a clone of this data validation table.
+        
+        Args:
+            parent (SpireObject): The parent object for the cloned table.
+            
+        Returns:
+            SpireObject: A new instance of the data validation table with the same validations.
         """
         intPtrparent:c_void_p = parent.Ptr