Class QueryBuilder
Inheritance
System.Object
QueryBuilder
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Syncfusion.EJ2.dll
Syntax
public class QueryBuilder : EJTagHelper
Constructors
QueryBuilder()
Declaration
Properties
ActionBegin
Triggers when field, operator, value is change.
Declaration
[HtmlAttributeName("actionBegin")]
public string ActionBegin { get; set; }
Property Value
Type |
Description |
System.String |
|
AllowValidation
Enables or disables the validation.
Declaration
[HtmlAttributeName("allowValidation")]
public bool AllowValidation { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
BeforeChange
Triggers before the condition (And/Or), field, operator, value is changed.
Declaration
[HtmlAttributeName("beforeChange")]
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
[HtmlAttributeName("change")]
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
[HtmlAttributeName("columns")]
public List<QueryBuilderColumn> Columns { get; set; }
Property Value
Created
Triggers when the component is created.
Declaration
[HtmlAttributeName("created")]
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
[HtmlAttributeName("cssClass")]
public string CssClass { get; set; }
Property Value
Type |
Description |
System.String |
|
DataBound
Triggers when dataBound to the Query Builder.
Declaration
[HtmlAttributeName("dataBound")]
public string DataBound { 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
[HtmlAttributeName("dataSource")]
public object DataSource { get; set; }
Property Value
Type |
Description |
System.Object |
|
DisplayMode
Specifies the displayMode as Horizontal or Vertical.
Declaration
[HtmlAttributeName("displayMode")]
public DisplayMode DisplayMode { get; set; }
Property Value
EnableNotCondition
Enables/Disables the not group condition in query builder.
Declaration
[HtmlAttributeName("enableNotCondition")]
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
[HtmlAttributeName("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
FieldMode
Specifies the fieldMode as DropDownList or DropDownTree.
Declaration
[HtmlAttributeName("fieldMode")]
public FieldMode FieldMode { get; set; }
Property Value
FieldModel
Specifies the property for field.
Declaration
[HtmlAttributeName("fieldModel")]
public object FieldModel { get; set; }
Property Value
Type |
Description |
System.Object |
|
Specifies the template for the header with any other widgets.
Declaration
[HtmlAttributeName("headerTemplate")]
public string HeaderTemplate { get; set; }
Property Value
Type |
Description |
System.String |
|
Height
Specifies the height of the query builder.
Declaration
[HtmlAttributeName("height")]
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
[HtmlAttributeName("htmlAttributes")]
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
[HtmlAttributeName("immediateModeDelay")]
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
[HtmlAttributeName("locale")]
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
[HtmlAttributeName("matchCase")]
public bool MatchCase { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
MaxGroupCount
Specifies the maximum group count or restricts the group count.
Declaration
[HtmlAttributeName("maxGroupCount")]
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
OperatorModel
Specifies the property for operator.
Declaration
[HtmlAttributeName("operatorModel")]
public object OperatorModel { get; set; }
Property Value
Type |
Description |
System.Object |
|
Readonly
When set to true, the user interactions on the component are disabled.
Declaration
[HtmlAttributeName("readonly")]
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
[HtmlAttributeName("rule")]
public QueryBuilderRule Rule { get; set; }
Property Value
RuleChange
Triggers when changing the condition(AND/OR), field, value, operator is changed
Declaration
[HtmlAttributeName("ruleChange")]
public string RuleChange { get; set; }
Property Value
Type |
Description |
System.String |
|
Separator
Specifies the separator string for column.
Declaration
[HtmlAttributeName("separator")]
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
[HtmlAttributeName("showButtons")]
public QueryBuilderShowButtons ShowButtons { get; set; }
Property Value
SortDirection
Specifies the sort direction of the field names.
Declaration
[HtmlAttributeName("sortDirection")]
public SortDirection SortDirection { get; set; }
Property Value
SummaryView
Shows or hides the filtered query.
Declaration
[HtmlAttributeName("summaryView")]
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
ValueModel
Specifies the property for value.
Declaration
[HtmlAttributeName("valueModel")]
public object ValueModel { get; set; }
Property Value
Type |
Description |
System.Object |
|
Width
Specifies the width of the query builder.
Declaration
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type |
Description |
System.String |
|