Demos GitHub

RadzenPivotField<TItem> Class

Base component for RadzenPivotDataGrid Rows, Columns and Aggregates.

Inheritance

Object

ComponentBase

RadzenPivotField<TItem>

Implements

IComponent

IHandleEvent

IHandleAfterRender

Inherited Members

ComponentBase.OnInitializedAsync

ComponentBase.OnParametersSet

ComponentBase.OnParametersSetAsync

ComponentBase.StateHasChanged

ComponentBase.ShouldRender

ComponentBase.OnAfterRender

ComponentBase.OnAfterRenderAsync

ComponentBase.InvokeAsync

ComponentBase.DispatchExceptionAsync

ComponentBase.RendererInfo

ComponentBase.Assets

ComponentBase.AssignedRenderMode

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenPivotField<TItem> : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender

Type Parameters

Name Description
TItemThe type of the PivotDataGrid item.

Constructors

RadzenPivotField<TItem>link

Base component for RadzenPivotDataGrid Rows, Columns and Aggregates.

Declaration
public RadzenPivotField<TItem>()

Properties

FilterOperatorlink

Gets or sets the filter operator.

Declaration
public FilterOperator FilterOperator { get; set; }
Property Value
Type Description
FilterOperatorGets or sets the filter operator.

FilterPropertyTypelink

Gets the filter property type.

Declaration
public Type FilterPropertyType { get; }
Property Value
Type Description
TypeGets the filter property type.

FilterTemplatelink

Gets or sets the filter template.

Declaration
public RenderFragment<RadzenPivotField<TItem>> FilterTemplate { get; set; }
Property Value
Type Description
RenderFragment<RadzenPivotField<TItem>>Gets or sets the filter template.

FilterValuelink

Gets or sets the filter value.

Declaration
public object FilterValue { get; set; }
Property Value
Type Description
objectGets or sets the filter value.

FilterValueTemplatelink

Gets or sets the filter value template.

Declaration
public RenderFragment<RadzenPivotField<TItem>> FilterValueTemplate { get; set; }
Property Value
Type Description
RenderFragment<RadzenPivotField<TItem>>Gets or sets the filter value template.

Filterablelink

Gets or sets a value indicating whether this column is filterable.

