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

spire/xls/XlsValidationWrapper.py

@@ -7,14 +7,20 @@ from ctypes import *
 import abc
 
 class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication) :
-    """
-
+    """A wrapper class for Excel data validation functionality.
+    
+    This class extends CommonWrapper and implements IDataValidation and IExcelApplication interfaces
+    to provide a wrapper around Excel data validation functionality. It allows for creating and
+    managing data validation rules that restrict the type of data or values users can enter into
+    a cell or range in Excel worksheets.
     """
     @property
 
     def Parent(self)->'SpireObject':
-        """
-
+        """Gets the parent object of this validation wrapper.
+        
+        Returns:
+            SpireObject: The parent object of this validation wrapper.
         """
         GetDllLibXls().XlsValidationWrapper_get_Parent.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_Parent.restype=c_void_p
@@ -27,9 +33,8 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     def InputTitle(self)->str:
         """
-    <summary>
         Title of the input box.
-    </summary>
+
         """
         GetDllLibXls().XlsValidationWrapper_get_InputTitle.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_InputTitle.restype=c_void_p
@@ -46,9 +51,8 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     def InputMessage(self)->str:
         """
-    <summary>
         Message of the input box.
-    </summary>
+
         """
         GetDllLibXls().XlsValidationWrapper_get_InputMessage.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_InputMessage.restype=c_void_p
@@ -65,9 +69,8 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     def ErrorTitle(self)->str:
         """
-    <summary>
-        Title of the error box. 
-    </summary>
+        Title of the error box.
+
         """
         GetDllLibXls().XlsValidationWrapper_get_ErrorTitle.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_ErrorTitle.restype=c_void_p
@@ -84,9 +87,8 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     def ErrorMessage(self)->str:
         """
-    <summary>
         Message of the error box.
-    </summary>
+
         """
         GetDllLibXls().XlsValidationWrapper_get_ErrorMessage.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_ErrorMessage.restype=c_void_p
@@ -102,8 +104,13 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
     @property
 
     def Formula1(self)->str:
-        """
-
+        """Gets or sets the first formula or value for the data validation.
+        
+        For most validation types, this property sets the minimum value or the only value
+        used for validation.
+        
+        Returns:
+            str: The first formula or value for validation.
         """
         GetDllLibXls().XlsValidationWrapper_get_Formula1.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_Formula1.restype=c_void_p
@@ -113,14 +120,23 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @Formula1.setter
     def Formula1(self, value:str):
+        """Sets the first formula or value for the data validation.
+        
+        Args:
+            value (str): The first formula or value for validation.
+        """
         GetDllLibXls().XlsValidationWrapper_set_Formula1.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_Formula1, self.Ptr, value)
 
     @property
 
     def DateTime1(self)->'DateTime':
-        """
-
+        """Gets or sets the first date/time value for the data validation.
+        
+        Used when validating date or time values, typically as the minimum value.
+        
+        Returns:
+            DateTime: The first date/time value for validation.
         """
         GetDllLibXls().XlsValidationWrapper_get_DateTime1.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_DateTime1.restype=c_void_p
@@ -131,14 +147,24 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @DateTime1.setter
     def DateTime1(self, value:'DateTime'):
+        """Sets the first date/time value for the data validation.
+        
+        Args:
+            value (DateTime): The first date/time value for validation.
+        """
         GetDllLibXls().XlsValidationWrapper_set_DateTime1.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_DateTime1, self.Ptr, value.Ptr)
 
     @property
 
     def Formula2(self)->str:
-        """
-
+        """Gets or sets the second formula or value for the data validation.
+        
+        For validation types that require a range (like between or not between),
+        this property sets the maximum value.
+        
+        Returns:
+            str: The second formula or value for validation.
         """
         GetDllLibXls().XlsValidationWrapper_get_Formula2.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_Formula2.restype=c_void_p
@@ -148,14 +174,23 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @Formula2.setter
     def Formula2(self, value:str):
+        """Sets the second formula or value for the data validation.
+        
+        Args:
+            value (str): The second formula or value for validation.
+        """
         GetDllLibXls().XlsValidationWrapper_set_Formula2.argtypes=[c_void_p, c_wchar_p]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_Formula2, self.Ptr, value)
 
     @property
 
     def DateTime2(self)->'DateTime':
-        """
-
+        """Gets or sets the second date/time value for the data validation.
+        
+        Used when validating date or time values with a range, typically as the maximum value.
+        
+        Returns:
+            DateTime: The second date/time value for validation.
         """
         GetDllLibXls().XlsValidationWrapper_get_DateTime2.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_DateTime2.restype=c_void_p
@@ -166,14 +201,23 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @DateTime2.setter
     def DateTime2(self, value:'DateTime'):
+        """Sets the second date/time value for the data validation.
+        
+        Args:
+            value (DateTime): The second date/time value for validation.
+        """
         GetDllLibXls().XlsValidationWrapper_set_DateTime2.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_DateTime2, self.Ptr, value.Ptr)
 
     @property
 
     def AllowType(self)->'CellDataType':
-        """
-
+        """Gets or sets the data type allowed in the cell or range.
+        
+        This property determines what type of data is valid for the cells with validation.
+        
+        Returns:
+            CellDataType: The data type allowed for validation.
         """
         GetDllLibXls().XlsValidationWrapper_get_AllowType.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_AllowType.restype=c_int
@@ -183,14 +227,23 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @AllowType.setter
     def AllowType(self, value:'CellDataType'):
+        """Sets the data type allowed in the cell or range.
+        
+        Args:
+            value (CellDataType): The data type to allow for validation.
+        """
         GetDllLibXls().XlsValidationWrapper_set_AllowType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_AllowType, self.Ptr, value.value)
 
     @property
 
     def CompareOperator(self)->'ValidationComparisonOperator':
-        """
-
+        """Gets or sets the comparison operator for the data validation.
+        
+        This property determines how the cell's value is compared against the validation criteria.
+        
+        Returns:
+            ValidationComparisonOperator: The comparison operator for validation.
         """
         GetDllLibXls().XlsValidationWrapper_get_CompareOperator.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_CompareOperator.restype=c_int
@@ -200,13 +253,23 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @CompareOperator.setter
     def CompareOperator(self, value:'ValidationComparisonOperator'):
+        """Sets the comparison operator for the data validation.
+        
+        Args:
+            value (ValidationComparisonOperator): The comparison operator to use for validation.
+        """
         GetDllLibXls().XlsValidationWrapper_set_CompareOperator.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_CompareOperator, self.Ptr, value.value)
 
     @property
     def IsListInFormula(self)->bool:
-        """
-
+        """Gets whether the validation list is in a formula.
+        
+        When True, the Formula1 property contains a formula that evaluates to a list.
+        When False, Formula1 contains a comma-separated list of values.
+        
+        Returns:
+            bool: True if the validation list is in a formula; otherwise, False.
         """
         GetDllLibXls().XlsValidationWrapper_get_IsListInFormula.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_IsListInFormula.restype=c_bool
@@ -220,8 +283,12 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @property
     def IgnoreBlank(self)->bool:
-        """
-
+        """Gets whether blank values are allowed in the validated range.
+        
+        When True, empty cells are considered valid regardless of the validation criteria.
+        
+        Returns:
+            bool: True if blank values are allowed; otherwise, False.
         """
         GetDllLibXls().XlsValidationWrapper_get_IgnoreBlank.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_IgnoreBlank.restype=c_bool
@@ -230,13 +297,22 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @IgnoreBlank.setter
     def IgnoreBlank(self, value:bool):
+        """Sets whether blank values are allowed in the validated range.
+        
+        Args:
+            value (bool): True to allow blank values; otherwise, False.
+        """
         GetDllLibXls().XlsValidationWrapper_set_IgnoreBlank.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_IgnoreBlank, self.Ptr, value)
 
     @property
     def IsSuppressDropDownArrow(self)->bool:
