Class SqlFilterExpressionDef

Namespace

Tripous.Data

Assembly

Tripous.Data.dll

A filter expression,

e.g. [[string:Customer Name]]

See the SqlFilterExpressions.txt file for the filter syntax.

public class SqlFilterExpressionDef

Inheritance

object

SqlFilterExpressionDef

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

TypeExtensions.InheritsFrom(object, Type)

Constructors

SqlFilterExpressionDef()

Constructor.

public SqlFilterExpressionDef()

Properties

DateRange

The date range. Used when it is a Date filter only.

[[date:MyDate]] is a Custom date. The user must enter the date in the runtime UI.

[[date:LastMonth:MyDate]] is a computed date. The system computes the date in the runtime UI.

[JsonIgnore]
public DateRange DateRange { get; }

Property Value

DateRange

Errors

The list of errors in the filter definition.

[JsonIgnore]
public string Errors { get; }

Property Value

string

ExpressionType

The type of the filter, e.g. String, Date, Integer, Decimal, LookUp, Enum

[JsonIgnore]
public SqlFilterExpressionType ExpressionType { get; }

Property Value

SqlFilterExpressionType

HasErrors

True when there are errors in the filter definition.

[JsonIgnore]
public bool HasErrors { get; }

Property Value

bool

IsMultiple

True when 'multi' is included in the RawTag

[JsonIgnore]
public bool IsMultiple { get; }

Property Value

bool

IsNumeric

True when in lookup or enum types a numeric modifier is used.

e.g.

[[lookup:string|int:Label]]

[[enum:string|int|dec:Label]]

[JsonIgnore]
public bool IsNumeric { get; }

Property Value

bool

Label

The label the user gives to the filter, e.g. A_Date as in [[date:A_Date]]

A label may contain spaces and characters other than english characters.

[JsonIgnore]
public string Label { get; }

Property Value

string

LookUpSelectSqlText

Lookup SELECT statement.

[JsonIgnore]
public string LookUpSelectSqlText { get; }

Property Value

string

RawTag

The raw tag, e.g. [[date:A_Date]]

public string RawTag { get; set; }

Property Value

string

Statement

When it is a LookUp or Enum filter, this is the SELECT statement or the list of constants the user enters in the design-time UI.

When it is a LookUp filter, this is a SELECT statement.

When it is an Enum filter, this is a semicolon delimited list of constants.

public string Statement { get; set; }

Property Value

string

Tag

A user defined object.

[JsonIgnore]
public object Tag { get; set; }

Property Value

object

Text

When it is a LookUp or Enum filter, this is the SELECT statement or the list of constants the user enters inline in the SELECT statement.

When it is a LookUp filter this is a SELECT statement, e.g. [[lookup:int:Country:select Id from Country]]

When it is an Enum filter, this is a semicolon delimited list of constants, e.g. [[enum:string:Status:Pending;Completed;Cancelled]]

[JsonIgnore]
public string Text { get; set; }

Property Value

string

Value

The value the user enters in the runtime UI when the SELECT is executed.

When this is a Date filter with a value other than Custom then this value is automatically completed in the runtime UI that executes the SELECT.

[JsonIgnore]
public string Value { get; set; }

Property Value

string

Methods

ToString()

Returns a string representation of this instance.

public override string ToString()

Returns

string