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

spire/xls/interfaces/IXLSRanges.py

@@ -0,0 +1,40 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class IXLSRanges (  IXLSRange) :
+    """Excel ranges collection interface.
+    
+    This interface represents a collection of Excel ranges (IXLSRange objects).
+    It provides functionality for managing multiple ranges, including removing ranges
+    from the collection and accessing ranges by index.
+    
+    Inherits from:
+        IXLSRange: Excel range interface
+    """
+
+    @abc.abstractmethod
+    def Remove(self ,range:'IXLSRange'):
+        """
+        Removes range from the collection.
+
+        Args:
+            range (IXLSRange): Range to remove.
+        """
+        pass
+
+    @abc.abstractmethod
+    def get_Item(self ,index:int)->'IXLSRange':
+        """
+        Returns item by index from the collection.
+
+        Returns:
+            IXLSRange: The range item at the specified index.
+        """
+        pass
+
+

spire/xls/interfaces/IconSet.py

@@ -0,0 +1,125 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class IconSet (SpireObject) :
+    """Icon set conditional formatting interface.
+    
+    This class represents an icon set conditional formatting rule in Excel.
+    Icon sets display different icons for different cell values, providing a visual
+    indicator of the value's relative magnitude. The class allows customization of
+    icon set types, thresholds, order, and display options.
+    
+    Inherits from:
+        SpireObject: Base Spire object class
+    """
+#    @property
+#
+#    def IconCriteria(self)->'IList1':
+#        """
+#    <summary>
+#        Gets an IconCriteria collection
+#    </summary>
+#        """
+#        GetDllLibXls().IconSet_get_IconCriteria.argtypes=[c_void_p]
+#        GetDllLibXls().IconSet_get_IconCriteria.restype=c_void_p
+#        intPtr = CallCFunction(GetDllLibXls().IconSet_get_IconCriteria, self.Ptr)
+#        ret = None if intPtr==None else IList1(intPtr)
+#        return ret
+#
+
+
+    @property
+
+    def IconSetType(self)->'IconSetType':
+        """Gets the icon set type.
+        
+        Returns:
+            IconSetType: The type of icon set used in the conditional formatting.
+        """
+        GetDllLibXls().IconSet_get_IconSetType.argtypes=[c_void_p]
+        GetDllLibXls().IconSet_get_IconSetType.restype=c_int
+        ret = CallCFunction(GetDllLibXls().IconSet_get_IconSetType, self.Ptr)
+        objwraped = IconSetType(ret)
+        return objwraped
+
+    @IconSetType.setter
+    def IconSetType(self, value:'IconSetType'):
+        """Sets the icon set type.
+        
+        Args:
+            value (IconSetType): The type of icon set to use in the conditional formatting.
+        """
+        GetDllLibXls().IconSet_set_IconSetType.argtypes=[c_void_p, c_int]
+        CallCFunction(GetDllLibXls().IconSet_set_IconSetType, self.Ptr, value.value)
+
+    @property
+    def PercentileValues(self)->bool:
+        """Gets whether thresholds for an icon set are determined using percentiles.
+        
+        Returns:
+            bool: True if thresholds are determined using percentiles, otherwise False.
+        """
+        GetDllLibXls().IconSet_get_PercentileValues.argtypes=[c_void_p]
+        GetDllLibXls().IconSet_get_PercentileValues.restype=c_bool
+        ret = CallCFunction(GetDllLibXls().IconSet_get_PercentileValues, self.Ptr)
+        return ret
+
+    @PercentileValues.setter
+    def PercentileValues(self, value:bool):
+        """Sets whether thresholds for an icon set are determined using percentiles.
+        
+        Args:
+            value (bool): True to determine thresholds using percentiles, otherwise False.
+        """
+        GetDllLibXls().IconSet_set_PercentileValues.argtypes=[c_void_p, c_bool]
+        CallCFunction(GetDllLibXls().IconSet_set_PercentileValues, self.Ptr, value)
+
+    @property
+    def IsReverseOrder(self)->bool:
+        """Gets whether the order of icons is reversed for an icon set.
+        
+        Returns:
+            bool: True if the order of icons is reversed, otherwise False.
+        """
+        GetDllLibXls().IconSet_get_IsReverseOrder.argtypes=[c_void_p]
+        GetDllLibXls().IconSet_get_IsReverseOrder.restype=c_bool
+        ret = CallCFunction(GetDllLibXls().IconSet_get_IsReverseOrder, self.Ptr)
+        return ret
+
+    @IsReverseOrder.setter
+    def IsReverseOrder(self, value:bool):
+        """Sets whether the order of icons is reversed for an icon set.
+        
+        Args:
+            value (bool): True to reverse the order of icons, otherwise False.
+        """
+        GetDllLibXls().IconSet_set_IsReverseOrder.argtypes=[c_void_p, c_bool]
+        CallCFunction(GetDllLibXls().IconSet_set_IsReverseOrder, self.Ptr, value)
+
+    @property
+    def ShowIconOnly(self)->bool:
+        """Gets whether only the icon is displayed for an icon set conditional format.
+        
+        Returns:
+            bool: True if only the icon is displayed, otherwise False.
+        """
+        GetDllLibXls().IconSet_get_ShowIconOnly.argtypes=[c_void_p]
+        GetDllLibXls().IconSet_get_ShowIconOnly.restype=c_bool
+        ret = CallCFunction(GetDllLibXls().IconSet_get_ShowIconOnly, self.Ptr)
+        return ret
+
+    @ShowIconOnly.setter
+    def ShowIconOnly(self, value:bool):
+        """Sets whether only the icon is displayed for an icon set conditional format.
+        
+        Args:
+            value (bool): True to display only the icon, otherwise False.
+        """
+        GetDllLibXls().IconSet_set_ShowIconOnly.argtypes=[c_void_p, c_bool]
+        CallCFunction(GetDllLibXls().IconSet_set_ShowIconOnly, self.Ptr, value)
+

