Class RadzenComponent

Base class of Radzen Blazor components.

Inheritance

object

ComponentBase

RadzenComponent

GaugeBase

RadzenAIChat

RadzenAccordion

RadzenAccordionItem

RadzenAppearanceToggle

RadzenBadge

RadzenBreadCrumbItem

RadzenButton

RadzenCarousel

RadzenChart

RadzenCheckBoxListItem<TValue>

RadzenDataFilter<TItem>

RadzenDatePicker<TValue>

RadzenDropZoneItem<TItem>

RadzenFieldset

RadzenFormField

RadzenGoogleMap

RadzenGoogleMapMarker

RadzenGravatar

RadzenHeading

RadzenIcon

RadzenLabel

RadzenLink

RadzenLogin

RadzenMarkdown

RadzenMenuItem

RadzenPager

RadzenPanelMenuItem

RadzenPickList<TItem>

RadzenProfileMenuItem

RadzenProgressBar

RadzenRadioButtonListItem<TValue>

RadzenSSRSViewer

RadzenSankeyDiagram<TItem>

RadzenScheduler<TItem>

RadzenSelectBarItem

RadzenSidebarToggle

RadzenSpeechToTextButton

RadzenSplitButtonItem

RadzenSplitter

RadzenSplitterPane

RadzenSteps

RadzenStepsItem

RadzenTabs

RadzenTemplateForm<TItem>

RadzenText

RadzenTimeSpanPicker<TValue>

RadzenTimeline

RadzenTimelineItem

RadzenToc

RadzenTree

RadzenUpload

ValidatorBase

DataBoundFormComponent<T>

FormComponent<T>

PagedDataBoundComponent<T>

RadzenComponentWithChildren

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

Inherited Members

