FilterInstruction Constructor
- Namespace
TXTextControl.DocumentServer. DataShaping
- Package
TXTextControl.asTextControl. WPF. SDK TXDocumentServer.from the private NuGet feed or Text Control Offline Packagesdll
Description
Initializes a new instance of the FilterInstruction class.
Syntax
FilterInstruction(string, RelationalOperator, object, LogicalOperator)
Sets the table column name to filter the data rows by, the comparison operator, the value to compare the table column content to and the logical operator.
public FilterInstruction(string columnName, RelationalOperator comparisonOperator, object compareTo, LogicalOperator logicalOperator);Public Sub New(columnName As String, comparisonOperator As RelationalOperator, compareTo As Object, logicalOperator As LogicalOperator)| Parameter | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| columnName | The name of the table column to filter the data rows by. | ||||||||||||||||||
| comparisonOperator | The comparison operator.
| ||||||||||||||||||
| compareTo | The value to compare the table column content to. If this value can be parsed to a numerical value, numerical comparisons are used internally when possible (i. e. when the table column contains numerical values, too). Otherwise the column content and this value are interpreted as strings. | ||||||||||||||||||
| logicalOperator | The logical operator which connects a filter instruction to the previous filter instruction in a collection.
|
FilterInstruction(string, RelationalOperator, object)
Sets the table column name to filter the data rows by, the comparison operator and the value to compare the table column content to. The logical operator is set to LogicalOperator.And.
public FilterInstruction(string columnName, RelationalOperator comparisonOperator, object compareTo);Public Sub New(columnName As String, comparisonOperator As RelationalOperator, compareTo As Object)| Parameter | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| columnName | The name of the table column to filter the data rows by. | ||||||||||||||||||
| comparisonOperator | The comparison operator.
| ||||||||||||||||||
| compareTo | The value to compare the table column content to. If this value can be parsed to a numerical value, numerical comparisons are used internally when possible (i. e. when the table column contains numerical values, too). Otherwise the column content and this value are interpreted as strings. |
FilterInstruction(string, RelationalOperator)
Sets the table column name to filter the data rows by and the comparison operator. The value to compare the table column content to is set to the empty string and the logical operator is set to LogicalOperator.And. This constructor is useful in cases of "is blank" or "is not blank" filter instructions because no compare value is needed in those cases.
public FilterInstruction(string columnName, RelationalOperator comparisonOperator);Public Sub New(columnName As String, comparisonOperator As RelationalOperator)| Parameter | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| columnName | The name of the table column to filter the data rows by. | ||||||||||||||||||
| comparisonOperator | The comparison operator.
|
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"