Class ActionButton

Namespace

The.Web.Controls

Assembly

Instagile.Web.Client.dll

A single-row command-execution widget.

public class ActionButton : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender

Inheritance

object

ComponentBase

ActionButton

Implements

IComponent

IHandleEvent

IHandleAfterRender

Inherited Members

ComponentBase.OnInitialized()

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.OnAfterRenderAsync(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.SetParametersAsync(ParameterView)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Action

Function to run when the button is activated. It will be disabled during execution to prevent reentrancy.

[Parameter]
public EventCallback Action { get; set; }

Property Value

EventCallback

ChildContent

Text or tags to be displayed inside the button.

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

Property Value

RenderFragment

IsEnabled

True by default. If false, the button cannot be activated.

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

Property Value

bool

IsPrimary

Alter styling to indicate that this action is the default option.

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

Property Value

bool

IsSmall

Alter styling for the shorter row height used in tables.

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

Property Value

bool

Level

Optional colour scheme.

[Parameter]
public MessageLevel? Level { get; set; }

Property Value

MessageLevel?

Splat

Extra attributes for the underlying <button> tag.

[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object>? Splat { get; set; }

Property Value

Dictionary<string, object>

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied RenderTreeBuilder.

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

OnParametersSet()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

protected override void OnParametersSet()