ComponentBase.BuildRenderTree(RenderTreeBuilder)

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSet()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(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

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenComponent : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

RadzenComponent()

Base class of Radzen Blazor components.

Declaration

public RadzenComponent()

Properties

Attributes

Specifies additional custom attributes that will be rendered by the component.

Declaration

[Parameter(CaptureUnmatchedValues = true)]
public IReadOnlyDictionary<string, object> Attributes { get; set; }

Property Value

Type	Description
IReadOnlyDictionary<string, object>	The attributes.

ContextMenu

A callback that will be invoked when the user right-clicks the component. Commonly used to display a context menu via Open(MouseEventArgs, IEnumerable<ContextMenuItem>, Action<MenuItemEventArgs>).

Declaration

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

Property Value

Type	Description
EventCallback<MouseEventArgs>

Culture

Gets or sets the culture used to display localizable data (numbers, dates). Set by default to CurrentCulture.

Declaration

[Parameter]
public CultureInfo Culture { get; set; }

Property Value

Type	Description
CultureInfo

CurrentStyle

Gets the current style as a dictionary.

Declaration

protected IDictionary<string, string> CurrentStyle { get; }

Property Value

Type	Description
IDictionary<string, string>	The current style as a dictionary of keys and values.

DefaultCulture

Gets or sets the culture set by a parent component.

Declaration

[CascadingParameter(Name = "DefaultCulture")]
public CultureInfo DefaultCulture { get; set; }

Property Value

Type	Description
CultureInfo

Element

Gets a reference to the HTML element rendered by the component.

Declaration

public ElementReference Element { get; protected set; }

Property Value

Type	Description
ElementReference

IsJSRuntimeAvailable

Gets or sets a value indicating whether JSRuntime is available.

Declaration

protected bool IsJSRuntimeAvailable { get; set; }

Property Value

Type	Description
bool

JSRuntime

Gets or sets the js runtime.

Declaration

[Inject]
protected IJSRuntime JSRuntime { get; set; }

Property Value

Type	Description
IJSRuntime	The js runtime.

MouseEnter

A callback that will be invoked when the user hovers the component. Commonly used to display a tooltip via Open(ElementReference, string, TooltipOptions).

Declaration

[Parameter]
public EventCallback<ElementReference> MouseEnter { get; set; }

Property Value

Type	Description
EventCallback<ElementReference>

MouseLeave

A callback that will be invoked when the user moves the mouse out of the component. Commonly used to hide a tooltip via Close().

Declaration

[Parameter]
public EventCallback<ElementReference> MouseLeave { get; set; }

Property Value

Type	Description
EventCallback<ElementReference>

Reference

Gets the reference for the current component.

Declaration

protected DotNetObjectReference<RadzenComponent> Reference { get; }

Property Value

Type	Description
DotNetObjectReference<RadzenComponent>	The reference.

Style

Gets or sets the inline CSS style.

Declaration

[Parameter]
public virtual string Style { get; set; }

Property Value

Type	Description
string	The style.

UniqueID

Gets or sets the unique identifier.

Declaration

public string UniqueID { get; set; }

Property Value

Type	Description
string	The unique identifier.

Visible

Gets or sets a value indicating whether this RadzenComponent is visible. Invisible components are not rendered.

Declaration

[Parameter]
public virtual bool Visible { get; set; }

Property Value

Type	Description
bool	true if visible; otherwise, false.

Methods

Debounce(Func<Task>, int)

Debounces the specified action.

Declaration

protected void Debounce(Func<Task> action, int milliseconds = 500)

Parameters

Type	Name	Description
Func<Task>	action	The action.
int	milliseconds	The milliseconds.

Dispose()

Detaches event handlers and disposes Reference.

Declaration

public virtual void Dispose()

GetComponentCssClass()

Gets the component CSS class.

Declaration

protected virtual string GetComponentCssClass()

Returns

Type	Description
string

GetCssClass()

Gets the final CSS class rendered by the component. Combines it with a class custom attribute.

Declaration

protected string GetCssClass()

Returns

Type	Description
string

GetId()

Gets the unique identifier.

Declaration

protected virtual string GetId()

Returns

Type	Description
string	Returns the id attribute (if specified) or generates a random one.

OnAfterRenderAsync(bool)

Called by the Blazor runtime.

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
bool	firstRender

Returns

Type	Description
Task

Overrides

ComponentBase.OnAfterRenderAsync(bool)

OnContextMenu(MouseEventArgs)

Raises ContextMenu.

Declaration

public virtual Task OnContextMenu(MouseEventArgs args)

Parameters

Type	Name	Description
MouseEventArgs	args	The MouseEventArgs instance containing the event data.

Returns

Type	Description
Task

OnInitialized()

Called by the Blazor runtime.

Declaration

protected override void OnInitialized()

Overrides

ComponentBase.OnInitialized()

OnMouseEnter()

Raises MouseEnter.

Declaration

public Task OnMouseEnter()

Returns

Type	Description
Task

OnMouseLeave()

Raises MouseLeave.

Declaration

public Task OnMouseLeave()

Returns

Type	Description
Task

RaiseContextMenu(MouseEventArgs)

Invoked via interop when the browser "oncontextmenu" event is raised for this component.

Declaration

[JSInvokable("RadzenComponent.RaiseContextMenu")]
public Task RaiseContextMenu(MouseEventArgs e)

Parameters

Type	Name	Description
MouseEventArgs	e	The MouseEventArgs instance containing the event data.

Returns

Type	Description
Task

RaiseMouseEnter()

Invoked via interop when the browser "onmouseenter" event is raised for this component.

Declaration

[JSInvokable("RadzenComponent.RaiseMouseEnter")]
public Task RaiseMouseEnter()

Returns

Type	Description
Task

RaiseMouseLeave()

Invoked via interop when the browser "onmouseleave" event is raised for this component.

Declaration

[JSInvokable("RadzenComponent.RaiseMouseLeave")]
public Task RaiseMouseLeave()

Returns

Type	Description
Task

SetParametersAsync(ParameterView)

Called by the Blazor runtime when parameters are set.

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Type	Name	Description
ParameterView	parameters	The parameters.

Returns

Type	Description
Task

Overrides

ComponentBase.SetParametersAsync(ParameterView)

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable