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

spire/xls/XlsDocumentProperty.py

@@ -7,13 +7,18 @@ from ctypes import *
 import abc
 
 class XlsDocumentProperty (  IDocumentProperty) :
-    """
-
+    """Represents a document property in an Excel workbook.
+    
+    This class provides properties and methods for accessing and manipulating document
+    properties (metadata) in Excel workbooks, such as title, author, creation date, etc.
+    It implements the IDocumentProperty interface.
     """
     @property
     def IsBuiltIn(self)->bool:
-        """
-
+        """Gets whether the property is a built-in document property.
+        
+        Returns:
+            bool: True if the property is built-in; otherwise, False.
         """
         GetDllLibXls().XlsDocumentProperty_get_IsBuiltIn.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_IsBuiltIn.restype=c_bool
@@ -23,8 +28,10 @@ class XlsDocumentProperty (  IDocumentProperty) :
     @property
 
     def PropertyId(self)->'BuiltInPropertyType':
-        """
-
+        """Gets or sets the ID of the built-in property.
+        
+        Returns:
+            BuiltInPropertyType: An enumeration value representing the built-in property type.
         """
         GetDllLibXls().XlsDocumentProperty_get_PropertyId.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_PropertyId.restype=c_int
@@ -34,14 +41,21 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @PropertyId.setter
     def PropertyId(self, value:'BuiltInPropertyType'):
+        """Sets the ID of the built-in property.
+        
+        Args:
+            value (BuiltInPropertyType): An enumeration value representing the built-in property type.
+        """
         GetDllLibXls().XlsDocumentProperty_set_PropertyId.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsDocumentProperty_set_PropertyId, self.Ptr, value.value)
 
     @property
 
     def Name(self)->str:
-        """
-
+        """Gets the name of the document property.
+        
+        Returns:
+            str: The name of the document property.
         """
         GetDllLibXls().XlsDocumentProperty_get_Name.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_Name.restype=c_void_p
@@ -52,8 +66,10 @@ class XlsDocumentProperty (  IDocumentProperty) :
     @property
 
     def Value(self)->'SpireObject':
-        """
-
+        """Gets or sets the value of the document property as a generic object.
+        
+        Returns:
+            SpireObject: The value of the document property.
         """
         GetDllLibXls().XlsDocumentProperty_get_Value.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_Value.restype=c_void_p
@@ -64,13 +80,20 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @Value.setter
     def Value(self, value:'SpireObject'):
+        """Sets the value of the document property as a generic object.
+        
+        Args:
+            value (SpireObject): The value to set for the document property.
+        """
         GetDllLibXls().XlsDocumentProperty_set_Value.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsDocumentProperty_set_Value, self.Ptr, value.Ptr)
 
     @property
     def Boolean(self)->bool:
-        """
-
+        """Gets or sets the value of the document property as a boolean.
+        
+        Returns:
+            bool: The boolean value of the document property.
         """
         GetDllLibXls().XlsDocumentProperty_get_Boolean.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_Boolean.restype=c_bool
@@ -79,13 +102,20 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @Boolean.setter
     def Boolean(self, value:bool):
+        """Sets the value of the document property as a boolean.
+        
+        Args:
+            value (bool): The boolean value to set for the document property.
+        """
         GetDllLibXls().XlsDocumentProperty_set_Boolean.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsDocumentProperty_set_Boolean, self.Ptr, value)
 
     @property
     def Integer(self)->int:
-        """
-
+        """Gets or sets the value of the document property as an integer.
+        
+        Returns:
+            int: The integer value of the document property.
         """
         GetDllLibXls().XlsDocumentProperty_get_Integer.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_Integer.restype=c_int
@@ -94,13 +124,20 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @Integer.setter
     def Integer(self, value:int):
+        """Sets the value of the document property as an integer.
+        
+        Args:
+            value (int): The integer value to set for the document property.
+        """
         GetDllLibXls().XlsDocumentProperty_set_Integer.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsDocumentProperty_set_Integer, self.Ptr, value)
 
     @property
     def Int32(self)->int:
-        """
-
+        """Gets or sets the value of the document property as a 32-bit integer.
+        
+        Returns:
+            int: The 32-bit integer value of the document property.
         """
         GetDllLibXls().XlsDocumentProperty_get_Int32.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_Int32.restype=c_int
@@ -109,13 +146,20 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @Int32.setter
     def Int32(self, value:int):
