Class RadzenPivotField<TItem>

Base component for RadzenPivotDataGrid Rows, Columns and Aggregates.

Inheritance

object

ComponentBase

RadzenPivotField<TItem>

RadzenPivotAggregate<TItem>

RadzenPivotColumn<TItem>

RadzenPivotRow<TItem>

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

Inherited Members

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSet()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.OnAfterRenderAsync(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

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

Type Parameters

Name	Description
TItem	The type of the PivotDataGrid item.

Constructors

RadzenPivotField()

Base component for RadzenPivotDataGrid Rows, Columns and Aggregates.

Declaration

public RadzenPivotField()

Properties

FilterOperator

Gets or sets the filter operator.

Declaration

[Parameter]
public FilterOperator FilterOperator { get; set; }

Property Value

Type	Description
FilterOperator

FilterPropertyType

Gets the filter property type.

Declaration

public Type FilterPropertyType { get; }

Property Value

Type	Description
Type

FilterTemplate

Gets or sets the filter template.

Declaration

[Parameter]
public RenderFragment<RadzenPivotField<TItem>> FilterTemplate { get; set; }

Property Value

Type	Description
RenderFragment<RadzenPivotField<TItem>>

FilterValue

Gets or sets the filter value.

Declaration

[Parameter]
public object FilterValue { get; set; }

Property Value

Type	Description
object

FilterValueTemplate

Gets or sets the filter value template.

Declaration

[Parameter]
public RenderFragment<RadzenPivotField<TItem>> FilterValueTemplate { get; set; }

Property Value

Type	Description
RenderFragment<RadzenPivotField<TItem>>

Filterable

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

Declaration

[Parameter]
public bool Filterable { get; set; }

Property Value

Type	Description
bool

LogicalFilterOperator

Gets or sets the logical filter operator.

Declaration

[Parameter]
public LogicalFilterOperator LogicalFilterOperator { get; set; }

Property Value

Type	Description
LogicalFilterOperator

PivotGrid

Gets or sets the parent pivot data grid component.

Declaration

[CascadingParameter]
public RadzenPivotDataGrid<TItem> PivotGrid { get; set; }

Property Value

Type	Description
RadzenPivotDataGrid<TItem>

Property

Gets or sets the property name.

Declaration

[Parameter]
public string Property { get; set; }

Property Value

Type	Description
string

SecondFilterOperator

Gets or sets the second filter operator.

Declaration

[Parameter]
public FilterOperator SecondFilterOperator { get; set; }

Property Value

Type	Description
FilterOperator

SecondFilterValue

Gets or sets the second filter value.

Declaration

[Parameter]
public object SecondFilterValue { get; set; }

Property Value

Type	Description
object

SecondFilterValueTemplate

Gets or sets the second filter value template.

Declaration

[Parameter]
public RenderFragment<RadzenPivotField<TItem>> SecondFilterValueTemplate { get; set; }

Property Value

Type	Description
RenderFragment<RadzenPivotField<TItem>>

SortOrder

Gets or sets the sort order.

Declaration

[Parameter]
public SortOrder? SortOrder { get; set; }

Property Value

Type	Description
SortOrder?

Sortable

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

Declaration

[Parameter]
public bool Sortable { get; set; }

Property Value

Type	Description
bool

Title

Gets or sets the title.

Declaration

[Parameter]
public string Title { get; set; }

Property Value

Type	Description
string

Type

Gets or sets the data type.

Declaration

[Parameter]
public Type Type { get; set; }

Property Value

Type	Description
Type	The data type.

Methods

BuildRenderTree(RenderTreeBuilder)

Base component for RadzenPivotDataGrid Rows, Columns and Aggregates.

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

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

Declaration

public virtual void Dispose()

GetFilterOperator()

Gets the current filter operator (internal state).

Declaration

public FilterOperator GetFilterOperator()

Returns

Type	Description
FilterOperator

GetFilterProperty()

Gets the filter property name.

Declaration

public string GetFilterProperty()

Returns

Type	Description
string

GetFilterValue()

Gets the current filter value (internal state).

Declaration

public object GetFilterValue()

Returns

Type	Description
object

GetLogicalFilterOperator()

Gets the current logical filter operator (internal state).

Declaration

public LogicalFilterOperator GetLogicalFilterOperator()

Returns

Type	Description
LogicalFilterOperator

GetSecondFilterOperator()

Gets the current second filter operator (internal state).

Declaration

public FilterOperator GetSecondFilterOperator()

Returns

Type	Description
FilterOperator

GetSecondFilterValue()

Gets the current second filter value (internal state).

Declaration

public object GetSecondFilterValue()

Returns

Type	Description
object

GetSortOrder()

Gets the current sort order (internal state).

Declaration

public SortOrder? GetSortOrder()

Returns

Type	Description
SortOrder?

GetTitle()

Gets the column title.

Declaration

public string GetTitle()

Returns

Type	Description
string

HasActiveFilter()

Checks if the field has an active filter.

Declaration

public bool HasActiveFilter()

Returns

Type	Description
bool

OnInitialized()

Called when initialized.

Declaration

protected override void OnInitialized()

Overrides

ComponentBase.OnInitialized()

SetFilterOperator(FilterOperator?)

Set column filter operator.

Declaration

public void SetFilterOperator(FilterOperator? value)

Parameters

Type	Name	Description
FilterOperator?	value

SetFilterValue(object, bool)

Set column filter value.

Declaration

public void SetFilterValue(object value, bool isFirst = true)

Parameters

Type	Name	Description
object	value
bool	isFirst

SetLogicalFilterOperator(LogicalFilterOperator)

Set column second logical operator.

Declaration

public void SetLogicalFilterOperator(LogicalFilterOperator value)

Parameters

Type	Name	Description
LogicalFilterOperator	value

SetParametersAsync(ParameterView)

Set parameters as an asynchronous operation.

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Type	Name	Description
ParameterView	parameters	The parameters.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Overrides

ComponentBase.SetParametersAsync(ParameterView)

SetSecondFilterOperator(FilterOperator?)

Set column second filter operator.

Declaration

public void SetSecondFilterOperator(FilterOperator? value)

Parameters

Type	Name	Description
FilterOperator?	value

ShowUpDownForNumericFilter()

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

Declaration

public virtual bool ShowUpDownForNumericFilter()

Returns

Type	Description
bool

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable