Class IgbQueryBuilder

Inheritance
System.Object
BaseRendererControl
IgbQueryBuilder
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbQueryBuilder : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbQueryBuilder()

Declaration
public IgbQueryBuilder()

Properties

ActualQueryBuilderHeaderCollection

Declaration
public IgbQueryBuilderHeaderCollection ActualQueryBuilderHeaderCollection { get; }
Property Value
Type Description
IgbQueryBuilderHeaderCollection

ContentQueryBuilderHeaderCollection

Declaration
public IgbQueryBuilderHeaderCollection ContentQueryBuilderHeaderCollection { get; }
Property Value
Type Description
IgbQueryBuilderHeaderCollection

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides

DisableEntityChange

Disables subsequent entity changes at the root level after the initial selection.

Declaration
public bool DisableEntityChange { get; set; }
Property Value
Type Description
System.Boolean

DisableReturnFieldsChange

Disables return fields changes at the root level.

Declaration
public bool DisableReturnFieldsChange { get; set; }
Property Value
Type Description
System.Boolean

Entities

Gets the list of entities available for the IgxQueryBuilderComponent. Each entity describes a logical group of fields that can be used in queries. An entity can optionally have child entities, allowing nested sub-queries. @returns An array of {@link EntityType} objects.

Declaration
public IgbEntityType[] Entities { get; set; }
Property Value
Type Description
IgbEntityType[]

ExpressionTree

Returns the expression tree.

Declaration
public IgbExpressionTree ExpressionTree { get; set; }
Property Value
Type Description
IgbExpressionTree

ExpressionTreeChange

Declaration
public EventCallback<IgbExpressionTreeEventArgs> ExpressionTreeChange { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbExpressionTreeEventArgs>

ExpressionTreeChangeScript

Declaration
public string ExpressionTreeChangeScript { get; set; }
Property Value
Type Description
System.String

Locale

Gets the locale of the query builder. If not set, defaults to application's locale.

Declaration
public string Locale { get; set; }
Property Value
Type Description
System.String

ParentTypeName

Declaration
protected override string ParentTypeName { get; }
Property Value
Type Description
System.String
Overrides

QueryBuilderHeaderCollection

@hidden @internal

Declaration
public IgbQueryBuilderHeaderCollection QueryBuilderHeaderCollection { get; protected set; }
Property Value
Type Description
IgbQueryBuilderHeaderCollection

SearchValueTemplate

Sets/gets the search value template.

Declaration
public RenderFragment<IgbQueryBuilderSearchValueContext> SearchValueTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<IgbQueryBuilderSearchValueContext>

SearchValueTemplateScript

Provides a means of setting SearchValueTemplate in the JavaScript environment.

Declaration
public string SearchValueTemplateScript { get; set; }
Property Value
Type Description
System.String

ShowEntityChangeDialog

Gets/sets whether the confirmation dialog should be shown when changing entity. Default value is true.

Declaration
public bool ShowEntityChangeDialog { get; set; }
Property Value
Type Description
System.Boolean

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

Methods

CanCommit()

Declaration
public bool CanCommit()
Returns
Type Description
System.Boolean

CanCommitAsync()

Returns whether the expression tree can be committed in the current state.

Declaration
public Task<bool> CanCommitAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Commit()

Declaration
public void Commit()

CommitAsync()

Commits the expression tree in the current state if it is valid. If not throws an exception.

Declaration
public Task CommitAsync()
Returns
Type Description
System.Threading.Tasks.Task

Discard()

Declaration
public void Discard()

DiscardAsync()

Discards all unsaved changes to the expression tree.

Declaration
public Task DiscardAsync()
Returns
Type Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable