HtmlForgeX

API Reference

Class

ConditionBuilder

Namespace HtmlForgeX
Assembly HtmlForgeX

Adds typed conditions.

Inheritance

  • Object
  • ConditionBuilder

Constructors

Methods

public ConditionBuilder Between(String column, Double from, Double to, Boolean inclusive = true) #
Returns: ConditionBuilder

Number between range.

Parameters

column System.String requiredposition: 0
from System.Double requiredposition: 1
to System.Double requiredposition: 2
inclusive System.Boolean = true optionalposition: 3
public ConditionBuilder BoolEq(String column, Boolean value) #
Returns: ConditionBuilder

Boolean equals.

Parameters

column System.String requiredposition: 0
value System.Boolean requiredposition: 1
public ConditionBuilder CaseSensitive(Boolean enable = true) #
Returns: ConditionBuilder

Sets CaseSensitive on the most recent string condition.

Parameters

enable System.Boolean = true optionalposition: 0
public ConditionBuilder DateBetween(String column, DateTime from, DateTime to, Boolean inclusive = true, String inputFormat = null) #
Returns: ConditionBuilder

Date between range.

Parameters

column System.String requiredposition: 0
from System.DateTime requiredposition: 1
to System.DateTime requiredposition: 2
inclusive System.Boolean = true optionalposition: 3
inputFormat System.String = null optionalposition: 4
public ConditionBuilder DateEq(String column, DateTime value, String inputFormat = null) #
Returns: ConditionBuilder

Date equals.

Parameters

column System.String requiredposition: 0
value System.DateTime requiredposition: 1
inputFormat System.String = null optionalposition: 2
public ConditionBuilder Format(String format) #
Returns: ConditionBuilder

Sets the input date format on the last date condition.

Parameters

format System.String requiredposition: 0
public ConditionBuilder Ge(String column, Double value) #
Returns: ConditionBuilder

Number greater or equal.

Parameters

column System.String requiredposition: 0
value System.Double requiredposition: 1
public ConditionBuilder Greater(String column, Double value) #
Returns: ConditionBuilder

Alias for Double) to improve readability.

Parameters

column System.String requiredposition: 0
Column identifier.
value System.Double requiredposition: 1
Threshold value.

Returns

The current builder.

public ConditionBuilder GreaterOrEqual(String column, Double value) #
Returns: ConditionBuilder

Alias for Double) to improve readability.

Parameters

column System.String requiredposition: 0
Column identifier.
value System.Double requiredposition: 1
Threshold value.

Returns

The current builder.

public ConditionBuilder Gt(String column, Double value) #
Returns: ConditionBuilder

Number greater than.

Parameters

column System.String requiredposition: 0
value System.Double requiredposition: 1
public ConditionBuilder Le(String column, Double value) #
Returns: ConditionBuilder

Number less or equal.

Parameters

column System.String requiredposition: 0
value System.Double requiredposition: 1
public ConditionBuilder Less(String column, Double value) #
Returns: ConditionBuilder

Alias for Double) to improve readability.

Parameters

column System.String requiredposition: 0
Column identifier.
value System.Double requiredposition: 1
Threshold value.

Returns

The current builder.

public ConditionBuilder LessOrEqual(String column, Double value) #
Returns: ConditionBuilder

Alias for Double) to improve readability.

Parameters

column System.String requiredposition: 0
Column identifier.
value System.Double requiredposition: 1
Threshold value.

Returns

The current builder.

public ConditionBuilder Like(String column, String rx) #
Returns: ConditionBuilder

String regex like.

Parameters

column System.String requiredposition: 0
rx System.String requiredposition: 1
public ConditionBuilder Lt(String column, Double value) #
Returns: ConditionBuilder

Number less than.

Parameters

column System.String requiredposition: 0
value System.Double requiredposition: 1
public ConditionBuilder NotLike(String column, String rx) #
Returns: ConditionBuilder

String regex not-like.

Parameters

column System.String requiredposition: 0
rx System.String requiredposition: 1
public ConditionBuilder NumberEq(String column, Double value) #
Returns: ConditionBuilder

Number equals.

Parameters

column System.String requiredposition: 0
value System.Double requiredposition: 1
NumberIn 2 overloads
public ConditionBuilder NumberIn(String column, IEnumerable<Double> values) #
Returns: ConditionBuilder

Creates an IN filter for numeric columns.

Parameters

column System.String requiredposition: 0
values System.Collections.Generic.IEnumerable{System.Double} requiredposition: 1
public ConditionBuilder NumberIn(String column, params Double[] values) #
Returns: ConditionBuilder

Number IN (...) convenience params overload.

Parameters

column System.String requiredposition: 0
values System.Double[] requiredposition: 1
public ConditionBuilder NumberNe(String column, Double value) #
Returns: ConditionBuilder

Number not equals.

Parameters

column System.String requiredposition: 0
value System.Double requiredposition: 1
NumberNotIn 2 overloads
public ConditionBuilder NumberNotIn(String column, IEnumerable<Double> values) #
Returns: ConditionBuilder

Creates a NOT IN filter for numeric columns.

Parameters

column System.String requiredposition: 0
values System.Collections.Generic.IEnumerable{System.Double} requiredposition: 1
public ConditionBuilder NumberNotIn(String column, params Double[] values) #
Returns: ConditionBuilder

Number NOT IN (...) convenience params overload.

Parameters

column System.String requiredposition: 0
values System.Double[] requiredposition: 1
public ConditionBuilder Reverse(Boolean enable = true) #
Returns: ConditionBuilder

Sets ReverseCondition on the last added condition.

Parameters

enable System.Boolean = true optionalposition: 0
public ConditionBuilder StringContains(String column, String pattern, Boolean caseSensitive = false) #
Returns: ConditionBuilder

String contains (regex).

Parameters

column System.String requiredposition: 0
pattern System.String requiredposition: 1
caseSensitive System.Boolean = false optionalposition: 2
public ConditionBuilder StringEq(String column, String value, Boolean caseSensitive = false) #
Returns: ConditionBuilder

String equals condition.

Parameters

column System.String requiredposition: 0
value System.String requiredposition: 1
caseSensitive System.Boolean = false optionalposition: 2
StringIn 2 overloads
public ConditionBuilder StringIn(String column, IEnumerable<String> values) #
Returns: ConditionBuilder

Creates an IN filter for string columns.

Parameters

column System.String requiredposition: 0
values System.Collections.Generic.IEnumerable{System.String} requiredposition: 1
public ConditionBuilder StringIn(String column, params String[] values) #
Returns: ConditionBuilder

String IN (...) convenience params overload.

Parameters

column System.String requiredposition: 0
values System.String[] requiredposition: 1
public ConditionBuilder StringNe(String column, String value, Boolean caseSensitive = false) #
Returns: ConditionBuilder

String not equals condition.

Parameters

column System.String requiredposition: 0
value System.String requiredposition: 1
caseSensitive System.Boolean = false optionalposition: 2
public ConditionBuilder StringNotContains(String column, String pattern, Boolean caseSensitive = false) #
Returns: ConditionBuilder

String not contains (regex).

Parameters

column System.String requiredposition: 0
pattern System.String requiredposition: 1
caseSensitive System.Boolean = false optionalposition: 2
StringNotIn 2 overloads
public ConditionBuilder StringNotIn(String column, IEnumerable<String> values) #
Returns: ConditionBuilder

Creates a NOT IN filter for string columns.

Parameters

column System.String requiredposition: 0
values System.Collections.Generic.IEnumerable{System.String} requiredposition: 1
public ConditionBuilder StringNotIn(String column, params String[] values) #
Returns: ConditionBuilder

String NOT IN (...) convenience params overload.

Parameters

column System.String requiredposition: 0
values System.String[] requiredposition: 1
public ConditionBuilder UsingHtmlStore() #
Returns: ConditionBuilder

Forces the most recent condition to use the HTML data store.

public ConditionBuilder UsingJavaScriptStore() #
Returns: ConditionBuilder

Forces the most recent condition to use the JavaScript data store.