TXTextControl.DocumentServer.DataShaping.FilterInstruction Constructor

Initializes a new instance of the FilterInstruction class.

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.

[C#]
public FilterInstruction(string columnName, DocumentServer.DataShaping.RelationalOperator comparisonOperator, object compareTo, DocumentServer.DataShaping.LogicalOperator logicalOperator);
[Visual Basic]
Public Sub New(columnName As String, comparisonOperator As DocumentServer.DataShaping.RelationalOperator, compareTo As Object, logicalOperator As DocumentServer.DataShaping.LogicalOperator)
Parameter Description
columnName

The name of the table column to filter the data rows by.

comparisonOperator

The comparison operator.


Value Meaning
Equals "Equals" relation.
NotEqual "Not equal" relation.
LessThan "Less than" relation.
GreaterThan "Greater than" relation.
GreaterThanOrEqualTo "Greater than or equal to" relation.
LessThanOrEqualTo "Less than or equal to" relation.
IsBlank "Is blank" constraint.
IsNotBlank "Is not blank" constraint.
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.


Value Meaning
And Logical "and".
Or Logical "or".

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.

[C#]
public FilterInstruction(string columnName, DocumentServer.DataShaping.RelationalOperator comparisonOperator, object compareTo);
[Visual Basic]
Public Sub New(columnName As String, comparisonOperator As DocumentServer.DataShaping.RelationalOperator, compareTo As Object)
Parameter Description
columnName

The name of the table column to filter the data rows by.

comparisonOperator

The comparison operator.


Value Meaning
Equals "Equals" relation.
NotEqual "Not equal" relation.
LessThan "Less than" relation.
GreaterThan "Greater than" relation.
GreaterThanOrEqualTo "Greater than or equal to" relation.
LessThanOrEqualTo "Less than or equal to" relation.
IsBlank "Is blank" constraint.
IsNotBlank "Is not blank" constraint.
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.

[C#]
public FilterInstruction(string columnName, DocumentServer.DataShaping.RelationalOperator comparisonOperator);
[Visual Basic]
Public Sub New(columnName As String, comparisonOperator As DocumentServer.DataShaping.RelationalOperator)
Parameter Description
columnName

The name of the table column to filter the data rows by.

comparisonOperator

The comparison operator.


Value Meaning
Equals "Equals" relation.
NotEqual "Not equal" relation.
LessThan "Less than" relation.
GreaterThan "Greater than" relation.
GreaterThanOrEqualTo "Greater than or equal to" relation.
LessThanOrEqualTo "Less than or equal to" relation.
IsBlank "Is blank" constraint.
IsNotBlank "Is not blank" constraint.

See Also