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

spire/xls/collection/pivot_table/PivotTableFields.py

@@ -0,0 +1,108 @@
+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 PivotTableFields (  CollectionBase[XlsPivotField], ICloneParent, IPivotFields) :
+    """Represents a collection of PivotTable fields.
+    
+    This class provides methods to access, add, remove, and manage fields in a PivotTable.
+    PivotTable fields represent the data columns that can be used as row fields, column fields,
+    page fields, or data fields in a PivotTable.
+    """
+    @dispatch
+    def get_Item(self ,name:str)->IPivotField:
+        """Gets a PivotField object by name from the collection.
+        
+        Args:
+            name (str): The name of the field to retrieve.
+            
+        Returns:
+            IPivotField: The PivotField object with the specified name.
+        """
+        
+        GetDllLibXls().PivotTableFields_get_Item.argtypes=[c_void_p ,c_void_p]
+        GetDllLibXls().PivotTableFields_get_Item.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().PivotTableFields_get_Item, self.Ptr, name)
+        ret = None if intPtr==None else XlsPivotField(intPtr)
+        return ret
+
+
+
+    def Clone(self ,parent:'SpireObject')->'SpireObject':
+        """Creates a clone of this PivotTableFields collection.
+        
+        Args:
+            parent (SpireObject): The parent object for the cloned collection.
+            
+        Returns:
+            SpireObject: The cloned PivotTableFields collection.
+        """
+        intPtrparent:c_void_p = parent.Ptr
+
+        GetDllLibXls().PivotTableFields_Clone.argtypes=[c_void_p ,c_void_p]
+        GetDllLibXls().PivotTableFields_Clone.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().PivotTableFields_Clone, self.Ptr, intPtrparent)
+        ret = None if intPtr==None else SpireObject(intPtr)
+        return ret
+
+
+
+    def RemoveAt(self ,index:int):
+        """Removes a PivotField from the collection at the specified index.
+        
+        Args:
+            index (int): The zero-based index of the field to remove.
+        """
+        
+        GetDllLibXls().PivotTableFields_RemoveAt.argtypes=[c_void_p ,c_int]
+        CallCFunction(GetDllLibXls().PivotTableFields_RemoveAt, self.Ptr, index)
+
+
+    def Remove(self ,item:'PivotField')->bool:
+        """Removes a specific PivotField from the collection.
+        
+        Args:
+            item (PivotField): The PivotField object to remove.
+            
+        Returns:
+            bool: True if the field was successfully removed; otherwise, False.
+        """
+        intPtritem:c_void_p = item.Ptr
+
+        GetDllLibXls().PivotTableFields_Remove.argtypes=[c_void_p ,c_void_p]
+        GetDllLibXls().PivotTableFields_Remove.restype=c_bool
+        ret = CallCFunction(GetDllLibXls().PivotTableFields_Remove, self.Ptr, intPtritem)
+        return ret
+
+    def Clear(self):
+        """Removes all PivotFields from the collection.
+        """
+        GetDllLibXls().PivotTableFields_Clear.argtypes=[c_void_p]
+        CallCFunction(GetDllLibXls().PivotTableFields_Clear, self.Ptr)
+
+
+    def Add(self ,item:'PivotField'):
+        """Adds a PivotField to the collection.
+        
+        Args:
+            item (PivotField): The PivotField object to add.
+        """
+        intPtritem:c_void_p = item.Ptr
+
+        GetDllLibXls().PivotTableFields_Add.argtypes=[c_void_p ,c_void_p]
+        CallCFunction(GetDllLibXls().PivotTableFields_Add, self.Ptr, intPtritem)
+
+    def GetEnumerator(self)->'IEnumerator':
+        """Gets an enumerator for iterating through the collection.
+        
+        Returns:
+            IEnumerator: An enumerator for the PivotTableFields collection.
+        """
+        ret = super(PivotTableFields, self).GetEnumerator()
+        ret._gtype = XlsPivotField
+        return ret
+

spire/xls/collection/pivot_table/XlsPivotCachesCollection.py

