Class ActionBeginEventArgs

Event argument for data fetch initiation in ComboBox, DropDownList, ListBox, or related Syncfusion dropdown controls.

Inheritance

object

ActionBeginEventArgs

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Syncfusion.Blazor.DropDowns

Assembly: Syncfusion.Blazor.dll

Syntax

public class ActionBeginEventArgs

Remarks

ActionBeginEventArgs lets your delegate or event handler examine and optionally cancel, alter, or modify a data fetch operation, query, or server call before it commences.

Examples

void OnActionBegin(ActionBeginEventArgs args) {
    if (args.EventName == "load" && args.Query != null) {
        // Add extra filter to query
        args.Query.AddParams("onlyActive", true);
    }
    if (args.EventName == "filtering" && ShouldPreventFilter(args.Query))
        args.Cancel = true;
}

Constructors

ActionBeginEventArgs()

Declaration

public ActionBeginEventArgs()

Properties

Cancel

Gets or sets whether to cancel the pending data operation (set to true to prevent fetch/filter).

Declaration

[JsonPropertyName("cancel")]
public bool Cancel { get; set; }

Property Value

Type	Description
bool	`true` cancels; `false` allows.

EnableFullLookup

Gets or sets a value indicating if a full data lookup (using the equal operator and not just pre-bound results) is requested or permitted.

Declaration

public bool EnableFullLookup { get; set; }

Property Value

Type	Description
bool	`true` (default) to allow full result scan; `false` for optimized pre-binding only.

Remarks

Enables strict match requests, which may impact remote performance. Use with care on large data sources.

EventName

Gets the event name or type for which the action is being initiated (such as "filtering", "load").

Declaration

[JsonPropertyName("eventName")]
public string EventName { get; }

Property Value

Type	Description
string	Name of the event as a string.

Query

Gets or sets a query object specifying details for the fetch operation; may be altered or inspected prior to data fetch.

Declaration

[JsonPropertyName("query")]
public Query Query { get; set; }

Property Value

Type	Description
Query	A Query instance indicating required data logic.