spire/xls/interfaces/ImageLocationTypes.py

@@ -0,0 +1,17 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class ImageLocationTypes(Enum):
+    """
+    Defines the location types for images in Excel.
+    
+    This enum specifies how image positions are interpreted within Excel documents.
+    """
+    GlobalAbsolute = 0  # Image position is absolute within the document
+    TableRelative = 1   # Image position is relative to a table
+

spire/xls/interfaces/ImportObjectOptions.py

@@ -0,0 +1,143 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class ImportObjectOptions (SpireObject) :
+    """
+    Represents options for importing objects into Excel.
+    
+    This class provides various settings to control how data is imported into Excel worksheets.
+    """
+    @dispatch
+    def __init__(self):
+        GetDllLibXls().ImportObjectOptions_Create.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibXls().ImportObjectOptions_Create)
+
+        super(ImportObjectOptions, self).__init__(intPtr)
+
+    @property
+    def ConvertNumericData(self)->bool:
+        """
+        Gets whether to convert text data to numeric data during import.
+        
+        Returns:
+            bool: True if numeric data conversion is enabled, False otherwise.
+        """
+        GetDllLibXls().ImportObjectOptions_get_ConvertNumericData.argtypes=[c_void_p]
+        GetDllLibXls().ImportObjectOptions_get_ConvertNumericData.restype=c_bool
+        ret = CallCFunction(GetDllLibXls().ImportObjectOptions_get_ConvertNumericData, self.Ptr)
+        return ret
+
+    @ConvertNumericData.setter
+    def ConvertNumericData(self, value:bool):
+        """
+        Sets whether to convert text data to numeric data during import.
+        
+        Args:
+            value (bool): True to enable numeric data conversion, False otherwise.
+        """
+        GetDllLibXls().ImportObjectOptions_set_ConvertNumericData.argtypes=[c_void_p, c_bool]
+        CallCFunction(GetDllLibXls().ImportObjectOptions_set_ConvertNumericData, self.Ptr, value)
+
+    @property
+    def InsertRows(self)->bool:
+        """
+        Gets whether to insert rows when importing data.
+        
+        Returns:
+            bool: True if rows should be inserted, False otherwise.
+        """
+        GetDllLibXls().ImportObjectOptions_get_InsertRows.argtypes=[c_void_p]
+        GetDllLibXls().ImportObjectOptions_get_InsertRows.restype=c_bool
+        ret = CallCFunction(GetDllLibXls().ImportObjectOptions_get_InsertRows, self.Ptr)
+        return ret
+
+    @InsertRows.setter
+    def InsertRows(self, value:bool):
+        """
+        Sets whether to insert rows when importing data.
+        
+        Args:
+            value (bool): True to insert rows, False otherwise.
+        """
+        GetDllLibXls().ImportObjectOptions_set_InsertRows.argtypes=[c_void_p, c_bool]
+        CallCFunction(GetDllLibXls().ImportObjectOptions_set_InsertRows, self.Ptr, value)
+
+    @property
+    def CheckMergedCells(self)->bool:
+        """
+        Gets whether to check for merged cells during import.
+        
+        Returns:
+            bool: True if merged cells should be checked, False otherwise.
+        """
+        GetDllLibXls().ImportObjectOptions_get_CheckMergedCells.argtypes=[c_void_p]
+        GetDllLibXls().ImportObjectOptions_get_CheckMergedCells.restype=c_bool
+        ret = CallCFunction(GetDllLibXls().ImportObjectOptions_get_CheckMergedCells, self.Ptr)
+        return ret
+
+    @CheckMergedCells.setter
+    def CheckMergedCells(self, value:bool):
+        """
+        Sets whether to check for merged cells during import.
+        
+        Args:
+            value (bool): True to check merged cells, False otherwise.
+        """
+        GetDllLibXls().ImportObjectOptions_set_CheckMergedCells.argtypes=[c_void_p, c_bool]
+        CallCFunction(GetDllLibXls().ImportObjectOptions_set_CheckMergedCells, self.Ptr, value)
+
+    @property
+    def IsFieldNameShown(self)->bool:
+        """
+        Gets whether field names should be shown in the imported data.
+        
+        Returns:
+            bool: True if field names should be shown, False otherwise.
+        """
+        GetDllLibXls().ImportObjectOptions_get_IsFieldNameShown.argtypes=[c_void_p]
+        GetDllLibXls().ImportObjectOptions_get_IsFieldNameShown.restype=c_bool
+        ret = CallCFunction(GetDllLibXls().ImportObjectOptions_get_IsFieldNameShown, self.Ptr)
+        return ret
+
+    @IsFieldNameShown.setter
+    def IsFieldNameShown(self, value:bool):
+        """
+        Sets whether field names should be shown in the imported data.
+        
+        Args:
+            value (bool): True to show field names, False otherwise.
+        """
+        GetDllLibXls().ImportObjectOptions_set_IsFieldNameShown.argtypes=[c_void_p, c_bool]
+        CallCFunction(GetDllLibXls().ImportObjectOptions_set_IsFieldNameShown, self.Ptr, value)
+
+    @property
+
+    def DateFormat(self)->str:
+        """
+        Gets the date format to use when importing date values.
+        
+        Returns:
+            str: The date format string.
+        """
+        GetDllLibXls().ImportObjectOptions_get_DateFormat.argtypes=[c_void_p]
+        GetDllLibXls().ImportObjectOptions_get_DateFormat.restype=c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibXls().ImportObjectOptions_get_DateFormat, self.Ptr))
+        return ret
+
+
+    @DateFormat.setter
+    def DateFormat(self, value:str):
+        """
+        Sets the date format to use when importing date values.
+        
+        Args:
+            value (str): The date format string.
+        """
+        GetDllLibXls().ImportObjectOptions_set_DateFormat.argtypes=[c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibXls().ImportObjectOptions_set_DateFormat, self.Ptr, value)
+

