Class PivotFieldListEvents<TValue>

Configures pivot component based events.

Inheritance

System.Object

PivotFieldListEvents<TValue>

Namespace: Syncfusion.Blazor.PivotView

Assembly: Syncfusion.Blazor.dll

Syntax

public class PivotFieldListEvents<TValue> : OwningComponentBase

Type Parameters

Name
TValue

Constructors

PivotFieldListEvents()

Declaration

public PivotFieldListEvents()

Properties

AggregateCellInfo

It allows to change the each cell value during engine populating.

Declaration

public EventCallback<AggregateEventArgs> AggregateCellInfo { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<AggregateEventArgs>

AggregateMenuOpen

It triggers before aggregate type context menu opens.

Declaration

public EventCallback<AggregateMenuOpenEventArgs> AggregateMenuOpen { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<AggregateMenuOpenEventArgs>

CalculatedFieldCreate

It triggers before a calculated field created/edited during runtime.

Declaration

public EventCallback<CalculatedFieldCreateEventArgs> CalculatedFieldCreate { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<CalculatedFieldCreateEventArgs>

Created

It trigger when the PivotFieldList component is created.

Declaration

public EventCallback<object> Created { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

DataBound

It trigger when the PivotFieldList rendered.

Declaration

public EventCallback<object> DataBound { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Destroyed

It trigger when the PivotFieldList component getting destroyed.

Declaration

public EventCallback<object> Destroyed { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

EnginePopulated

It triggers after the pivot engine populated and allows to customize the pivot datasource settings.

Declaration

public EventCallback<EnginePopulatedEventArgs> EnginePopulated { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<EnginePopulatedEventArgs>

EnginePopulating

It triggers before the pivot engine starts to populate and allows to customize the pivot datasource settings.

Declaration

public EventCallback<EnginePopulatingEventArgs> EnginePopulating { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<EnginePopulatingEventArgs>

FieldDragStart

It trigger when a field drag (move) starts.

Declaration

public EventCallback<FieldDragStartEventArgs> FieldDragStart { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<FieldDragStartEventArgs>

FieldDrop

It triggers before a field drops into any axis.

Declaration

public EventCallback<FieldDropEventArgs> FieldDrop { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<FieldDropEventArgs>

FieldDropped

It trigger when a field getting dropped into any axis.

Declaration

public EventCallback<FieldDroppedEventArgs> FieldDropped { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<FieldDroppedEventArgs>

FieldRemove

It triggers before removing the field from any axis during runtime.

Declaration

public EventCallback<FieldRemoveEventArgs> FieldRemove { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<FieldRemoveEventArgs>

MemberEditorOpen

It triggers before member editor dialog opens.

Declaration

public EventCallback<MemberEditorOpenEventArgs> MemberEditorOpen { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<MemberEditorOpenEventArgs>

MemberFiltering

It triggers before the filtering applied.

Declaration

public EventCallback<MemberFilteringEventArgs> MemberFiltering { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<MemberFilteringEventArgs>

OnActionBegin

It triggers when UI action begins in the pivot field list. The UI actions used to trigger this event such as sorting fields through icon click in the field list tree, calculated field UI, button actions such as editing, sorting, filtering and aggregation.

Declaration

public Action<PivotActionBeginEventArgs> OnActionBegin { get; set; }

Property Value

Type
System.Action<PivotActionBeginEventArgs>

Remarks

This event handler receives a PivotActionBeginEventArgs object that provides information about the current UI action of the pivot field list.

Examples

<SfPivotFieldList>
    <PivotFieldListEvents TValue="ProductDetails" OnActionBegin="ActionBegin"></PivotFieldListEvents>>
</SfPivotFieldList>

@code {
    public void ActionBegin (PivotActionBeginEventArgs args)
    {

    }
}

OnActionComplete

It triggers when UI action in the pivot field list completed. The UI actions used to trigger this event such as sorting fields through icon click in the field list tree, calculated field UI, button actions such as editing, sorting, filtering and aggregation.

Declaration

public Action<PivotActionCompleteEventArgs<TValue>> OnActionComplete { get; set; }

Property Value

Type
System.Action<PivotActionCompleteEventArgs<TValue>>

Remarks

This event handler receives a PivotActionCompleteEventArgs<T> object that provides information about the current UI action of the pivot field list.

Examples

<SfPivotFieldList>
    <PivotFieldListEvents TValue="ProductDetails" OnActionComplete="ActionCompleted"></PivotFieldListEvents>>
</SfPivotFieldList>

@code {
    public void ActionCompleted (PivotActionCompleteEventArgs<ProductDetails> args)
    {

    }
}

OnActionFailure

It triggers when UI action failed to achieve the desired results in the pivot field list. The UI actions used to trigger this event such as sorting fields through icon click in the field list tree, calculated field UI, button actions such as editing, sorting, filtering and aggregation.

Declaration

public Action<PivotActionFailureEventArgs> OnActionFailure { get; set; }

Property Value

Type
System.Action<PivotActionFailureEventArgs>

Remarks

This event handler receives a PivotActionFailureEventArgs object that provides information about the error in pivot field list. Stack trace of exceptions, if any, can also be obtained here.

Examples

<SfPivotFieldList>
    <PivotFieldListEvents TValue="ProductDetails" OnActionFailure="ActionFailed"></PivotFieldListEvents>>
</SfPivotFieldList>

@code {
    public void ActionFailed (PivotActionFailureEventArgs args)
    {

    }
}

OnLoad

It allows any customization of PivotFieldList properties on initial rendering. Based on the changes, the PivotFieldList will be rendered.

Declaration

public EventCallback<LoadEventArgs<TValue>> OnLoad { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<LoadEventArgs<TValue>>

Parent

Parent component.

Declaration

protected SfPivotFieldList<TValue> Parent { get; set; }

Property Value

Type
SfPivotFieldList<TValue>

Methods

Dispose(Boolean)

Dispose unmanaged resources.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	Boolean value to dispose the object.

OnInitializedAsync()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing any asynchronous operation.