ComparisonValueTypes Enumeration
- Namespace
TXTextControl
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WinForms. SDK
- Assembly
TXTextControl.dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WinForms. SDK TXTextControl.from the setup.dll
Description
Determines how the condition's comparison value is interpreted by the condition. The enumeration contains the following values:
Syntax
public enum Condition.ComparisonValueTypesPublic Enum Condition.ComparisonValueTypesMembers
| Member | Value | Description |
|---|---|---|
| CheckState | 1 | The condition tests the check state of the related condition's CheckFormField. If this enumeration value is returned by the Condition.ComparisonValueType property, the Condition.ComparisonValue property is set to true. The Condition.ComparisonOperator returns the enumeration value ComparisonOperators.Is, if the condition checks whether the check form field is checked. Otherwise ComparisonOperators.IsNot. |
| NoValue | 2 | The condition examines whether the related condition's FormField property does not provide a suitable value that can be used for comparison. Form field values of type TextFormField and SelectionFormField are not suitable for comparison, if their FormField.Text property value is an empty string. The corresponding value of a DateFormField cannot be compared, if its DateFormField.Date property returns null. If the ComparisonValueTypes.NoValue value is returned by the Condition.ComparisonValueType property, the Condition.ComparisonValue property is set to null. The ComparisonValueTypes.NoValue enumeration value can only be combined with the operator ComparisonOperators.Is or ComparisonOperators.IsNot. |
| CustomText | 3 | The condition compares the FormField.Text property value of the related condition's TextFormField or SelectionFormField with the value of the Condition.ComparisonValue property. If this enumeration value is returned by the Condition.ComparisonValueType property, the Condition.ComparisonValue property value is an object of type string. Furthermore, all provided values of the ComparisonOperators enumeration can be set as Condition.ComparisonOperator property value. |
| Regex | 4 | The condition checks whether or not the FormField.Text property value of the related condition's TextFormField or SelectionFormField matches a specific regular expression. That regular expression is represented by the Condition.ComparisonValue property. It is an object of type string and conforms to the rules of the .NET Framework regular expression engine. The ComparisonValueTypes.Regex enumeration value can only be combined with the operator ComparisonOperators.Is or ComparisonOperators.IsNot. |
| SpecificItem | 5 | The condition compares the FormField.Text property value of the related condition's SelectionFormField with an item of SelectionFormField.Items string array collection. The representation of that item is an object of type string, which is specified by the Condition.ComparisonValue property. All provided values of the ComparisonOperators enumeration can be set as Condition.ComparisonOperator property value. |
| AnyItem | 6 | The condition examines whether the related condition's SelectionFormField.Text property value matches one of the SelectionFormField.Items string array collection values. If this enumeration value is returned by the Condition.ComparisonValueType property, the Condition.ComparisonValue property is set to null. The ComparisonValueTypes.AnyItem enumeration value can only be combined with the operator ComparisonOperators.Is or ComparisonOperators.IsNot. |
| Date | 7 | The condition compares the DateFormField.Date property value of the related condition's DateFormField with a date that is specified by the Condition.ComparisonValue property. If this enumeration value is returned by the Condition.ComparisonValueType property, the Condition.ComparisonValue property is an object of type System.DateTime. The ComparisonValueTypes.Date enumeration value can only be combined with the operator ComparisonOperators.Is, ComparisonOperators.IsNot,ComparisonOperators.IsGreaterThan, ComparisonOperators.IsGreaterThanOrEqual, ComparisonOperators.IsLessThan or ComparisonOperators.IsLessThanOrEqual. |
| Year | 8 | The condition compares the DateFormField.Date property value of the related condition's DateFormField with a year that is specified by the Condition.ComparisonValue property. If this enumeration value is returned by the Condition.ComparisonValueType property, the Condition.ComparisonValue property represents an integer between 1601 and 9999. The ComparisonValueTypes.Year enumeration value can only be combined with the operator ComparisonOperators.Is, ComparisonOperators.IsNot, ComparisonOperators.IsGreaterThan, ComparisonOperators.IsGreaterThanOrEqual, ComparisonOperators.IsLessThan or ComparisonOperators.IsLessThanOrEqual. |
| Month | 9 | The condition compares the DateFormField.Date property value of the related condition's DateFormField with a month that is specified by the Condition.ComparisonValue property. If this enumeration value is returned by the Condition.ComparisonValueType property, the Condition.ComparisonValueproperty is an object of type Condition.Month. The ComparisonValueTypes.Month enumeration value can only be combined with the operator ComparisonOperators.Is, ComparisonOperators.IsNot, ComparisonOperators.IsGreaterThan, ComparisonOperators.IsGreaterThanOrEqual, ComparisonOperators.IsLessThan or ComparisonOperators.IsLessThanOrEqual. |
| DayOfMonth | 10 | The condition compares the DateFormField.Date property value of the related condition's DateFormField with a day of the month that is specified by the Condition.ComparisonValue property. If this enumeration value is returned by the Condition.ComparisonValueType property, the Condition.ComparisonValue property represents an integer between 1 and 31. The ComparisonValueTypes.DayOfMonth enumeration value can only be combined with the operator ComparisonOperators.Is, ComparisonOperators.IsNot, ComparisonOperators.IsGreaterThan, ComparisonOperators.IsGreaterThanOrEqual, ComparisonOperators.IsLessThan or ComparisonOperators.IsLessThanOrEqual. |
| Weekday | 11 | The condition compares the DateFormField.Date property value of the related condition's DateFormField with a weekday that is specified by the Condition.ComparisonValue property. If this enumeration value is returned by the Condition.ComparisonValueType property, the Condition.ComparisonValue property is an object of type System.DayOfWeek. The ComparisonValueTypes.Weekday enumeration value can only be combined with the operator ComparisonOperators.Is or ComparisonOperators.IsNot. |
Examples
The following example selects the Check State value from the Comparison Value Types enumeration and uses it as a documented workflow choice.
Condition.ComparisonValueTypes value = Condition.ComparisonValueTypes.CheckState;
Console.WriteLine($"Using Comparison Value Types: {value}");Dim value As Condition.ComparisonValueTypes = Condition.ComparisonValueTypes.CheckState
Console.WriteLine($"Using Comparison Value Types: {value}")