Declaration
public bool Filterable { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether this column is filterable.

LogicalFilterOperatorlink

Gets or sets the logical filter operator.

Declaration
public LogicalFilterOperator LogicalFilterOperator { get; set; }
Property Value
Type Description
LogicalFilterOperatorGets or sets the logical filter operator.

PivotGridlink

Gets or sets the parent pivot data grid component.

Declaration
public RadzenPivotDataGrid<TItem> PivotGrid { get; set; }
Property Value
Type Description
RadzenPivotDataGrid<TItem>Gets or sets the parent pivot data grid component.

Propertylink

Gets or sets the property name.

Declaration
public string Property { get; set; }
Property Value
Type Description
stringGets or sets the property name.

SecondFilterOperatorlink

Gets or sets the second filter operator.

Declaration
public FilterOperator SecondFilterOperator { get; set; }
Property Value
Type Description
FilterOperatorGets or sets the second filter operator.

SecondFilterValuelink

Gets or sets the second filter value.

Declaration
public object SecondFilterValue { get; set; }
Property Value
Type Description
objectGets or sets the second filter value.

SecondFilterValueTemplatelink

Gets or sets the second filter value template.

Declaration
public RenderFragment<RadzenPivotField<TItem>> SecondFilterValueTemplate { get; set; }
Property Value
Type Description
RenderFragment<RadzenPivotField<TItem>>Gets or sets the second filter value template.

Selectedlink

Gets or sets a value indicating whether this field is initially selected (active) in the pivot grid. When set to false, the field will be available in the picker but not applied on initial load.

Declaration
public bool Selected { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether this field is initially selected (active) in the pivot grid. When set to false, the field will be available in the picker but not applied on initial load.

SortOrderlink

Gets or sets the sort order.

Declaration
public SortOrder? SortOrder { get; set; }
Property Value
Type Description
SortOrder?Gets or sets the sort order.

SortOrderSequencelink

Gets or sets the sequence of the SortOrders to use when sorting the column interactively.

Declaration
public Nullable`1[[Radzen.SortOrder, Blazor, Version=10.0.1.0, Culture=neutral, PublicKeyToken=null]][] SortOrderSequence { get; set; }
Property Value
Type Description
Nullable`1[[Radzen.SortOrder, Radzen.Blazor, Version=10.0.1.0, Culture=neutral, PublicKeyToken=null]][]Gets or sets the sequence of the SortOrders to use when sorting the column interactively.

Sortablelink

Gets or sets a value indicating whether this column is sortable.

Declaration
public bool Sortable { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether this column is sortable.

Titlelink

Gets or sets the title.

Declaration
public string Title { get; set; }
Property Value
Type Description
stringGets or sets the title.

Typelink

Gets or sets the data type.

Declaration
public Type Type { get; set; }
Property Value
Type Description
TypeGets or sets the data type.

Methods

BuildRenderTreelink

Declaration
protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)
Parameters
Type Name Description
Rendering.RenderTreeBuilder __builder

Disposelink

Disposes the component and removes it from the parent pivot grid.

Declaration
public virtual void Dispose()

GetFilterOperatorlink

Gets the current filter operator (internal state).

Declaration
public FilterOperator GetFilterOperator()
Returns
Type Description
FilterOperator

GetFilterPropertylink

Gets the filter property name.

Declaration
public string GetFilterProperty()
Returns
Type Description
string

GetFilterValuelink

Gets the current filter value (internal state).

Declaration
public object GetFilterValue()
Returns
Type Description
object

GetLogicalFilterOperatorlink

Gets the current logical filter operator (internal state).

Declaration
public LogicalFilterOperator GetLogicalFilterOperator()
Returns
Type Description
LogicalFilterOperator

GetSecondFilterOperatorlink

Gets the current second filter operator (internal state).

Declaration
public FilterOperator GetSecondFilterOperator()
Returns
Type Description
FilterOperator

GetSecondFilterValuelink

Gets the current second filter value (internal state).

Declaration
public object GetSecondFilterValue()
Returns
Type Description
object

GetSortOrderlink

Gets the current sort order (internal state).

Declaration
public SortOrder? GetSortOrder()
Returns
Type Description
SortOrder?

GetTitlelink

Gets the column title.

Declaration
public string GetTitle()
Returns
Type Description
string

HasActiveFilterlink

Checks if the field has an active filter.

Declaration
public bool HasActiveFilter()
Returns
Type Description
bool

OnInitializedlink

Called when initialized.

Declaration
protected override void OnInitialized()

SetFilterOperatorlink

Sets the internal filter operator.

Declaration
public void SetFilterOperator(FilterOperator? value)
Parameters
Type Name Description
FilterOperator? value

SetFilterValuelink

Sets the internal filter value.

Declaration
public void SetFilterValue(object value, bool isFirst)
Parameters
Type Name Description
object value
bool isFirst

SetLogicalFilterOperatorlink

Sets the internal logical filter operator.

Declaration
public void SetLogicalFilterOperator(LogicalFilterOperator value)
Parameters
Type Name Description
LogicalFilterOperator value

SetParametersAsynclink

Set parameters as an asynchronous operation.

Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
Type Name Description
ParameterView parameters The parameters.
Returns
Type Description
TaskA Task representing the asynchronous operation.

SetSecondFilterOperatorlink

Sets the internal second filter operator.

Declaration
public void SetSecondFilterOperator(FilterOperator? value)
Parameters
Type Name Description
FilterOperator? value

ShowUpDownForNumericFilterlink

Gets value indicating if up and down buttons are displayed in numeric column filter.

Declaration
public virtual bool ShowUpDownForNumericFilter()
Returns
Type Description
bool
An error has occurred. This app may no longer respond until reloaded. Reload 🗙