+        """Sets the value of the document property as a 32-bit integer.
+        
+        Args:
+            value (int): The 32-bit integer value to set for the document property.
+        """
         GetDllLibXls().XlsDocumentProperty_set_Int32.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsDocumentProperty_set_Int32, self.Ptr, value)
 
     @property
     def Double(self)->float:
-        """
-
+        """Gets or sets the value of the document property as a double-precision floating-point number.
+        
+        Returns:
+            float: The double-precision floating-point value of the document property.
         """
         GetDllLibXls().XlsDocumentProperty_get_Double.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_Double.restype=c_double
@@ -124,14 +168,21 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @Double.setter
     def Double(self, value:float):
+        """Sets the value of the document property as a double-precision floating-point number.
+        
+        Args:
+            value (float): The double-precision floating-point value to set for the document property.
+        """
         GetDllLibXls().XlsDocumentProperty_set_Double.argtypes=[c_void_p, c_double]
         CallCFunction(GetDllLibXls().XlsDocumentProperty_set_Double, self.Ptr, value)
 
     @property
 
     def Text(self)->str:
-        """
-
+        """Gets or sets the value of the document property as text.
+        
+        Returns:
+            str: The text value of the document property.
         """
         GetDllLibXls().XlsDocumentProperty_get_Text.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_Text.restype=c_void_p
@@ -141,14 +192,21 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @Text.setter
     def Text(self, value:str):
+        """Sets the value of the document property as text.
+        
+        Args:
+            value (str): The text value to set for the document property.
+        """
         GetDllLibXls().XlsDocumentProperty_set_Text.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsDocumentProperty_set_Text, self.Ptr, value)
 
     @property
 
     def DateTime(self)->'DateTime':
-        """
-
+        """Gets or sets the value of the document property as a date and time.
+        
+        Returns:
+            DateTime: The date and time value of the document property.
         """
         GetDllLibXls().XlsDocumentProperty_get_DateTime.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_DateTime.restype=c_void_p
@@ -159,14 +217,21 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @DateTime.setter
     def DateTime(self, value:'DateTime'):
+        """Sets the value of the document property as a date and time.
+        
+        Args:
+            value (DateTime): The date and time value to set for the document property.
+        """
         GetDllLibXls().XlsDocumentProperty_set_DateTime.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsDocumentProperty_set_DateTime, self.Ptr, value.Ptr)
 
     @property
 
     def TimeSpan(self)->'TimeSpan':
-        """
-
+        """Gets or sets the value of the document property as a time span.
+        
+        Returns:
+            TimeSpan: The time span value of the document property.
         """
         GetDllLibXls().XlsDocumentProperty_get_TimeSpan.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_TimeSpan.restype=c_void_p
@@ -177,6 +242,11 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @TimeSpan.setter
     def TimeSpan(self, value:'TimeSpan'):
+        """Sets the value of the document property as a time span.
+        
+        Args:
+            value (TimeSpan): The time span value to set for the document property.
+        """
         GetDllLibXls().XlsDocumentProperty_set_TimeSpan.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsDocumentProperty_set_TimeSpan, self.Ptr, value.Ptr)
 
@@ -207,8 +277,10 @@ class XlsDocumentProperty (  IDocumentProperty) :
     @property
 
     def StringArray(self)->List[str]:
-        """
-
+        """Gets or sets the value of the document property as an array of strings.
+        
+        Returns:
+            List[str]: The string array value of the document property.
         """
         GetDllLibXls().XlsDocumentProperty_get_StringArray.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_StringArray.restype=IntPtrArray
@@ -218,6 +290,11 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @StringArray.setter
     def StringArray(self, value:List[str]):
+        """Sets the value of the document property as an array of strings.
+        
+        Args:
+            value (List[str]): The string array value to set for the document property.
+        """
         vCount = len(value)
         ArrayType = c_wchar_p * vCount
         vArray = ArrayType()
@@ -229,8 +306,10 @@ class XlsDocumentProperty (  IDocumentProperty) :
     @property
 
     def ObjectArray(self)->List['SpireObject']:
-        """
-
+        """Gets or sets the value of the document property as an array of objects.
+        
+        Returns:
+            List[SpireObject]: The object array value of the document property.
         """
         GetDllLibXls().XlsDocumentProperty_get_ObjectArray.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_ObjectArray.restype=IntPtrArray
@@ -240,6 +319,11 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @ObjectArray.setter
     def ObjectArray(self, value:List['SpireObject']):
