Description

The FilterInstruction class is used to filter merge block data by certain conditions before merging. A filter instruction represents a condition which must be fulfilled by the content of a data row in a data table to execute a certain merge action. It uses a relational operator such as "is equal to" or "is greater than" to compare a given value to the contents of a specified data row column. This class is used in class MergeBlockInfo to determine if a merge block should be merged at all, for example. Multiple filter instructions can be logically concatenated using "and" and "or" operators.

Syntax

public class FilterInstruction

Public Class FilterInstruction

Examples

The following example creates a Filter Instruction instance and configures its column name setting for a document workflow.

TXTextControl.DocumentServer.DataShaping.FilterInstruction filterInstruction = new("CustomerName", TXTextControl.DocumentServer.DataShaping.RelationalOperator.Equals);
filterInstruction.ColumnName = "CustomerName";

Dim filterInstruction As New TXTextControl.DocumentServer.DataShaping.FilterInstruction("CustomerName", TXTextControl.DocumentServer.DataShaping.RelationalOperator.Equals)
filterInstruction.ColumnName = "CustomerName"

Members

Constructors

Constructor	Description
FilterInstruction	Initializes a new instance of the FilterInstruction class.

Properties

Property	Description
ColumnName	Gets or sets the name of the table column whose content this merge condition is compared to.
CompareTo	Gets or sets the value the table column content is compared to using the specified comparison operator. If this value can be parsed to a numerical value, a numerical comparison is used internally when possible (i. e. when the table column contains numerical values, too). Otherwise the column content and this value are interpreted as / converted to strings.
ComparisonOperator	Gets or sets the relational operator used as the comparison operator. See the description of the constructor of this class for possible values.
Culture	Gets or sets the format provider for numerical value comparison. The default value for this property is the invariant culture.
LogicalOperator	Gets or sets the logical operator by which to logically connect a filter instruction to the previous one if a filter consists of a collection of multiple filter instructions. Possible values are listed in the description of the constructor of this class.

FilterInstruction Class