Class QueryBuilderBuilder

Inheritance

System.Object

ControlBuilder

QueryBuilderBuilder

Inherited Members

ControlBuilder.Context

Namespace: Syncfusion.EJ2.QueryBuilder

Assembly: Syncfusion.EJ2.dll

Syntax

public class QueryBuilderBuilder : ControlBuilder

Constructors

QueryBuilderBuilder()

Declaration

public QueryBuilderBuilder()

QueryBuilderBuilder(QueryBuilder)

Declaration

public QueryBuilderBuilder(QueryBuilder model)

Parameters

Type	Name	Description
QueryBuilder	model

Fields

model

Declaration

public QueryBuilder model

Field Value

Type	Description
QueryBuilder

Properties

HtmlAttr

Declaration

public IDictionary<string, object> HtmlAttr { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Output

Declaration

public override TextWriter Output { get; set; }

Property Value

Type	Description
System.IO.TextWriter

Overrides

ControlBuilder.Output

Methods

ActionBegin(String)

Triggers when field, operator, value is change.

Declaration

public QueryBuilderBuilder ActionBegin(string actionBegin)

Parameters

Type	Name	Description
System.String	actionBegin

Returns

Type	Description
QueryBuilderBuilder

AllowValidation(Boolean)

Enables or disables the validation.

Declaration

public QueryBuilderBuilder AllowValidation(bool allowValidation = true)

Parameters

Type	Name	Description
System.Boolean	allowValidation

Returns

Type	Description
QueryBuilderBuilder

BeforeChange(String)

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

Declaration

public QueryBuilderBuilder BeforeChange(string beforeChange)

Parameters

Type	Name	Description
System.String	beforeChange

Returns

Type	Description
QueryBuilderBuilder

Change(String)

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

Declaration

public QueryBuilderBuilder Change(string change)

Parameters

Type	Name	Description
System.String	change

Returns

Type	Description
QueryBuilderBuilder

Columns(Action<QueryBuilderColumnBuilder>)

Declaration

public QueryBuilderBuilder Columns(Action<QueryBuilderColumnBuilder> columns)

Parameters

Type	Name	Description
System.Action<QueryBuilderColumnBuilder>	columns

Returns

Type	Description
QueryBuilderBuilder

Columns(List<QueryBuilderColumn>)

Specifies columns to create filters.

Declaration

public QueryBuilderBuilder Columns(List<QueryBuilderColumn> columns)

Parameters

Type	Name	Description
System.Collections.Generic.List<QueryBuilderColumn>	columns

Returns

Type	Description
QueryBuilderBuilder

Created(String)

Triggers when the component is created.

Declaration

public QueryBuilderBuilder Created(string created)

Parameters

Type	Name	Description
System.String	created

Returns

Type	Description
QueryBuilderBuilder

CssClass(String)

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 QueryBuilderBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
QueryBuilderBuilder

DataBound(String)

Triggers when dataBound to the Query Builder.

Declaration

public QueryBuilderBuilder DataBound(string dataBound)

Parameters

Type	Name	Description
System.String	dataBound

Returns

Type	Description
QueryBuilderBuilder

DataSource(Action<DataManagerBuilder>)

Declaration

public QueryBuilderBuilder DataSource(Action<DataManagerBuilder> dataSource)

Parameters

Type	Name	Description
System.Action<DataManagerBuilder>	dataSource

Returns

Type	Description
QueryBuilderBuilder

DataSource(Object)

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

Declaration

public QueryBuilderBuilder DataSource(object dataSource)

Parameters

Type	Name	Description
System.Object	dataSource

Returns

Type	Description
QueryBuilderBuilder

DisplayMode(DisplayMode)

Specifies the displayMode as Horizontal or Vertical.

Declaration

public QueryBuilderBuilder DisplayMode(DisplayMode displayMode)

Parameters

Type	Name	Description
DisplayMode	displayMode

Returns

Type	Description
QueryBuilderBuilder

EnableNotCondition(Boolean)

Enables/Disables the not group condition in query builder.

Declaration

public QueryBuilderBuilder EnableNotCondition(bool enableNotCondition = true)

Parameters

Type	Name	Description
System.Boolean	enableNotCondition

Returns

Type	Description
QueryBuilderBuilder

EnablePersistence(Boolean)

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

Declaration

public QueryBuilderBuilder EnablePersistence(bool enablePersistence = true)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
QueryBuilderBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration

public QueryBuilderBuilder EnableRtl(bool enableRtl = true)

Parameters

Type	Name	Description
System.Boolean	enableRtl

Returns

Type	Description
QueryBuilderBuilder

FieldMode(FieldMode)

Specifies the fieldMode as DropDownList or DropDownTree.

Declaration

public QueryBuilderBuilder FieldMode(FieldMode fieldMode)

Parameters

Type	Name	Description
FieldMode	fieldMode

Returns

Type	Description
QueryBuilderBuilder

FieldModel(Object)

Specifies the property for field.

Declaration

public QueryBuilderBuilder FieldModel(object fieldModel)

Parameters

Type	Name	Description
System.Object	fieldModel

Returns

Type	Description
QueryBuilderBuilder

HeaderTemplate(String)

Specifies the template for the header with any other widgets.

Declaration

public QueryBuilderBuilder HeaderTemplate(string headerTemplate)

Parameters

Type	Name	Description
System.String	headerTemplate

Returns

Type	Description
QueryBuilderBuilder

Height(String)

Specifies the height of the query builder.

Declaration

public QueryBuilderBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height

Returns

Type	Description
QueryBuilderBuilder

HtmlAttributes(Object)

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

Declaration

public QueryBuilderBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
QueryBuilderBuilder

ImmediateModeDelay(Double)

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

Declaration

public QueryBuilderBuilder ImmediateModeDelay(double immediateModeDelay)

Parameters

Type	Name	Description
System.Double	immediateModeDelay

Returns

Type	Description
QueryBuilderBuilder

Locale(String)

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

Declaration

public QueryBuilderBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
QueryBuilderBuilder

MatchCase(Boolean)

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 QueryBuilderBuilder MatchCase(bool matchCase = true)

Parameters

Type	Name	Description
System.Boolean	matchCase

Returns

Type	Description
QueryBuilderBuilder

MaxGroupCount(Double)

Specifies the maximum group count or restricts the group count.

Declaration

public QueryBuilderBuilder MaxGroupCount(double maxGroupCount)

Parameters

Type	Name	Description
System.Double	maxGroupCount

Returns

Type	Description
QueryBuilderBuilder

OperatorModel(Object)

Specifies the property for operator.

Declaration

public QueryBuilderBuilder OperatorModel(object operatorModel)

Parameters

Type	Name	Description
System.Object	operatorModel

Returns

Type	Description
QueryBuilderBuilder

Readonly(Boolean)

Declaration

public QueryBuilderBuilder Readonly(bool readOnly = true)

Parameters

Type	Name	Description
System.Boolean	readOnly

Returns

Type	Description
QueryBuilderBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
Microsoft.AspNetCore.Html.HtmlString

Rule(QueryBuilderRule)

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

Declaration

public QueryBuilderBuilder Rule(QueryBuilderRule rule)

Parameters

Type	Name	Description
QueryBuilderRule	rule

Returns

Type	Description
QueryBuilderBuilder

Rule(Action<QueryBuilderRuleBuilder>)

Declaration

public QueryBuilderBuilder Rule(Action<QueryBuilderRuleBuilder> rule)

Parameters

Type	Name	Description
System.Action<QueryBuilderRuleBuilder>	rule

Returns

Type	Description
QueryBuilderBuilder

RuleChange(String)

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

Declaration

public QueryBuilderBuilder RuleChange(string ruleChange)

Parameters

Type	Name	Description
System.String	ruleChange

Returns

Type	Description
QueryBuilderBuilder

Separator(String)

Specifies the separator string for column.

Declaration

public QueryBuilderBuilder Separator(string separator)

Parameters

Type	Name	Description
System.String	separator

Returns

Type	Description
QueryBuilderBuilder

ShowButtons(QueryBuilderShowButtons)

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 QueryBuilderBuilder ShowButtons(QueryBuilderShowButtons showButtons)

Parameters

Type	Name	Description
QueryBuilderShowButtons	showButtons

Returns

Type	Description
QueryBuilderBuilder

ShowButtons(Action<QueryBuilderShowButtonsBuilder>)

Declaration

public QueryBuilderBuilder ShowButtons(Action<QueryBuilderShowButtonsBuilder> showButtons)

Parameters

Type	Name	Description
System.Action<QueryBuilderShowButtonsBuilder>	showButtons

Returns

Type	Description
QueryBuilderBuilder

SortDirection(SortDirection)

Specifies the sort direction of the field names.

Declaration

public QueryBuilderBuilder SortDirection(SortDirection sortDirection)

Parameters

Type	Name	Description
SortDirection	sortDirection

Returns

Type	Description
QueryBuilderBuilder

SummaryView(Boolean)

Shows or hides the filtered query.

Declaration

public QueryBuilderBuilder SummaryView(bool summaryView = true)

Parameters

Type	Name	Description
System.Boolean	summaryView

Returns

Type	Description
QueryBuilderBuilder

ValueModel(Object)

Specifies the property for value.

Declaration

public QueryBuilderBuilder ValueModel(object valueModel)

Parameters

Type	Name	Description
System.Object	valueModel

Returns

Type	Description
QueryBuilderBuilder

Width(String)

Specifies the width of the query builder.

Declaration

public QueryBuilderBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
QueryBuilderBuilder