Class QueryBuilder
Inheritance
System.Object
QueryBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class QueryBuilder : EJTagHelper
Constructors
QueryBuilder()
Declaration
Properties
ActionBegin
Triggers when field, operator, value is change.
Declaration
public string ActionBegin { get; set; }
Property Value
Type |
Description |
System.String |
|
AllowValidation
Enables or disables the validation.
Declaration
public bool AllowValidation { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
BeforeChange
Triggers before the condition (And/Or), field, operator, value is changed.
Declaration
public string BeforeChange { get; set; }
Property Value
Type |
Description |
System.String |
|
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 |
|
ClassName
Declaration
protected override string ClassName { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
Columns
Specifies columns to create filters.
Declaration
public List<QueryBuilderColumn> Columns { get; set; }
Property Value
Created
Triggers when the component is created.
Declaration
public string Created { get; set; }
Property Value
Type |
Description |
System.String |
|
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 |
|
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 |
|
DisplayMode
Specifies the displayMode as Horizontal or Vertical.
Declaration
public DisplayMode DisplayMode { get; set; }
Property Value
EnableNotCondition
Enables/Disables the not group condition in query builder.
Declaration
public bool EnableNotCondition { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
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 |
|
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
public bool EnableRtl { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Height
Specifies the height of the query builder.
Declaration
public string Height { get; set; }
Property Value
Type |
Description |
System.String |
|
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 |
Description |
System.Object |
|
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 |
|
IsFor
Declaration
protected override bool IsFor { get; }
Property Value
Type |
Description |
System.Boolean |
|
Overrides
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 |
|
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 |
|
MaxGroupCount
Specifies the maximum group count or restricts the group count.
Declaration
public double MaxGroupCount { get; set; }
Property Value
Type |
Description |
System.Double |
|
NameSpace
Declaration
protected override string NameSpace { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
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 |
|
Rule
Defines rules in the QueryBuilder.
Specifies the initial rule, which is JSON data.
Declaration
public QueryBuilderRule Rule { get; set; }
Property Value
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 |
|
Separator
Specifies the separator string for column.
Declaration
public string Separator { get; set; }
Property Value
Type |
Description |
System.String |
|
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
SortDirection
Specifies the sort direction of the field names.
Declaration
public SortDirection SortDirection { get; set; }
Property Value
SummaryView
Shows or hides the filtered query.
Declaration
public bool SummaryView { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
TagName
Declaration
protected override string TagName { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
Width
Specifies the width of the query builder.
Declaration
public string Width { get; set; }
Property Value
Type |
Description |
System.String |
|