spire/xls/interfaces/InsertMoveOption.py

@@ -0,0 +1,17 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class InsertMoveOption(Enum):
+    """
+    Specifies how existing cells should be moved when inserting new cells.
+    
+    This enum defines the direction in which existing cells move when new cells are inserted.
+    """
+    MoveDown = 0  # Moves existing cells down when inserting new cells
+    MoveRight = 1  # Moves existing cells to the right when inserting new cells
+

spire/xls/interfaces/InteriorArrayWrapper.py

@@ -0,0 +1,181 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class InteriorArrayWrapper (  XlsObject, IInterior) :
+    """
+    Wrapper class for an array of interior formatting objects.
+    
+    This class implements the IInterior interface and provides methods to manipulate
+    the interior formatting properties of multiple Excel objects simultaneously.
+    """
+    @property
+
+    def PatternKnownColor(self)->'ExcelColors':
+        """
+        Gets the known color of the pattern.
+        
+        Returns:
+            ExcelColors: The pattern color as an ExcelColors enum value.
+        """
+        GetDllLibXls().InteriorArrayWrapper_get_PatternKnownColor.argtypes=[c_void_p]
+        GetDllLibXls().InteriorArrayWrapper_get_PatternKnownColor.restype=c_int
+        ret = CallCFunction(GetDllLibXls().InteriorArrayWrapper_get_PatternKnownColor, self.Ptr)
+        objwraped = ExcelColors(ret)
+        return objwraped
+
+    @PatternKnownColor.setter
+    def PatternKnownColor(self, value:'ExcelColors'):
+        """
+        Sets the known color of the pattern.
+        
+        Args:
+            value (ExcelColors): The pattern color as an ExcelColors enum value.
+        """
+        GetDllLibXls().InteriorArrayWrapper_set_PatternKnownColor.argtypes=[c_void_p, c_int]
+        CallCFunction(GetDllLibXls().InteriorArrayWrapper_set_PatternKnownColor, self.Ptr, value.value)
+
+    @property
+
+    def PatternColor(self)->'Color':
+        """
+        Gets the color of the pattern.
+        
+        Returns:
+            Color: The pattern color object.
+        """
+        GetDllLibXls().InteriorArrayWrapper_get_PatternColor.argtypes=[c_void_p]
+        GetDllLibXls().InteriorArrayWrapper_get_PatternColor.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().InteriorArrayWrapper_get_PatternColor, self.Ptr)
+        ret = None if intPtr==None else Color(intPtr)
+        return ret
+
+
+    @PatternColor.setter
+    def PatternColor(self, value:'Color'):
+        """
+        Sets the color of the pattern.
+        
+        Args:
+            value (Color): The pattern color object.
+        """
+        GetDllLibXls().InteriorArrayWrapper_set_PatternColor.argtypes=[c_void_p, c_void_p]
+        CallCFunction(GetDllLibXls().InteriorArrayWrapper_set_PatternColor, self.Ptr, value.Ptr)
+
+    @property
+
+    def KnownColor(self)->'ExcelColors':
+        """
+        Gets the known color of the interior.
+        
+        Returns:
+            ExcelColors: The interior color as an ExcelColors enum value.
+        """
+        GetDllLibXls().InteriorArrayWrapper_get_KnownColor.argtypes=[c_void_p]
+        GetDllLibXls().InteriorArrayWrapper_get_KnownColor.restype=c_int
+        ret = CallCFunction(GetDllLibXls().InteriorArrayWrapper_get_KnownColor, self.Ptr)
+        objwraped = ExcelColors(ret)
+        return objwraped
+
+    @KnownColor.setter
+    def KnownColor(self, value:'ExcelColors'):
+        """
+        Sets the known color of the interior.
+        
+        Args:
+            value (ExcelColors): The interior color as an ExcelColors enum value.
+        """
+        GetDllLibXls().InteriorArrayWrapper_set_KnownColor.argtypes=[c_void_p, c_int]
+        CallCFunction(GetDllLibXls().InteriorArrayWrapper_set_KnownColor, self.Ptr, value.value)
+
+    @property
+
+    def Color(self)->'Color':
+        """
+        Gets the color of the interior.
+        
+        Returns:
+            Color: The interior color object.
+        """
+        GetDllLibXls().InteriorArrayWrapper_get_Color.argtypes=[c_void_p]
+        GetDllLibXls().InteriorArrayWrapper_get_Color.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().InteriorArrayWrapper_get_Color, self.Ptr)
+        ret = None if intPtr==None else Color(intPtr)
+        return ret
+
+
+    @Color.setter
+    def Color(self, value:'Color'):
+        """
+        Sets the color of the interior.
+        
+        Args:
+            value (Color): The interior color object.
+        """
+        GetDllLibXls().InteriorArrayWrapper_set_Color.argtypes=[c_void_p, c_void_p]
+        CallCFunction(GetDllLibXls().InteriorArrayWrapper_set_Color, self.Ptr, value.Ptr)
+
+    @property
+
+    def Gradient(self)->'ExcelGradient':
+        """
+        Gets the gradient formatting of the interior.
+        
+        Returns:
+            ExcelGradient: The gradient formatting object.
+        """
+        GetDllLibXls().InteriorArrayWrapper_get_Gradient.argtypes=[c_void_p]
+        GetDllLibXls().InteriorArrayWrapper_get_Gradient.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().InteriorArrayWrapper_get_Gradient, self.Ptr)
+        ret = None if intPtr==None else ExcelGradient(intPtr)
+        return ret
+
+
+    @property
+
+    def FillPattern(self)->'ExcelPatternType':
+        """
+        Gets the fill pattern of the interior.
+        
+        Returns:
+            ExcelPatternType: The fill pattern type.
+        """
+        GetDllLibXls().InteriorArrayWrapper_get_FillPattern.argtypes=[c_void_p]
+        GetDllLibXls().InteriorArrayWrapper_get_FillPattern.restype=c_int
+        ret = CallCFunction(GetDllLibXls().InteriorArrayWrapper_get_FillPattern, self.Ptr)
+        objwraped = ExcelPatternType(ret)
+        return objwraped
+
+    @FillPattern.setter
+    def FillPattern(self, value:'ExcelPatternType'):
+        """
+        Sets the fill pattern of the interior.
+        
+        Args:
+            value (ExcelPatternType): The fill pattern type.
+        """
+        GetDllLibXls().InteriorArrayWrapper_set_FillPattern.argtypes=[c_void_p, c_int]
+        CallCFunction(GetDllLibXls().InteriorArrayWrapper_set_FillPattern, self.Ptr, value.value)
+
+    def BeginUpdate(self):
+        """
+        Begins a batch update operation on the interior array.
+        
+        This method should be called before making multiple changes to the interior properties.
+        """
+        GetDllLibXls().InteriorArrayWrapper_BeginUpdate.argtypes=[c_void_p]
+        CallCFunction(GetDllLibXls().InteriorArrayWrapper_BeginUpdate, self.Ptr)
+
+    def EndUpdate(self):
+        """
+        Ends a batch update operation on the interior array.
+        
+        This method should be called after making multiple changes to the interior properties.
+        """
+        GetDllLibXls().InteriorArrayWrapper_EndUpdate.argtypes=[c_void_p]
+        CallCFunction(GetDllLibXls().InteriorArrayWrapper_EndUpdate, self.Ptr)
+