-        """
-
+        """Gets whether to suppress the dropdown arrow for list validation.
+        
+        When True, the dropdown arrow for list-type validation is not displayed.
+        
+        Returns:
+            bool: True if the dropdown arrow is suppressed; otherwise, False.
         """
         GetDllLibXls().XlsValidationWrapper_get_IsSuppressDropDownArrow.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_IsSuppressDropDownArrow.restype=c_bool
@@ -245,13 +321,23 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @IsSuppressDropDownArrow.setter
     def IsSuppressDropDownArrow(self, value:bool):
+        """Sets whether to suppress the dropdown arrow for list validation.
+        
+        Args:
+            value (bool): True to suppress the dropdown arrow; otherwise, False.
+        """
         GetDllLibXls().XlsValidationWrapper_set_IsSuppressDropDownArrow.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_IsSuppressDropDownArrow, self.Ptr, value)
 
     @property
     def ShowInput(self)->bool:
-        """
-
+        """Gets or sets whether to display the input message when a cell is selected.
+        
+        When True, the input message (specified by InputTitle and InputMessage) is displayed
+        when the user selects a cell with this validation.
+        
+        Returns:
+            bool: True if the input message is displayed; otherwise, False.
         """
         GetDllLibXls().XlsValidationWrapper_get_ShowInput.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_ShowInput.restype=c_bool
@@ -260,13 +346,23 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @ShowInput.setter
     def ShowInput(self, value:bool):
+        """Sets whether to display the input message when a cell is selected.
+        
+        Args:
+            value (bool): True to display the input message; otherwise, False.
+        """
         GetDllLibXls().XlsValidationWrapper_set_ShowInput.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_ShowInput, self.Ptr, value)
 
     @property
     def ShowError(self)->bool:
-        """
-
+        """Gets or sets whether to display an error message when invalid data is entered.
+        
+        When True, the error message (specified by ErrorTitle and ErrorMessage) is displayed
+        when the user enters invalid data in a cell with this validation.
+        
+        Returns:
+            bool: True if the error message is displayed; otherwise, False.
         """
         GetDllLibXls().XlsValidationWrapper_get_ShowError.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_ShowError.restype=c_bool
@@ -275,13 +371,22 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @ShowError.setter
     def ShowError(self, value:bool):
+        """Sets whether to display an error message when invalid data is entered.
+        
+        Args:
+            value (bool): True to display the error message; otherwise, False.
+        """
         GetDllLibXls().XlsValidationWrapper_set_ShowError.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_ShowError, self.Ptr, value)
 
     @property
     def PromptBoxHPosition(self)->int:
-        """
-
+        """Gets or sets the horizontal position of the input message box.
+        
+        Specifies the horizontal offset in pixels for the input message box.
+        
+        Returns:
+            int: The horizontal position in pixels.
         """
         GetDllLibXls().XlsValidationWrapper_get_PromptBoxHPosition.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_PromptBoxHPosition.restype=c_int
@@ -290,13 +395,22 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @PromptBoxHPosition.setter
     def PromptBoxHPosition(self, value:int):
+        """Sets the horizontal position of the input message box.
+        
+        Args:
+            value (int): The horizontal position in pixels.
+        """
         GetDllLibXls().XlsValidationWrapper_set_PromptBoxHPosition.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_PromptBoxHPosition, self.Ptr, value)
 
     @property
     def PromptBoxVPosition(self)->int:
-        """
-
+        """Gets or sets the vertical position of the input message box.
+        
+        Specifies the vertical offset in pixels for the input message box.
+        
+        Returns:
+            int: The vertical position in pixels.
         """
         GetDllLibXls().XlsValidationWrapper_get_PromptBoxVPosition.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_PromptBoxVPosition.restype=c_int
@@ -305,13 +419,22 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @PromptBoxVPosition.setter
     def PromptBoxVPosition(self, value:int):
+        """Sets the vertical position of the input message box.
+        
+        Args:
+            value (int): The vertical position in pixels.
+        """
         GetDllLibXls().XlsValidationWrapper_set_PromptBoxVPosition.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_PromptBoxVPosition, self.Ptr, value)
 
     @property
     def IsInputVisible(self)->bool:
-        """
-
+        """Gets or sets whether the input message box is visible.
+        
+        Controls the visibility of the input message box independently of ShowInput.
+        
+        Returns:
+            bool: True if the input message box is visible; otherwise, False.
         """
         GetDllLibXls().XlsValidationWrapper_get_IsInputVisible.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_IsInputVisible.restype=c_bool
@@ -320,13 +443,24 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @IsInputVisible.setter
     def IsInputVisible(self, value:bool):
+        """Sets whether the input message box is visible.
+        
+        Args:
+            value (bool): True to make the input message box visible; otherwise, False.
+        """
         GetDllLibXls().XlsValidationWrapper_set_IsInputVisible.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_IsInputVisible, self.Ptr, value)
 
     @property
     def IsInputPositionFixed(self)->bool:
-        """
-
+        """Gets or sets whether the input message box position is fixed.
+        
+        When True, the input message box appears at the position specified by
+        PromptBoxHPosition and PromptBoxVPosition. When False, the position is
+        determined automatically.
+        
+        Returns:
+            bool: True if the input message box position is fixed; otherwise, False.
         """
         GetDllLibXls().XlsValidationWrapper_get_IsInputPositionFixed.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_IsInputPositionFixed.restype=c_bool
@@ -335,14 +469,24 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @IsInputPositionFixed.setter
     def IsInputPositionFixed(self, value:bool):
+        """Sets whether the input message box position is fixed.
+        
+        Args:
+            value (bool): True to fix the input message box position; otherwise, False.
+        """
         GetDllLibXls().XlsValidationWrapper_set_IsInputPositionFixed.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_IsInputPositionFixed, self.Ptr, value)
 
     @property
 
     def AlertStyle(self)->'AlertStyleType':
-        """
-
+        """Gets or sets the style of the error alert.
+        
+        Determines the icon and buttons displayed in the error message box
+        when invalid data is entered.
+        
+        Returns:
+            AlertStyleType: The style of the error alert.
         """
         GetDllLibXls().XlsValidationWrapper_get_AlertStyle.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_AlertStyle.restype=c_int
@@ -352,14 +496,24 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @AlertStyle.setter
     def AlertStyle(self, value:'AlertStyleType'):
+        """Sets the style of the error alert.
+        
+        Args:
+            value (AlertStyleType): The style of the error alert to use.
+        """
         GetDllLibXls().XlsValidationWrapper_set_AlertStyle.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_AlertStyle, self.Ptr, value.value)
 
     @property
 
     def Values(self)->List[str]:
-        """
-
+        """Gets or sets the list of valid values for list-type validation.
+        
+        For list-type validation, this property contains the list of values
+        that are considered valid.
+        
+        Returns:
+            List[str]: The list of valid values.
         """
         GetDllLibXls().XlsValidationWrapper_get_Values.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_Values.restype=IntPtrArray
@@ -369,6 +523,11 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @Values.setter
     def Values(self, value:List[str]):
+        """Sets the list of valid values for list-type validation.
+        
+        Args:
+            value (List[str]): The list of valid values.
+        """
         vCount = len(value)
         ArrayType = c_wchar_p * vCount
         vArray = ArrayType()
@@ -380,8 +539,12 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
     @property
 
     def DataRange(self)->'IXLSRange':
-        """
-
+        """Gets or sets the cell range to which the data validation applies.
+        
+        This property specifies the range of cells that will have this validation rule applied.
+        
+        Returns:
+            IXLSRange: The cell range with this validation rule.
         """
         GetDllLibXls().XlsValidationWrapper_get_DataRange.argtypes=[c_void_p]
         GetDllLibXls().XlsValidationWrapper_get_DataRange.restype=c_void_p
@@ -392,6 +555,11 @@ class XlsValidationWrapper (  CommonWrapper, IDataValidation, IExcelApplication)
 
     @DataRange.setter
     def DataRange(self, value:'IXLSRange'):
+        """Sets the cell range to which the data validation applies.
+        
+        Args:
+            value (IXLSRange): The cell range to apply this validation rule to.
+        """
         GetDllLibXls().XlsValidationWrapper_set_DataRange.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().XlsValidationWrapper_set_DataRange, self.Ptr, value.Ptr)