Condition Class

Description

An object of the Condition class is an element of the ConditionalInstruction class and represents the state of a FormField that has to be fulfilled to execute the instructions of the related ConditionalInstruction object. The number of conditions inside a ConditionalInstruction object is not limited. If the ConditionalInstruction.Conditions property contains more than one element, each subsequent Condition object is connected to the previous one by an AND or OR logical connective. That implies that all these conditions are considered as a whole when the conditional instruction is tested whether or not the requirements to execute its instructions are fulfilled.

To create a condition, the Condition object has to be initialized with a FormField that is located inside the document. That FormField provides the value to be tested.

Furthermore, a comparison value has to be defined by the constructor's comparisonValue parameter. That value is compared with the FormField's value by using a specified comparisonOperator parameter. The way in which such a comparison is implemented depends on how the set value is interpreted:

• The constructor's isChecked parameter value of a condition that references to a CheckFormField represents a check state to be fulfilled. If it is set to true, the Condition.ComparisonOperator property returns Condition.ComparisonOperators.Is. Otherwise Condition.ComparisonOperators.IsNot. In both cases the Condition.ComparisonValue property returns true.

• Conditions that are related to form fields of type TextFormField or SelectionFormField execute a comparison to the form field's Text property value. That text can be tested as follows: If the comparison value is set to null or an emtpy string, the condition checks whether or not any text is set. If it is a string, that is not empty, by default the value is interpreted as a custom text whose string is compared with form field's text. Alternatively, that string can be handled as a regular expression that checks whether or not the form field's text matches to its pattern. That option can be determined by setting the constructor's textComparisonFlag parameter to Condition.TextComparisonFlags.Regex.

• In addition, the text of a SelectionFormField object can be compared with one of its SelectionFormField.Items array entries or checked whether or not the string equals to one of its SelectionFormField.Items array entries. These comparison types can be determined by setting the corresponding Condition.ItemComparisonFlags enumeration value to the constructor's itemComparisonFlag parameter.

• Up to four different comparison types can be applied to compare the Date property of DateFormField objects with a specified value: If the comparison value is an object of type System.DateTime, the year, month and day of month is compared with the current property value. On setting an integer with an value between 1601 and 9999, the year is compared. If that value is an integer between 1 and 31, the day of the month is checked. An enumeration value of type Condition.Month tests the month and using a System.DayOfWeek enumeration value compares the day of the week. Setting null as the comparison value checks whether or not the DateFormField.Date property value is set.

Syntax

public class Condition : IComparable

Public Class Condition
    Implements IComparable

Examples

The following example builds a rule around an approval check box in a fillable form.

CheckFormField approvalField = new(false) { Name = "Approved" };
textControl.FormFields.Add(approvalField);
Condition condition = new(approvalField, true);

Dim approvalField As New CheckFormField(False) With { .Name = "Approved" }
textControl.FormFields.Add(approvalField)
Dim condition As New Condition(approvalField, True)

Members

Constructors

Properties

Methods

Enumerations