@@ -0,0 +1,123 @@
+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 XlsPivotCachesCollection (  CollectionBase[XlsPivotCache], IPivotCaches) :
+    """
+
+    """
+    @property
+
+    def Parent(self)->'XlsWorkbook':
+        """
+
+        """
+        GetDllLibXls().XlsPivotCachesCollection_get_Parent.argtypes=[c_void_p]
+        GetDllLibXls().XlsPivotCachesCollection_get_Parent.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().XlsPivotCachesCollection_get_Parent, self.Ptr)
+        ret = None if intPtr==None else XlsWorkbook(intPtr)
+        return ret
+
+
+    @property
+
+    def Workbook(self)->'XlsWorkbook':
+        """
+
+        """
+        GetDllLibXls().XlsPivotCachesCollection_get_Workbook.argtypes=[c_void_p]
+        GetDllLibXls().XlsPivotCachesCollection_get_Workbook.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().XlsPivotCachesCollection_get_Workbook, self.Ptr)
+        ret = None if intPtr==None else XlsWorkbook(intPtr)
+        return ret
+
+
+    @property
+    def Count(self)->int:
+        """
+
+        """
+        GetDllLibXls().XlsPivotCachesCollection_get_Count.argtypes=[c_void_p]
+        GetDllLibXls().XlsPivotCachesCollection_get_Count.restype=c_int
+        ret = CallCFunction(GetDllLibXls().XlsPivotCachesCollection_get_Count, self.Ptr)
+        return ret
+
+    @dispatch
+
+    def Add(self ,range:XlsRange)->XlsPivotCache:
+        """
+
+        """
+        intPtrrange:c_void_p = range.Ptr
+
+        GetDllLibXls().XlsPivotCachesCollection_Add.argtypes=[c_void_p ,c_void_p]
+        GetDllLibXls().XlsPivotCachesCollection_Add.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().XlsPivotCachesCollection_Add, self.Ptr, intPtrrange)
+        ret = None if intPtr==None else XlsPivotCache(intPtr)
+        return ret
+
+
+    @dispatch
+
+    def Add(self ,cache:XlsPivotCache):
+        """
+
+        """
+        intPtrcache:c_void_p = cache.Ptr
+
+        GetDllLibXls().XlsPivotCachesCollection_AddC.argtypes=[c_void_p ,c_void_p]
+        CallCFunction(GetDllLibXls().XlsPivotCachesCollection_AddC, self.Ptr, intPtrcache)
+
+    def Clear(self):
+        """
+        Clears collection
+
+        """
+        GetDllLibXls().XlsPivotCachesCollection_Clear.argtypes=[c_void_p]
+        CallCFunction(GetDllLibXls().XlsPivotCachesCollection_Clear, self.Ptr)
+
+
+    def RemoveAt(self ,index:int):
+        """
+
+        """
+        
+        GetDllLibXls().XlsPivotCachesCollection_RemoveAt.argtypes=[c_void_p ,c_int]
+        CallCFunction(GetDllLibXls().XlsPivotCachesCollection_RemoveAt, self.Ptr, index)
+
+
+    def Remove(self ,pivotCache:'IPivotCache'):
+        """
+
+        """
+        intPtrpivotCache:c_void_p = pivotCache.Ptr
+
+        GetDllLibXls().XlsPivotCachesCollection_Remove.argtypes=[c_void_p ,c_void_p]
+        CallCFunction(GetDllLibXls().XlsPivotCachesCollection_Remove, self.Ptr, intPtrpivotCache)
+
+
+    def Clone(self ,parent:'SpireObject')->'SpireObject':
+        """
+
+        """
+        intPtrparent:c_void_p = parent.Ptr
+
+        GetDllLibXls().XlsPivotCachesCollection_Clone.argtypes=[c_void_p ,c_void_p]
+        GetDllLibXls().XlsPivotCachesCollection_Clone.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().XlsPivotCachesCollection_Clone, self.Ptr, intPtrparent)
+        ret = None if intPtr==None else SpireObject(intPtr)
+        return ret
+
+    def GetEnumerator(self)->'IEnumerator':
+        """
+
+        """
+        ret = super(XlsPivotCachesCollection, self).GetEnumerator()
+        ret._gtype = XlsPivotCache
+        return ret
+
+

spire/xls/conditional_formatting/ColorConditionValue.py

