Class QueryBuilder

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

QueryBuilder

Namespace: Syncfusion.EJ2.QueryBuilder

Assembly: Syncfusion.EJ2.dll

Syntax

public class QueryBuilder : EJTagHelper

Constructors

QueryBuilder()

Declaration

public QueryBuilder()

Properties

ActionBegin

Triggers when field, operator, value is change.

Declaration

public string ActionBegin { get; set; }

Property Value

Type	Description
System.String	The default value is null

AddRuleToNewGroups

Specifies a boolean value whether enable / disable the new rule adding while adding new groups.

Declaration

public bool AddRuleToNewGroups { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

AllowDragAndDrop

Specifies a boolean value whether to enable / disable the drag and drop support to move the rules/ groups.

Declaration

public bool AllowDragAndDrop { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

AllowValidation

Enables or disables the validation.

Declaration

public bool AllowValidation { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

AutoSelectField

Specifies a boolean value whether enable / disable the auto selection with the first value for the field.

Declaration

public bool AutoSelectField { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

AutoSelectOperator

Specifies a boolean value whether enable / disable the auto selection with the first value for the operator.

Declaration

public bool AutoSelectOperator { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

BeforeChange

Triggers before the condition (And/Or), field, operator, value is changed.

Declaration

public string BeforeChange { get; set; }

Property Value

Type	Description
System.String	The default value is null

Change

Triggers when changing the condition(AND/OR), field, value, operator is changed.

Declaration

public string Change { get; set; }

Property Value

Type	Description
System.String	The default value is null

Columns

Specifies columns to create filters.

Declaration

public List<QueryBuilderColumn> Columns { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<QueryBuilderColumn>	The default value is null

Created

Triggers when the component is created.

Declaration

public string Created { get; set; }

Property Value

Type	Description
System.String	The default value is null

CssClass

Defines class or multiple classes, which are separated by a space in the QueryBuilder element. You can add custom styles to the QueryBuilder using the cssClass property.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The default value is ""

DataBound

Triggers when dataBound to the Query Builder.

Declaration

public string DataBound { get; set; }

Property Value

Type	Description
System.String	The default value is null

DataSource

Binds the column name from data source in query-builder. The dataSource is an array of JavaScript objects.

Declaration

public object DataSource { get; set; }

Property Value

Type	Description
System.Object	The default value is null

DisplayMode

Specifies the displayMode as Horizontal or Vertical.

Declaration

public DisplayMode DisplayMode { get; set; }

Property Value

Type	Description
DisplayMode	The default value is DisplayMode.Horizontal

Drag

Triggers when rule/ group are dragged (moved) continuously.

Declaration

public object Drag { get; set; }

Property Value

Type	Description
System.Object	The default value is null

DragStart

Triggers when rule/ group dragging starts.

Declaration

public object DragStart { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Drop

Triggers when rule/ group are dropped on to the target rule/ group.

Declaration

public object Drop { get; set; }

Property Value

Type	Description
System.Object	The default value is null

EnableNotCondition

Enables/Disables the not group condition in query builder.

Declaration

public bool EnableNotCondition { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnablePersistence

Enable or disable persisting component's state between page reloads. If enabled, filter states will be persisted.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableSeparateConnector

Specifies whether to enable separate connectors between rules/groups.

Declaration

public bool EnableSeparateConnector { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

FieldMode

Specifies the fieldMode as DropDownList or DropDownTree.

Declaration

public FieldMode FieldMode { get; set; }

Property Value

Type	Description
FieldMode	The default value is FieldMode.Default

FieldModel

Specifies the property for field.

Declaration

public object FieldModel { get; set; }

Property Value

Type	Description
System.Object	The default value is null

HeaderTemplate

Specifies the template for the header with any other widgets.

Declaration

public string HeaderTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

Height

Specifies the height of the query builder.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	The default value is "auto"

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration

public object HtmlAttributes { get; set; }

Property Value

Type
System.Object

ImmediateModeDelay

If immediateModeDelay is set by particular number, the rule Change event is triggered after that period.

Declaration

public double ImmediateModeDelay { get; set; }

Property Value

Type	Description
System.Double	The default value is 0

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String	The default value is ""

MatchCase

If match case is set to true, the grid filters the records with exact match. if false, it filters case insensitive records (uppercase and lowercase letters treated the same).

Declaration

public bool MatchCase { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

MaxGroupCount

Specifies the maximum group count or restricts the group count.

Declaration

public double MaxGroupCount { get; set; }

Property Value

Type	Description
System.Double	The default value is 5

OperatorModel

Specifies the property for operator.

Declaration

public object OperatorModel { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Readonly

When set to true, the user interactions on the component are disabled.

Declaration

public bool Readonly { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Rule

Defines rules in the QueryBuilder. Specifies the initial rule, which is JSON data.

Declaration

public QueryBuilderRule Rule { get; set; }

Property Value

Type	Description
QueryBuilderRule	The default value is null

RuleChange

Triggers when changing the condition(AND/OR), field, value, operator is changed

Declaration

public string RuleChange { get; set; }

Property Value

Type	Description
System.String	The default value is null

Separator

Specifies the separator string for column.

Declaration

public string Separator { get; set; }

Property Value

Type	Description
System.String	The default value is ""

ShowButtons

Specifies the showButtons settings of the query builder component. The showButtons can be enable Enables or disables the ruleDelete, groupInsert, and groupDelete buttons.

Declaration

public QueryBuilderShowButtons ShowButtons { get; set; }

Property Value

Type	Description
QueryBuilderShowButtons	The default value is null

SortDirection

Specifies the sort direction of the field names.

Declaration

public SortDirection SortDirection { get; set; }

Property Value

Type	Description
SortDirection	The default value is SortDirection.Default

SummaryView

Shows or hides the filtered query.

Declaration

public bool SummaryView { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

ValueModel

Specifies the property for value.

Declaration

public object ValueModel { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Width

Specifies the width of the query builder.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The default value is "auto"