TX Text Control .NET Server

InstructionTypes Enumeration

Enumeration|Introduced in 28.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.Core.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.Core.dll
Install
dotnet add package TXTextControl.TextControl.Core.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.dll from the setup.
Also in
TXTextControl.TextControl.ASP.SDK as TXTextControl.dll

Description

Determines the type of action to execute. The enumeration contains the following values:

Syntax

public enum Instruction.InstructionTypes

Members

MemberValueDescription
IsEnabled1The instruction sets the FormField.Enabled property to true or false. This enumeration value is used in combination with an instruction value of type boolean that represents the new desired FormField.Enabled value.
IsValueValid2The instruction marks the form field value as valid or invalid. This enumeration value is used in combination with an instruction value of type boolean. To retrieve the result of an instruction with that instruction type, the ConditionalInstructionCollection.IsValueValid method is provided.
SetValue3The instruction sets a new value to a FormField type specific property. If the related FormField is an object of type CheckFormField, the instruction type is used in combination with an instruction value of type boolean that represents the new desired CheckFormField.Checked property value. At form fields of type TextFormField and SelectionFormField, the Text property is updated with a string value. The corresponding property of date form fields is the DateFormField.Date property. To update that property, the Instruction.InstructionValue property needs a value of type System.DateTime.
SetItems4The instruction replaces the SelectionFormField.Items array with the string array that is represented by Instruction.InstructionValue property.

Examples

The following example selects the Is Enabled value from the Instruction Types enumeration and uses it as a documented workflow choice.

Instruction.InstructionTypes value = Instruction.InstructionTypes.IsEnabled;
Console.WriteLine($"Using Instruction Types: {value}");