RadzenComponent Class

RadzenComponentlink

Base class for all Radzen Blazor components providing common functionality for styling, attributes, events, and lifecycle management. All Radzen components inherit from RadzenComponent to gain standard features like visibility control, custom attributes, mouse events, and disposal. Provides foundational functionality including visibility control via Visible property, custom CSS via Style property and class via Attributes, HTML attribute passing via unmatched parameters, MouseEnter/MouseLeave/ContextMenu event callbacks, localization support for numbers/dates/text, access to the rendered HTML element via Element Reference, and proper cleanup via IDisposable pattern. Components inheriting from RadzenComponent can override GetComponentCssClass() to provide their base CSS classes and use the protected Visible property to control rendering.

Declaration

public RadzenComponent()

Attributeslink

Gets or sets a dictionary of additional HTML attributes that will be applied to the component's root element. Any attributes not explicitly defined as parameters will be captured here and rendered on the element. Use this to add data-* attributes, ARIA attributes, or any custom HTML attributes.

Declaration

public IReadOnlyDictionary<string, object> Attributes { get; set; }

Property Value

ContextMenulink

Gets or sets the callback invoked when the user right-clicks the component. Commonly used with ContextMenuService to display context menus. Receives mouse event arguments containing click position.

Declaration

public EventCallback<MouseEventArgs> ContextMenu { get; set; }

Property Value

Culturelink

Gets or sets the culture used for formatting and parsing localizable data (numbers, dates, currency). If not set, uses the DefaultCulture from a parent component or falls back to CurrentCulture.

Declaration

public Globalization.CultureInfo Culture { get; set; }

Property Value

CurrentStylelink

Gets the current style as a dictionary.

Declaration

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

Property Value

DefaultCulturelink

Gets or sets the default culture cascaded from a parent component. This allows setting a culture at the layout level that applies to all child Radzen components. Child components can override this by setting their own Culture property.

Declaration

public Globalization.CultureInfo DefaultCulture { get; set; }

Property Value

Elementlink

Gets a reference to the HTML element rendered by this component. Can be used with JavaScript interop or for programmatic DOM manipulation. The reference is only valid after the component has been rendered (after OnAfterRender).

Declaration

public ElementReference Element { get; set; }

Property Value

IsJSRuntimeAvailablelink

Gets or sets a value indicating whether JSRuntime is available.

Declaration

protected bool IsJSRuntimeAvailable { get; set; }

Property Value

JSRuntimelink

Gets or sets the js runtime.

Declaration

protected Microsoft.JSInterop.IJSRuntime JSRuntime { get; set; }

Property Value

MouseEnterlink

Gets or sets the callback invoked when the mouse pointer enters the component's bounds. Commonly used with TooltipService to display tooltips on hover. Receives the component's ElementReference as a parameter.

Declaration

public EventCallback<ElementReference> MouseEnter { get; set; }

Property Value

MouseLeavelink

Gets or sets the callback invoked when the mouse pointer leaves the component's bounds. Commonly used with TooltipService to hide tooltips when hover ends. Receives the component's ElementReference as a parameter.

Declaration

public EventCallback<ElementReference> MouseLeave { get; set; }

Property Value

Referencelink

Gets the reference for the current component.

Declaration

protected Microsoft.JSInterop.DotNetObjectReference<RadzenComponent> Reference { get; }

Property Value

Stylelink

Gets or sets the inline CSS style.

Declaration

public string Style { get; set; }

Property Value

UniqueIDlink

Gets or sets the unique identifier.

Declaration

public string UniqueID { get; set; }

Property Value

Visiblelink

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

Declaration

public bool Visible { get; set; }

Property Value

AddContextMenulink

Adds context menu for this component.

Declaration

protected virtual Task AddContextMenu()

Returns

Debouncelink

Debounces the specified action.

Declaration

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

Parameters

Disposelink

Detaches event handlers and disposes Reference.

Declaration

public virtual void Dispose()

GetComponentCssClasslink

Gets the component CSS class.

Declaration

protected virtual string GetComponentCssClass()

Returns

GetCssClasslink

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

Declaration

protected string GetCssClass()

Returns

GetIdlink

Gets the unique identifier.

Declaration

protected virtual string GetId()

Returns

OnAfterRenderAsynclink

Called by the Blazor runtime.

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Returns

OnBecameInvisiblelink

Called when the component becomes invisible. Cleans up JS interop resources without full disposal so the component can become visible again.

Declaration

protected virtual void OnBecameInvisible()

OnContextMenulink

Raises ContextMenu.

Declaration

public virtual Task OnContextMenu(MouseEventArgs args)

Parameters

Returns

OnInitializedlink

Called by the Blazor runtime.

Declaration

protected override void OnInitialized()

OnMouseEnterlink

Raises MouseEnter.

Declaration

public Task OnMouseEnter()

Returns

OnMouseLeavelink

Raises MouseLeave.

Declaration

public Task OnMouseLeave()

Returns

RaiseContextMenulink

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

Declaration

public Task RaiseContextMenu(MouseEventArgs e)

Parameters

Returns

RaiseMouseEnterlink

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

Declaration

public Task RaiseMouseEnter()

Returns

RaiseMouseLeavelink

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

Declaration

public Task RaiseMouseLeave()

Returns

SetParametersAsynclink

Called by the Blazor runtime when parameters are set.

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Returns