@@ -0,0 +1,102 @@
+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 ColorConditionValue (  XlsConditionValue) :
+    """
+    Represents a condition value with an associated color for conditional formatting.
+    """
+    @property
+    def FormatColor(self)->'Color':
+        """
+        Gets or sets the format color for the condition value.
+
+        Returns:
+            Color: The format color.
+        """
+        GetDllLibXls().ColorConditionValue_get_FormatColor.argtypes=[c_void_p]
+        GetDllLibXls().ColorConditionValue_get_FormatColor.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().ColorConditionValue_get_FormatColor, self.Ptr)
+        ret = None if intPtr==None else Color(intPtr)
+        return ret
+
+
+    @FormatColor.setter
+    def FormatColor(self, value:'Color'):
+        GetDllLibXls().ColorConditionValue_set_FormatColor.argtypes=[c_void_p, c_void_p]
+        CallCFunction(GetDllLibXls().ColorConditionValue_set_FormatColor, self.Ptr, value.Ptr)
+
+    @property
+    def IsGTE(self)->bool:
+        """
+        Gets or sets whether the comparison is greater than or equal to the threshold.
+
+        Returns:
+            bool: True if greater than or equal; otherwise, False.
+        """
+        GetDllLibXls().ColorConditionValue_get_IsGTE.argtypes=[c_void_p]
+        GetDllLibXls().ColorConditionValue_get_IsGTE.restype=c_bool
+        ret = CallCFunction(GetDllLibXls().ColorConditionValue_get_IsGTE, self.Ptr)
+        return ret
+
+    @IsGTE.setter
+    def IsGTE(self, value:bool):
+        GetDllLibXls().ColorConditionValue_set_IsGTE.argtypes=[c_void_p, c_bool]
+        CallCFunction(GetDllLibXls().ColorConditionValue_set_IsGTE, self.Ptr, value)
+
+    @property
+    def Position(self)->'ConditionValuePosition':
+        """
+        Gets the position of the condition value in the scale.
+
+        Returns:
+            ConditionValuePosition: The position in the scale.
+        """
+        GetDllLibXls().ColorConditionValue_get_Position.argtypes=[c_void_p]
+        GetDllLibXls().ColorConditionValue_get_Position.restype=c_int
+        ret = CallCFunction(GetDllLibXls().ColorConditionValue_get_Position, self.Ptr)
+        objwraped = ConditionValuePosition(ret)
+        return objwraped
+
+    @property
+    def Type(self)->'ConditionValueType':
+        """
+        Gets or sets the type of the condition value.
+
+        Returns:
+            ConditionValueType: The type of the condition value.
+        """
+        GetDllLibXls().ColorConditionValue_get_Type.argtypes=[c_void_p]
+        GetDllLibXls().ColorConditionValue_get_Type.restype=c_int
+        ret = CallCFunction(GetDllLibXls().ColorConditionValue_get_Type, self.Ptr)
+        objwraped = ConditionValueType(ret)
+        return objwraped
+
+    @Type.setter
+    def Type(self, value:'ConditionValueType'):
+        GetDllLibXls().ColorConditionValue_set_Type.argtypes=[c_void_p, c_int]
+        CallCFunction(GetDllLibXls().ColorConditionValue_set_Type, self.Ptr, value.value)
+
+    @property
+    def Value(self)->str:
+        """
+        Gets or sets the value for the condition.
+
+        Returns:
+            str: The value for the condition.
+        """
+        GetDllLibXls().ColorConditionValue_get_Value.argtypes=[c_void_p]
+        GetDllLibXls().ColorConditionValue_get_Value.restype=c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibXls().ColorConditionValue_get_Value, self.Ptr))
+        return ret
+
+
+    @Value.setter
+    def Value(self, value:str):
+        GetDllLibXls().ColorConditionValue_set_Value.argtypes=[c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibXls().ColorConditionValue_set_Value, self.Ptr, value)
+

spire/xls/conditional_formatting/CondFormatCollectionWrapper.py

@@ -0,0 +1,153 @@
+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 CondFormatCollectionWrapper (  CommonWrapper, IConditionalFormats) :
+    """
+    Represents a collection of conditional formats in a worksheet or range.
+    """
+
+    def GetEnumerator(self)->'IEnumerator':
+        """
+        Returns an enumerator that iterates through the collection.
+
+        Returns:
+            IEnumerator: An enumerator for the collection.
+        """
+        GetDllLibXls().CondFormatCollectionWrapper_GetEnumerator.argtypes=[c_void_p]
+        GetDllLibXls().CondFormatCollectionWrapper_GetEnumerator.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().CondFormatCollectionWrapper_GetEnumerator, self.Ptr)
+        ret = None if intPtr==None else IEnumerator(intPtr)
+        return ret
+
+
+    def BeginUpdate(self):
+        """
+        Begins batch update of the collection.
+        """
+        GetDllLibXls().CondFormatCollectionWrapper_BeginUpdate.argtypes=[c_void_p]
+        CallCFunction(GetDllLibXls().CondFormatCollectionWrapper_BeginUpdate, self.Ptr)
+
+    def EndUpdate(self):
+        """
+        Ends batch update of the collection.
+        """
+        GetDllLibXls().CondFormatCollectionWrapper_EndUpdate.argtypes=[c_void_p]
+        CallCFunction(GetDllLibXls().CondFormatCollectionWrapper_EndUpdate, self.Ptr)
+
+    @property
+    def Count(self)->int:
+        """
+        Gets the number of conditional formats in the collection.
+
+        Returns:
+            int: The number of conditional formats.
+        """
+        GetDllLibXls().CondFormatCollectionWrapper_get_Count.argtypes=[c_void_p]
+        GetDllLibXls().CondFormatCollectionWrapper_get_Count.restype=c_int
+        ret = CallCFunction(GetDllLibXls().CondFormatCollectionWrapper_get_Count, self.Ptr)
+        return ret
+
+
+    def get_Item(self ,index:int)->'IConditionalFormat':
+        """
+        Gets the conditional format at the specified index.
+
+        Args:
+            index (int): The index of the conditional format.
+        Returns:
+            IConditionalFormat: The conditional format at the specified index.
+        """
+        
+        GetDllLibXls().CondFormatCollectionWrapper_get_Item.argtypes=[c_void_p ,c_int]
+        GetDllLibXls().CondFormatCollectionWrapper_get_Item.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().CondFormatCollectionWrapper_get_Item, self.Ptr, index)
+        ret = None if intPtr==None else XlsConditionalFormat(intPtr)
+        return ret
+
+
+
+    def AddCondition(self)->'IConditionalFormat':
+        """
+        Adds a new conditional format to the collection.
+
+        Returns:
+            IConditionalFormat: The newly added conditional format.
+        """
+        GetDllLibXls().CondFormatCollectionWrapper_AddCondition.argtypes=[c_void_p]
+        GetDllLibXls().CondFormatCollectionWrapper_AddCondition.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().CondFormatCollectionWrapper_AddCondition, self.Ptr)
+        ret = None if intPtr==None else XlsConditionalFormat(intPtr)
+        return ret
+
+
+    def Remove(self):
+        """
+        Removes all conditional formats from the collection.
+        """
+        GetDllLibXls().CondFormatCollectionWrapper_Remove.argtypes=[c_void_p]
+        CallCFunction(GetDllLibXls().CondFormatCollectionWrapper_Remove, self.Ptr)
+
+
+    def RemoveAt(self ,index:int):
+        """
+        Removes the conditional format at the specified index.
+
+        Args:
+            index (int): The index of the conditional format to remove.
+        """
+        
+        GetDllLibXls().CondFormatCollectionWrapper_RemoveAt.argtypes=[c_void_p ,c_int]
+        CallCFunction(GetDllLibXls().CondFormatCollectionWrapper_RemoveAt, self.Ptr, index)
+
+    @property
+
+    def Parent(self)->'SpireObject':
+        """
+        Gets the parent object of the collection.
+
+        Returns:
+            SpireObject: The parent object.
+        """
+        GetDllLibXls().CondFormatCollectionWrapper_get_Parent.argtypes=[c_void_p]
+        GetDllLibXls().CondFormatCollectionWrapper_get_Parent.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().CondFormatCollectionWrapper_get_Parent, self.Ptr)
+        ret = None if intPtr==None else SpireObject(intPtr)
+        return ret
+
+
+
+    def GetCondition(self ,iCondition:int)->'XlsConditionalFormat':
+        """
+        Gets the conditional format at the specified condition index.
+
+        Args:
+            iCondition (int): The condition index.
+        Returns:
+            XlsConditionalFormat: The conditional format at the specified index.
+        """
+        
+        GetDllLibXls().CondFormatCollectionWrapper_GetCondition.argtypes=[c_void_p ,c_int]
+        GetDllLibXls().CondFormatCollectionWrapper_GetCondition.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().CondFormatCollectionWrapper_GetCondition, self.Ptr, iCondition)
+        ret = None if intPtr==None else XlsConditionalFormat(intPtr)
+        return ret
+
+
+
+    def AddRange(self ,range:'IXLSRange'):
+        """
+        Adds a range to the collection for conditional formatting.
+
+        Args:
+            range (IXLSRange): The range to add.
+        """
+        intPtrrange:c_void_p = range.Ptr
+
+        GetDllLibXls().CondFormatCollectionWrapper_AddRange.argtypes=[c_void_p ,c_void_p]
+        CallCFunction(GetDllLibXls().CondFormatCollectionWrapper_AddRange, self.Ptr, intPtrrange)
+

