Class MudTHeadRow

Namespace

MudBlazor

Assembly

MudBlazor.dll

A header row displayed at the top of a MudTable<T> and each group.

public class MudTHeadRow : MudComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IMudStateHasChanged, IDisposable

Inheritance

object

ComponentBase

ComponentBaseWithState

MudComponentBase

MudTHeadRow

Implements

IComponent

IHandleEvent

IHandleAfterRender

IMudStateHasChanged

IDisposable

Inherited Members

MudComponentBase.OnAfterRender(bool)

MudComponentBase.Logger

MudComponentBase.Class

MudComponentBase.Style

MudComponentBase.Tag

MudComponentBase.UserAttributes

MudComponentBase.IsJSRuntimeAvailable

MudComponentBase.FieldId

ComponentBaseWithState.OnInitialized()

ComponentBaseWithState.SetParametersAsync(ParameterView)

ComponentBaseWithState.OnParametersSet()

ComponentBaseWithState.CreateRegisterScope()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

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()

Extension Methods

EventUtil.AsNonRenderingEventHandler(ComponentBase, Action)

EventUtil.AsNonRenderingEventHandler(ComponentBase, Func<Task>)

EventUtil.AsNonRenderingEventHandler<TValue>(ComponentBase, Action<TValue>)

EventUtil.AsNonRenderingEventHandler<TValue>(ComponentBase, Func<TValue, Task>)

ComponentBaseWithStateExtensions.GetState<T>(ComponentBaseWithState, string)

ComponentBaseWithStateExtensions.GetState<TComponent, T>(TComponent, Func<TComponent, T>, string?)

ObjectExtensions.As<T>(object?)

Constructors

MudTHeadRow()

public MudTHeadRow()

Properties

Checkable

Shows a checkbox which selects or deselects every row in the group.

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

Property Value

bool

Remarks

Defaults to false.

Checked

The state of the checkbox when Checkable is true.

public bool? Checked { get; set; }

Property Value

bool?

ChildContent

The content within this header row.

[Parameter]
public RenderFragment? ChildContent { get; set; }

Property Value

RenderFragment

Classname

protected string Classname { get; }

Property Value

string

Context

The current state of the MudTable<T> containing this header.

[CascadingParameter]
public TableContext? Context { get; set; }

Property Value

TableContext

Expandable

Shows an additional left and right margin when the parent group is expandable.

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

Property Value

bool

Remarks

Defaults to false. Managed automatically by table groups.

IgnoreCheckbox

Hides the extra column displayed when MultiSelection is true.

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

Property Value

bool

Remarks

Defaults to false.

IgnoreEditable

Hides the extra column displayed when Editable is true.

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

Property Value

bool

Remarks

Defaults to false.

OnRowClick

Occurs when this header row is clicked.

[Parameter]
public EventCallback<MouseEventArgs> OnRowClick { get; set; }

Property Value

EventCallback<MouseEventArgs>

SelectionChangeable

Prevents the change of the current selection of rows in the group.

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

Property Value

bool

Remarks

Defaults to true. Requires Checkable to be true.

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

Dispose()

Releases resources used by this header row.

public void Dispose()

OnInitializedAsync()

protected override Task OnInitializedAsync()

Returns

Task

SetChecked(bool?, bool)

Sets Checked to the specified value.

public void SetChecked(bool? checkedState, bool notify)

Parameters

checkedState bool?

The new checked state.

notify bool

When true, the table's OnHeaderCheckboxClicked(bool) event occurs.