FilterInstruction Class

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

Properties