spire/xls/conditional_formatting/ConditionValue.py

@@ -0,0 +1,83 @@
+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 ConditionValue (  SpireObject,IConditionValue) :
+    """
+    Represents a single condition value for icon set, data bar, or color scale conditions.
+
+    """
+    @property
+    def Type(self)->'ConditionValueType':
+        """
+        Specifies how the threshold values for a data bar, color scale, or icon set conditional format are determined.
+
+        Returns:
+            ConditionValueType: The type of the condition value.
+        """
+        GetDllLibXls().ConditionValue_get_Type.argtypes=[c_void_p]
+        GetDllLibXls().ConditionValue_get_Type.restype=c_int
+        ret = CallCFunction(GetDllLibXls().ConditionValue_get_Type, self.Ptr)
+        objwraped = ConditionValueType(ret)
+        return objwraped
+
+    @Type.setter
+    def Type(self, value:'ConditionValueType'):
+        GetDllLibXls().ConditionValue_set_Type.argtypes=[c_void_p, c_int]
+        CallCFunction(GetDllLibXls().ConditionValue_set_Type, self.Ptr, value.value)
+
+    @property
+    def IsGTE(self)->bool:
+        """
+        Gets or sets whether the comparison is greater than or equal to the threshold.
+
+        Returns:
+            bool: True if greater than or equal; otherwise, False.
+        """
+        GetDllLibXls().ConditionValue_get_IsGTE.argtypes=[c_void_p]
+        GetDllLibXls().ConditionValue_get_IsGTE.restype=c_bool
+        ret = CallCFunction(GetDllLibXls().ConditionValue_get_IsGTE, self.Ptr)
+        return ret
+
+    @IsGTE.setter
+    def IsGTE(self, value:bool):
+        GetDllLibXls().ConditionValue_set_IsGTE.argtypes=[c_void_p, c_bool]
+        CallCFunction(GetDllLibXls().ConditionValue_set_IsGTE, self.Ptr, value)
+
+    @property
+    def Value(self)->'SpireObject':
+        """
+        Returns or sets the shortest bar or longest bar threshold value for a data bar conditional format.
+
+        Returns:
+            SpireObject: The threshold value object.
+        """
+        GetDllLibXls().ConditionValue_get_Value.argtypes=[c_void_p]
+        GetDllLibXls().ConditionValue_get_Value.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().ConditionValue_get_Value, self.Ptr)
+        ret = None if intPtr==None else SpireObject(intPtr)
+        return ret
+
+    @Value.setter
+    def Value(self, value:'SpireObject'):
+        GetDllLibXls().ConditionValue_set_Value.argtypes=[c_void_p, c_void_p]
+        CallCFunction(GetDllLibXls().ConditionValue_set_Value, self.Ptr, value.Ptr)
+
+    def m_condtionValue(self)->'IConditionValue':
+        """
+        Gets the internal condition value object.
+
+        Returns:
+            IConditionValue: The internal condition value.
+        """
+        GetDllLibXls().ConditionValue_m_condtionValue.argtypes=[c_void_p]
+        GetDllLibXls().ConditionValue_m_condtionValue.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().ConditionValue_m_condtionValue, self.Ptr)
+        ret = None if intPtr==None else XlsConditionValue(intPtr)
+        return ret
+
+

spire/xls/conditional_formatting/ConditionValuePosition.py

@@ -0,0 +1,16 @@
+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 ConditionValuePosition(Enum):
+    """
+    Specifies the position of a condition value in a scale for conditional formatting.
+    """
+    Third = 2
+    Second = 1
+    First = 0
+

spire/xls/conditional_formatting/ConditionalFormat.py

@@ -0,0 +1,13 @@
+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 ConditionalFormat (  XlsConditionalFormat) :
+    """
+    Contains a condition and the formatting for cells in conditional formatting.
+
+    """

spire/xls/conditional_formatting/ConditionalFormatScope.py

@@ -0,0 +1,16 @@
+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 ConditionalFormatScope(Enum):
+    """
+    Specifies the scope of a conditional format in Excel.
+    """
+    DataFields = 0
+    Intersections = 1
+    Selections = 2
+