+        """Sets the value of the document property as an array of objects.
+        
+        Args:
+            value (List[SpireObject]): The object array value to set for the document property.
+        """
         vCount = len(value)
         ArrayType = c_void_p * vCount
         vArray = ArrayType()
@@ -251,8 +335,10 @@ class XlsDocumentProperty (  IDocumentProperty) :
     @property
 
     def PropertyType(self)->'PropertyType':
-        """
-
+        """Gets or sets the type of the document property.
+        
+        Returns:
+            PropertyType: An enumeration value representing the property type.
         """
         GetDllLibXls().XlsDocumentProperty_get_PropertyType.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_PropertyType.restype=c_int
@@ -262,14 +348,21 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @PropertyType.setter
     def PropertyType(self, value:'PropertyType'):
+        """Sets the type of the document property.
+        
+        Args:
+            value (PropertyType): An enumeration value representing the property type.
+        """
         GetDllLibXls().XlsDocumentProperty_set_PropertyType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsDocumentProperty_set_PropertyType, self.Ptr, value.value)
 
     @property
 
     def LinkSource(self)->str:
-        """
-
+        """Gets or sets the source of the linked document property.
+        
+        Returns:
+            str: The source of the linked document property.
         """
         GetDllLibXls().XlsDocumentProperty_get_LinkSource.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_LinkSource.restype=c_void_p
@@ -279,13 +372,20 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @LinkSource.setter
     def LinkSource(self, value:str):
+        """Sets the source of the linked document property.
+        
+        Args:
+            value (str): The source of the linked document property.
+        """
         GetDllLibXls().XlsDocumentProperty_set_LinkSource.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsDocumentProperty_set_LinkSource, self.Ptr, value)
 
     @property
     def LinkToContent(self)->bool:
-        """
-
+        """Gets or sets whether the document property is linked to content.
+        
+        Returns:
+            bool: True if the property is linked to content; otherwise, False.
         """
         GetDllLibXls().XlsDocumentProperty_get_LinkToContent.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_LinkToContent.restype=c_bool
@@ -294,14 +394,21 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @LinkToContent.setter
     def LinkToContent(self, value:bool):
+        """Sets whether the document property is linked to content.
+        
+        Args:
+            value (bool): True to link the property to content; otherwise, False.
+        """
         GetDllLibXls().XlsDocumentProperty_set_LinkToContent.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsDocumentProperty_set_LinkToContent, self.Ptr, value)
 
     @property
 
     def InternalName(self)->str:
-        """
-
+        """Gets the internal name of the document property.
+        
+        Returns:
+            str: The internal name of the document property.
         """
         GetDllLibXls().XlsDocumentProperty_get_InternalName.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_get_InternalName.restype=c_void_p
@@ -311,8 +418,14 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
 
     def FillPropVariant(self ,variant:'IPropertyData',iPropertyId:int)->bool:
-        """
-
+        """Fills a property variant with the document property data.
+        
+        Args:
+            variant (IPropertyData): The property data object to fill.
+            iPropertyId (int): The ID of the property.
+            
+        Returns:
+            bool: True if the operation was successful; otherwise, False.
         """
         intPtrvariant:c_void_p = variant.Ptr
 
@@ -338,8 +451,10 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
 
     def SetLinkSource(self ,variant:'IPropertyData'):
-        """
-
+        """Sets the link source for the document property using property data.
+        
+        Args:
+            variant (IPropertyData): The property data containing the link source.
         """
         intPtrvariant:c_void_p = variant.Ptr
 
@@ -348,8 +463,10 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
 
     def Clone(self)->'SpireObject':
-        """
-
+        """Creates a clone of this document property.
+        
+        Returns:
+            SpireObject: A new instance of the document property with the same values.
         """
         GetDllLibXls().XlsDocumentProperty_Clone.argtypes=[c_void_p]
         GetDllLibXls().XlsDocumentProperty_Clone.restype=c_void_p
@@ -360,8 +477,10 @@ class XlsDocumentProperty (  IDocumentProperty) :
 
     @staticmethod
     def DEF_FILE_TIME_START_YEAR()->int:
-        """
-
+        """Gets the default file time start year constant.
+        
+        Returns:
+            int: The default file time start year (typically 1601).
         """
         #GetDllLibXls().XlsDocumentProperty_DEF_FILE_TIME_START_YEAR.argtypes=[]
         GetDllLibXls().XlsDocumentProperty_DEF_FILE_TIME_START_YEAR.restype=c_int

spire/xls/XlsEventArgs.py

@@ -7,19 +7,19 @@ from ctypes import *
 import abc
 
 class XlsEventArgs (SpireObject) :
-    """
-    <summary>
-        Class used as message sender on Property value change. Class provides old and
-            new values which allow user to create advanced logic.
-    </summary>
+    """Class used as message sender on Property value change.
+    
+    This class provides old and new values which allow user to create advanced logic.
+    It can be used to track changes in property values and implement custom behaviors
+    based on these changes.
     """
     @property
 
     def newValue(self)->'SpireObject':
-        """
-    <summary>
-        New property value.Read-only.
-    </summary>
+        """Gets the new property value.
+        
+        Returns:
+            SpireObject: The new value of the property after the change.
         """
         GetDllLibXls().XlsEventArgs_get_newValue.argtypes=[c_void_p]
         GetDllLibXls().XlsEventArgs_get_newValue.restype=c_void_p
@@ -31,10 +31,10 @@ class XlsEventArgs (SpireObject) :
     @property
 
     def oldValue(self)->'SpireObject':
-        """
-    <summary>
-        Old property value. Read-only.
-    </summary>
+        """Gets the old property value.
+        
+        Returns:
+            SpireObject: The original value of the property before the change.
         """
         GetDllLibXls().XlsEventArgs_get_oldValue.argtypes=[c_void_p]
         GetDllLibXls().XlsEventArgs_get_oldValue.restype=c_void_p
@@ -46,10 +46,10 @@ class XlsEventArgs (SpireObject) :
     @property
 
     def Name(self)->str:
-        """
-    <summary>
-        Name of the property. Read-only.
-    </summary>
+        """Gets the name of the property.
+        
+        Returns:
+            str: The name of the property that was changed.
         """
         GetDllLibXls().XlsEventArgs_get_Name.argtypes=[c_void_p]
         GetDllLibXls().XlsEventArgs_get_Name.restype=c_void_p
@@ -60,11 +60,13 @@ class XlsEventArgs (SpireObject) :
     @property
 
     def Next(self)->'XlsEventArgs':
-        """
-    <summary>
-        If more than one property must be changed on one send message, 
-            attach it to the ValueChangeEventArgs to create a one way directed list of property changes.
-    </summary>
+        """Gets or sets the next event args in the chain.
+        
+        If more than one property must be changed on one send message, this property
+        allows creating a one-way directed list of property changes.
+        
+        Returns:
+            XlsEventArgs: The next event args in the chain.
         """
         GetDllLibXls().XlsEventArgs_get_Next.argtypes=[c_void_p]
         GetDllLibXls().XlsEventArgs_get_Next.restype=c_void_p
@@ -75,14 +77,21 @@ class XlsEventArgs (SpireObject) :
 
     @Next.setter
     def Next(self, value:'XlsEventArgs'):
+        """Sets the next event args in the chain.
+        
+        Args:
+            value (XlsEventArgs): The next event args to add to the chain.
+        """
         GetDllLibXls().XlsEventArgs_set_Next.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsEventArgs_set_Next, self.Ptr, value.Ptr)
 
     @staticmethod
 
     def get_Empty()->'XlsEventArgs':
-        """
-
+        """Gets an empty XlsEventArgs instance.
+        
+        Returns:
+            XlsEventArgs: An empty instance of XlsEventArgs.
         """
         #GetDllLibXls().XlsEventArgs_get_Empty.argtypes=[]
         GetDllLibXls().XlsEventArgs_get_Empty.restype=c_void_p

spire/xls/XlsEventHandler.py

@@ -7,13 +7,19 @@ from ctypes import *
 import abc
 
 class XlsEventHandler (SpireObject) :
-    """
-
+    """Represents an event handler for Excel events.
+    
+    This class provides functionality for handling events in Excel, such as property changes,
+    worksheet events, and workbook events. It extends SpireObject and can be used to implement
+    custom event handling logic.
     """
 
     def Invoke(self ,sender:'SpireObject',e:'XlsEventArgs'):
-        """
-
+        """Invokes the event handler with the specified sender and event arguments.
+        
+        Args:
+            sender (SpireObject): The object that raised the event.
+            e (XlsEventArgs): The event arguments containing information about the event.
         """
         intPtrsender:c_void_p = sender.Ptr
         intPtre:c_void_p = e.Ptr