Class ActionEventArgs<T>

Defines the event arguments of grid Action.

Inheritance
System.Object
GridEventBaseArgs
ActionEventArgs<T>
Inherited Members
Namespace: Syncfusion.Blazor.Grids
Assembly: Syncfusion.Blazor.dll
Syntax
public class ActionEventArgs<T> : GridEventBaseArgs
Type Parameters
Name Description
T

TValue of the grid component.

Constructors

ActionEventArgs()

Declaration
public ActionEventArgs()

Properties

Action

Defines the current action.

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

Cancel

Cancel the print action.

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

CheckboxListData

Defines the custom data source for Checkbox/Excel filter.

Declaration
public IEnumerable<object> CheckboxListData { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.Object>

Code

Defines the string that identifies the physical key being pressed while saving the edited record by using Enter/Tab keys.

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

If the record is saved by pressing the Update button or mouse click, then null value will be assigned.

ColumnName

Defines the field name of the currently grouped columns.

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

Columns

Defines the collection of filtered columns.

Declaration
public List<PredicateModel<object>> Columns { get; set; }
Property Value
Type Description
System.Collections.Generic.List<PredicateModel<System.Object>>

CurrentFilteringColumn

Defines the column name that is currently filtered.

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

CurrentFilterObject

Defines the object that is currently filtered.

Declaration
public PredicateModel<object> CurrentFilterObject { get; set; }
Property Value
Type Description
PredicateModel<System.Object>

CurrentPage

Defines the current page number.

Declaration
public double CurrentPage { get; set; }
Property Value
Type Description
System.Double

Data

Defines the record objects.

Declaration
public T Data { get; set; }
Property Value
Type Description
T

Direction

Defines the direction of sort column.

Declaration
public SortDirection Direction { get; set; }
Property Value
Type Description
SortDirection

EditContext

Defines the current EditContext instance.

Declaration
public EditContext EditContext { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.Forms.EditContext

ExcelSearchOperator

Defines the excel search operator.

Declaration
public Operator ExcelSearchOperator { get; set; }
Property Value
Type Description
Operator

FilterChoiceCount

Defines take number of data while Filtering.

Declaration
public double FilterChoiceCount { get; set; }
Property Value
Type Description
System.Double

FilterOperators

Defines the custom filter operators.

Declaration
public List<object> FilterOperators { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Object>

ForeignKeyData

Defines foreign data object.

Declaration
public IDictionary<string, IEnumerable<object>> ForeignKeyData { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Collections.Generic.IEnumerable<System.Object>>

Form

Define the form element.

Declaration
public DOM Form { get; set; }
Property Value
Type Description
DOM

FromColumns

Defines the collection of columns to be moved.

Declaration
public List<GridColumn> FromColumns { get; set; }
Property Value
Type Description
System.Collections.Generic.List<GridColumn>

HiddenColumns

Specifies the list of hidden columns in column chooser.

Declaration
public List<GridColumn> HiddenColumns { get; set; }
Property Value
Type Description
System.Collections.Generic.List<GridColumn>

Index

Added row index.

Declaration
public double Index { get; set; }
Property Value
Type Description
System.Double

IsShiftKeyPressed

Returns true if the shift key is down, when the save action is performed by Shift and Tab key combination else it returns false.

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

MovableForm

Define the movable table form element.

Declaration
public DOM MovableForm { get; set; }
Property Value
Type Description
DOM

PreventDataClone

Gets or sets whether to clone data object during editing. Set the property, When OnActionBegin event triggered with RequestType as BeforeBeginEdit.

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

The default value is false. true, if grid should prevent cloning of data object. So, editing of grid is performed directly in the data.
Remarks

If PreventDataClone is set as true, edited data saved even user dicard the changes using Cancel button in the toolbar.

PreventFilterQuery

Gets or Sets whether to prevent the grid column’s default filter query during the API call. In few cases, the default filter request might be large and also most of the clients and servers have limitation on length of URL. In such case the default filter request throws long URI exception. We have an option to handle this kind of scenario’s. You can generate the custom query for the grid column and set that query in the ProcessCustomFilterQuery method by overriding of the adaptor as we demonstrated in the code example. Set the property in OnActionBegin event with RequestType as Filtering

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

The default value is false.
Examples
@implements IDisposable
<SfGrid AllowFiltering="true">
<GridEvents TValue="Book" OnActionBegin="OnActionBegin"/>
<GridForeignColumn @nameof(Book.CustomerId)>
<SfDataManager @ref="DataManagerRef" Url="http://localhost:64956/odata/customers" Adaptor="Adaptors.ODataV4Adaptor"></SfDataManager>
</GridForeignColumn>
</SfGrid>
@code{
SfGrid<Order> Grid;
public SfDataManager DataManagerRef { get; set; }
public static Query CustomQuery = new Query();
protected override void OnAfterRender(bool firstRender)
{
   if (firstRender)
   {
       DataManagerRef.DataAdaptor = new TestOData(DataManagerRef);
   }
   base.OnAfterRender(firstRender);
}
void IDisposable.Dispose()
{        
   CustomQuery = null;
}
public class TestOData : ODataV4Adaptor
{
   public TestOData(DataManager dm) : base(dm)
   {
   }
   public override Query ProcessCustomFilterQuery(Query query)
   {
       return CustomQuery;
   }
}
private void OnActionBegin(Syncfusion.Blazor.Grids.ActionEventArgs<Book> args)
{
   if(args.RequestType == Syncfusion.Blazor.Grids.Action.FilterSearchBegin)
   {
      if(args.SearchString != string.Empty)
      {
          args.SearchString = string.Empty;
          args.CheckboxListData = new List<Book>() { new Book() { Id = Guid.NewGuid(), CustomerId = Guid.NewGuid(), CustomerId1 = Guid.NewGuid(), Active = false, CreditLimit = 20 }};
       }
    }
    if (args.RequestType.Equals(Syncfusion.Blazor.Grids.Action.ClearFiltering))
    {
       CustomQuery = new Query();
    }
    if (args.RequestType == Syncfusion.Blazor.Grids.Action.Filtering)
    {
       if (String.Equals(args.CurrentFilteringColumn, null, StringComparison.OrdinalIgnoreCase) && String.Equals(args.CurrentFilterObject?.Field, "Name", StringComparison.OrdinalIgnoreCase))
       {
           CustomQuery = new Query();
       }
       if (String.Equals(args.CurrentFilteringColumn, nameof(Book.CustomerId), StringComparison.OrdinalIgnoreCase))
       {
       args.PreventFilterQuery = true;
       List<WhereFilter> AndPredicate = new List<WhereFilter>();
       if (args.Columns != null)
       {
           foreach (var col in args.Columns)
           {
               AndPredicate.Add(new WhereFilter() { Field = "Customer/Name", Operator = col.Operator.ToString().ToLower(), value = col.Value, Condition = col.Predicate });
           }
           if (AndPredicate[0].Condition == "and")
           {
               CustomQuery = new Query().Where(new WhereFilter() { Condition = "and", IsComplex = true, predicates = AndPredicate });
           }
           else
           {
               CustomQuery = new Query().Where(new WhereFilter() { Condition = "or", IsComplex = true, predicates = AndPredicate });
           }
       }
       else if (args.Columns == null)
       {
           CustomQuery = new Query().Where("Customer/Name", args.CurrentFilterObject.Operator.ToString().ToLower(), args.CurrentFilterObject.Value, true, true);
       }
       }
   }
}
}

PreviousData

Defines the previous data.

Declaration
public T PreviousData { get; set; }
Property Value
Type Description
T

PreviousPage

Defines the previous page number.

Declaration
public double PreviousPage { get; set; }
Property Value
Type Description
System.Double

PrimaryKeys

Defines the primary keys.

Declaration
public string[] PrimaryKeys { get; set; }
Property Value
Type Description
System.String[]

PrimaryKeyValue

Defines the primary key value.

Declaration
public object PrimaryKeyValue { get; set; }
Property Value
Type Description
System.Object

RequestType

Defines the current action.

Declaration
public Action RequestType { get; set; }
Property Value
Type Description
Action

Row

Defines the added row.

Declaration
public DOM Row { get; set; }
Property Value
Type Description
DOM

RowData

Defines the record objects.

Declaration
public T RowData { get; set; }
Property Value
Type Description
T

RowIndex

Defines the edited rowIndex.

Declaration
public double RowIndex { get; set; }
Property Value
Type Description
System.Double

SearchString

Defines the string value to search.

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

SelectedRow

Defines the selected row index.

Declaration
public double SelectedRow { get; set; }
Property Value
Type Description
System.Double

Target

Defines the target for dialog.

Declaration
public DOM Target { get; set; }
Property Value
Type Description
DOM

ToColumn

Defines the destination column to place reordered columns.

Declaration
public GridColumn ToColumn { get; set; }
Property Value
Type Description
GridColumn

Tr

Defines the selected rows for delete.

Declaration
public List<DOM> Tr { get; set; }
Property Value
Type Description
System.Collections.Generic.List<DOM>

Type

Defines the type of event.

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

VisibleColumns

Specifies the list of visible columns in column chooser.

Declaration
public List<GridColumn> VisibleColumns { get; set; }
Property Value
Type Description
System.Collections.Generic.List<GridColumn>