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

spire/xls/XlsHyperLink.py

@@ -7,14 +7,19 @@ from ctypes import *
 import abc
 
 class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
-    """
-
+    """Represents a hyperlink in an Excel worksheet.
+    
+    This class provides properties and methods for manipulating hyperlinks in Excel,
+    including address, text display, screen tip, and range settings. It extends
+    XlsObject and implements the IHyperLink and ICloneParent interfaces.
     """
     @property
 
     def Address(self)->str:
-        """
-
+        """Gets or sets the URL or path of the hyperlink.
+        
+        Returns:
+            str: The URL or path of the hyperlink.
         """
         GetDllLibXls().XlsHyperLink_get_Address.argtypes=[c_void_p]
         GetDllLibXls().XlsHyperLink_get_Address.restype=c_void_p
@@ -24,14 +29,21 @@ class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
 
     @Address.setter
     def Address(self, value:str):
+        """Sets the URL or path of the hyperlink.
+        
+        Args:
+            value (str): The URL or path of the hyperlink.
+        """
         GetDllLibXls().XlsHyperLink_set_Address.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsHyperLink_set_Address, self.Ptr, value)
 
     @property
 
     def Name(self)->str:
-        """
-
+        """Gets the name of the hyperlink.
+        
+        Returns:
+            str: The name of the hyperlink.
         """
         GetDllLibXls().XlsHyperLink_get_Name.argtypes=[c_void_p]
         GetDllLibXls().XlsHyperLink_get_Name.restype=c_void_p
@@ -42,8 +54,10 @@ class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
     @property
 
     def Range(self)->'IXLSRange':
-        """
-
+        """Gets or sets the range that contains the hyperlink.
+        
+        Returns:
+            IXLSRange: The range that contains the hyperlink.
         """
         from .XlsRange import XlsRange
         GetDllLibXls().XlsHyperLink_get_Range.argtypes=[c_void_p]
@@ -55,14 +69,21 @@ class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
 
     @Range.setter
     def Range(self, value:'IXLSRange'):
+        """Sets the range that contains the hyperlink.
+        
+        Args:
+            value (IXLSRange): The range that contains the hyperlink.
+        """
         GetDllLibXls().XlsHyperLink_set_Range.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsHyperLink_set_Range, self.Ptr, value.Ptr)
 
     @property
 
     def ScreenTip(self)->str:
-        """
-
+        """Gets or sets the screen tip text for the hyperlink.
+        
+        Returns:
+            str: The screen tip text for the hyperlink.
         """
         GetDllLibXls().XlsHyperLink_get_ScreenTip.argtypes=[c_void_p]
         GetDllLibXls().XlsHyperLink_get_ScreenTip.restype=c_void_p
@@ -72,14 +93,24 @@ class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
 
     @ScreenTip.setter
     def ScreenTip(self, value:str):
+        """Sets the screen tip text for the hyperlink.
+        
+        Args:
+            value (str): The screen tip text for the hyperlink.
+        """
         GetDllLibXls().XlsHyperLink_set_ScreenTip.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsHyperLink_set_ScreenTip, self.Ptr, value)
 
     @property
 
     def SubAddress(self)->str:
-        """
-
+        """Gets or sets the sub-address of the hyperlink.
+        
+        The sub-address is typically used to link to a specific location within a document,
+        such as a named range, bookmark, or cell reference.
+        
+        Returns:
+            str: The sub-address of the hyperlink.
         """
         GetDllLibXls().XlsHyperLink_get_SubAddress.argtypes=[c_void_p]
         GetDllLibXls().XlsHyperLink_get_SubAddress.restype=c_void_p
@@ -89,13 +120,21 @@ class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
 
     @SubAddress.setter
     def SubAddress(self, value:str):
+        """Sets the sub-address of the hyperlink.
+        
+        Args:
+            value (str): The sub-address of the hyperlink.
+        """
         GetDllLibXls().XlsHyperLink_set_SubAddress.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsHyperLink_set_SubAddress, self.Ptr, value)
 
 
     def SetAddress(self ,strAddress:str,bSetText:bool):
-        """
-
+        """Sets the address of the hyperlink and optionally updates the display text.
+        
+        Args:
+            strAddress (str): The URL or path of the hyperlink.
+            bSetText (bool): True to update the display text to match the address; otherwise, False.
         """
         
         GetDllLibXls().XlsHyperLink_SetAddress.argtypes=[c_void_p ,c_void_p,c_bool]
@@ -103,8 +142,10 @@ class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
 
 
     def SetSubAddress(self ,strSubAddress:str):
-        """
-
+        """Sets the sub-address of the hyperlink.
+        
+        Args:
+            strSubAddress (str): The sub-address of the hyperlink.
         """
         
         GetDllLibXls().XlsHyperLink_SetSubAddress.argtypes=[c_void_p ,c_void_p]
@@ -113,11 +154,12 @@ class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
     @property
 
     def TextToDisplay(self)->str:
-        """
-    <summary>
-        Returns or sets the text to be displayed for the specified hyperlink.
-            The default value is the address of the hyperlink.
-    </summary>
+        """Gets or sets the text to be displayed for the hyperlink.
+        
+        The default value is the address of the hyperlink.
+        
+        Returns:
+            str: The text to be displayed for the hyperlink.
         """
         GetDllLibXls().XlsHyperLink_get_TextToDisplay.argtypes=[c_void_p]
         GetDllLibXls().XlsHyperLink_get_TextToDisplay.restype=c_void_p
@@ -127,14 +169,21 @@ class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
 
     @TextToDisplay.setter
     def TextToDisplay(self, value:str):
+        """Sets the text to be displayed for the hyperlink.
+        
+        Args:
+            value (str): The text to be displayed for the hyperlink.
+        """
         GetDllLibXls().XlsHyperLink_set_TextToDisplay.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsHyperLink_set_TextToDisplay, self.Ptr, value)
 
     @property
 
     def Type(self)->'HyperLinkType':
-        """
-
+        """Gets or sets the type of the hyperlink.
+        
+        Returns:
+            HyperLinkType: An enumeration value representing the type of the hyperlink.
         """
         GetDllLibXls().XlsHyperLink_get_Type.argtypes=[c_void_p]
         GetDllLibXls().XlsHyperLink_get_Type.restype=c_int
@@ -144,13 +193,20 @@ class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
 
     @Type.setter
     def Type(self, value:'HyperLinkType'):
+        """Sets the type of the hyperlink.
+        
+        Args:
+            value (HyperLinkType): An enumeration value representing the type of the hyperlink.
+        """
         GetDllLibXls().XlsHyperLink_set_Type.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsHyperLink_set_Type, self.Ptr, value.value)
 
     @property
     def FirstRow(self)->int:
-        """
-
+        """Gets the first row of the range containing the hyperlink.
+        
+        Returns:
+            int: The zero-based index of the first row.
         """
         GetDllLibXls().XlsHyperLink_get_FirstRow.argtypes=[c_void_p]
         GetDllLibXls().XlsHyperLink_get_FirstRow.restype=c_int
@@ -159,8 +215,10 @@ class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
 
     @property
     def FirstColumn(self)->int:
-        """
-
+        """Gets the first column of the range containing the hyperlink.
+        
+        Returns:
+            int: The zero-based index of the first column.
         """
         GetDllLibXls().XlsHyperLink_get_FirstColumn.argtypes=[c_void_p]
         GetDllLibXls().XlsHyperLink_get_FirstColumn.restype=c_int
@@ -169,8 +227,10 @@ class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
 
     @property
     def LastRow(self)->int:
-        """
-
+        """Gets the last row of the range containing the hyperlink.
+        
+        Returns:
+            int: The zero-based index of the last row.
         """
         GetDllLibXls().XlsHyperLink_get_LastRow.argtypes=[c_void_p]
         GetDllLibXls().XlsHyperLink_get_LastRow.restype=c_int
@@ -180,13 +240,12 @@ class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
     @property
 
     def UnicodePath(self)->str:
-        """
-    <summary>
-        Gets/sets an optional string of Unicode characters
-            that specifies the complete file path.
-            When the property Type is not HyperLinkType.File,
-            this property is invalid.
-    </summary>
+        """Gets or sets the Unicode file path for the hyperlink.
+        
+        This property is only valid when the Type property is HyperLinkType.File.
+        
+        Returns:
+            str: The Unicode file path for the hyperlink.
         """
         GetDllLibXls().XlsHyperLink_get_UnicodePath.argtypes=[c_void_p]
         GetDllLibXls().XlsHyperLink_get_UnicodePath.restype=c_void_p
@@ -196,13 +255,20 @@ class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
 
     @UnicodePath.setter
     def UnicodePath(self, value:str):
+        """Sets the Unicode file path for the hyperlink.
+        
+        Args:
+            value (str): The Unicode file path for the hyperlink.
+        """
         GetDllLibXls().XlsHyperLink_set_UnicodePath.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsHyperLink_set_UnicodePath, self.Ptr, value)
 
     @property
     def LastColumn(self)->int:
-        """
-
+        """Gets the last column of the range containing the hyperlink.
+        
+        Returns:
+            int: The zero-based index of the last column.
         """
         GetDllLibXls().XlsHyperLink_get_LastColumn.argtypes=[c_void_p]
         GetDllLibXls().XlsHyperLink_get_LastColumn.restype=c_int
@@ -212,11 +278,14 @@ class XlsHyperLink (  XlsObject, IHyperLink, ICloneParent) :
 
     def Clone(self ,parent:'SpireObject')->'SpireObject':
         """
-    <summary>
         Creates a new object that is a copy of the current instance.
-    </summary>
-    <param name="parent">Parent object for a copy of this instance.</param>
-    <returns>A new object that is a copy of this instance.</returns>
+
+        Args:
+            parent: Parent object for a copy of this instance.
+
+        Returns:
+            A new object that is a copy of this instance.
+
         """
         intPtrparent:c_void_p = parent.Ptr
 

spire/xls/XlsLabelShape.py

@@ -7,14 +7,19 @@ from ctypes import *
 import abc
 
 class XlsLabelShape (  XlsShape, ILabelShape) :
-    """
-
+    """Represents a label shape in an Excel worksheet.
+    
+    This class provides properties and methods for manipulating label shapes in Excel,
+    including text content and locking settings. It extends XlsShape and implements
+    the ILabelShape interface.
     """
     @property
 
     def Text(self)->str:
-        """
-
+        """Gets or sets the text displayed in the label shape.
+        
+        Returns:
+            str: The text displayed in the label shape.
         """
         GetDllLibXls().XlsLabelShape_get_Text.argtypes=[c_void_p]
         GetDllLibXls().XlsLabelShape_get_Text.restype=c_void_p
@@ -24,13 +29,20 @@ class XlsLabelShape (  XlsShape, ILabelShape) :
 
     @Text.setter
     def Text(self, value:str):
+        """Sets the text displayed in the label shape.
+        
+        Args:
+            value (str): The text to display in the label shape.
+        """
         GetDllLibXls().XlsLabelShape_set_Text.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsLabelShape_set_Text, self.Ptr, value)
 
     @property
     def IsTextLocked(self)->bool:
-        """
-
+        """Gets or sets whether the text in the label shape is locked.
+        
+        Returns:
+            bool: True if the text is locked; otherwise, False.
         """
         GetDllLibXls().XlsLabelShape_get_IsTextLocked.argtypes=[c_void_p]
         GetDllLibXls().XlsLabelShape_get_IsTextLocked.restype=c_bool
@@ -39,14 +51,21 @@ class XlsLabelShape (  XlsShape, ILabelShape) :
 
     @IsTextLocked.setter
     def IsTextLocked(self, value:bool):
+        """Sets whether the text in the label shape is locked.
+        
+        Args:
+            value (bool): True to lock the text; otherwise, False.
+        """
         GetDllLibXls().XlsLabelShape_set_IsTextLocked.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsLabelShape_set_IsTextLocked, self.Ptr, value)
 
     @property
 
     def ShapeType(self)->'ExcelShapeType':
-        """
-
+        """Gets the type of the shape.
+        
+        Returns:
+            ExcelShapeType: An enumeration value representing the type of the shape.
         """
         GetDllLibXls().XlsLabelShape_get_ShapeType.argtypes=[c_void_p]
         GetDllLibXls().XlsLabelShape_get_ShapeType.restype=c_int