spire/xls/interfaces/collections/IDataValidationCollection.py

@@ -0,0 +1,128 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class IDataValidationCollection (abc.ABC) :
+    """
+
+    """
+    @property
+    @abc.abstractmethod
+    def IsPromptBoxPositionFixed(self)->bool:
+        """
+        Indicates whehter prompt box has fixed position..
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IsPromptBoxVisible(self)->bool:
+        """
+        Indicates whehter prompt box is visible..
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def ParentTable(self)->'IDataValidationTable':
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def PromptBoxHPosition(self)->int:
+        """
+        Vertical position of the prompt box.
+
+        """
+        pass
+
+
+    @PromptBoxHPosition.setter
+    @abc.abstractmethod
+    def PromptBoxHPosition(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def PromptBoxVPosition(self)->int:
+        """
+        Vertical position of the prompt box.
+
+        """
+        pass
+
+
+    @PromptBoxVPosition.setter
+    @abc.abstractmethod
+    def PromptBoxVPosition(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def ShapesCount(self)->int:
+        """
+
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def get_Item(self ,index:int)->'IDataValidation':
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Workbook(self)->'Workbook':
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Worksheet(self)->'Worksheet':
+        """
+
+        """
+        pass
+
+
+#
+#    @abc.abstractmethod
+#    def Remove(self ,rectangles:'Rectangle[]'):
+#        """
+#
+#        """
+#        pass
+#
+
+

spire/xls/interfaces/collections/IHPageBreaks.py

@@ -0,0 +1,37 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class IHPageBreaks (  abc.ABC) :
+    """Collection of horizontal page breaks in a worksheet.
+    
+    This interface represents a collection of horizontal page breaks in an Excel worksheet.
+    It provides access to the count of horizontal page breaks and methods to manage them.
+    """
+    @property
+    @abc.abstractmethod
+    def Count(self)->int:
+        """Gets the number of horizontal page breaks in the collection.
+        
+        Returns:
+            int: The number of horizontal page breaks.
+        """
+        pass
+
+
+    #@property
+
+    #@abc.abstractmethod
+    #def Parent(self)->'SpireObject':
+    #    """Gets the parent object of the horizontal page breaks collection.
+    #    
+    #    Returns:
+    #        SpireObject: The parent object that contains this collection.
+    #    """
+    #    pass
+
+