RadzenSplitButton Class

A split button component that combines a primary action button with a dropdown menu of additional related actions. RadzenSplitButton displays a main button with a small dropdown toggle, allowing quick access to a default action while providing alternatives. Ideal when you have a primary action and several related alternatives. The left side executes the default action, the right side opens a menu of options. Common examples include Save (with options: Save As, Save and Close), Download (with options: Download PDF, Download Excel, Download CSV), and Send (with options: Send Now, Schedule Send, Save Draft). Features main action triggered by clicking the left portion, additional options in a dropdown from the right toggle, ButtonStyle/Variant/Shade/Size for consistent appearance, optional icon on the main button, and keyboard navigation (Arrow keys, Enter, Escape) for menu navigation. Menu items are defined using RadzenSplitButtonItem components as child content.

Inheritance

Object

ComponentBase

RadzenComponent

RadzenComponentWithChildren

RadzenSplitButton

Implements

IComponent

IHandleEvent

IHandleAfterRender

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenSplitButton : RadzenComponentWithChildren, IComponent, IHandleEvent, IHandleAfterRender

Examples

Basic split button:

<RadzenSplitButton Text="Save" Icon="save" Click=@OnSave>
    <ChildContent>
        <RadzenSplitButtonItem Text="Save and Close" Value="save-close" />
        <RadzenSplitButtonItem Text="Save As..." Value="save-as" />
    </ChildContent>
</RadzenSplitButton>
@code {
    void OnSave(RadzenSplitButtonItem item)
    {
        Console.WriteLine(item?.Value ?? "primary");
    }
}

Download split button with variants:

<RadzenSplitButton Text="Download" Icon="download" ButtonStyle="ButtonStyle.Success" Click=@Download>
    <ChildContent>
        <RadzenSplitButtonItem Text="Download PDF" Icon="picture_as_pdf" Value="pdf" />
        <RadzenSplitButtonItem Text="Download Excel" Icon="table_view" Value="excel" />
        <RadzenSplitButtonItem Text="Download CSV" Icon="description" Value="csv" />
    </ChildContent>
</RadzenSplitButton>

Constructors

RadzenSplitButtonlink

A split button component that combines a primary action button with a dropdown menu of additional related actions. RadzenSplitButton displays a main button with a small dropdown toggle, allowing quick access to a default action while providing alternatives. Ideal when you have a primary action and several related alternatives. The left side executes the default action, the right side opens a menu of options. Common examples include Save (with options: Save As, Save and Close), Download (with options: Download PDF, Download Excel, Download CSV), and Send (with options: Send Now, Schedule Send, Save Draft). Features main action triggered by clicking the left portion, additional options in a dropdown from the right toggle, ButtonStyle/Variant/Shade/Size for consistent appearance, optional icon on the main button, and keyboard navigation (Arrow keys, Enter, Escape) for menu navigation. Menu items are defined using RadzenSplitButtonItem components as child content.

Declaration
public RadzenSplitButton()

Properties

AlwaysOpenPopuplink

Gets or sets the value indication behaviour to always open popup with item on click and not invoke Click event.

Declaration
public bool AlwaysOpenPopup { get; set; }
Property Value
Type Description
boolGets or sets the value indication behaviour to always open popup with item on click and not invoke Click event.

BusyTextlink

Gets or sets the busy text.

Declaration
public string BusyText { get; set; }
Property Value
Type Description
stringGets or sets the busy text.

ButtonAriaLabellink

Gets or sets the add button aria-label attribute.

Declaration
public string ButtonAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the add button aria-label attribute.

ButtonContentlink

Gets or sets the child content.

Declaration
public RenderFragment ButtonContent { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the child content.

ButtonStylelink

Gets or sets the button style.

Declaration
public ButtonStyle ButtonStyle { get; set; }
Property Value
Type Description
ButtonStyleGets or sets the button style.

ButtonTypelink

Gets or sets the type of the button.

Declaration
public ButtonType ButtonType { get; set; }
Property Value
Type Description
ButtonTypeGets or sets the type of the button.

Clicklink

Gets or sets the click callback.

Declaration
public EventCallback<RadzenSplitButtonItem> Click { get; set; }
Property Value
Type Description
EventCallback<RadzenSplitButtonItem>Gets or sets the click callback.

Disabledlink

Gets or sets a value indicating whether this RadzenSplitButton is disabled.

Declaration
public bool Disabled { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether this RadzenSplitButton is disabled.

DropDownIconlink

Gets or sets the icon of the drop down.

Declaration
public string DropDownIcon { get; set; }
Property Value
Type Description
stringGets or sets the icon of the drop down.

Iconlink

Gets or sets the icon.

Declaration
public string Icon { get; set; }
Property Value
Type Description
stringGets or sets the icon.

IconColorlink

Gets or sets the icon color.

Declaration
public string IconColor { get; set; }
Property Value
Type Description
stringGets or sets the icon color.

Imagelink

Gets or sets the image.

Declaration
public string Image { get; set; }
Property Value
Type Description
stringGets or sets the image.

ImageAlternateTextlink

Gets or sets the text.

Declaration
public string ImageAlternateText { get; set; }
Property Value
Type Description
stringGets or sets the text.

IsBusylink

Gets or sets a value indicating whether this instance busy text is shown.

Declaration
public bool IsBusy { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether this instance busy text is shown.

IsDisabledlink

Gets a value indicating whether this instance is disabled.

Declaration
public bool IsDisabled { get; }
Property Value
Type Description
boolGets a value indicating whether this instance is disabled.

OpenAriaLabellink

Gets or sets the open button aria-label attribute.

Declaration
public string OpenAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the open button aria-label attribute.

Shadelink

Gets or sets the color shade of the button.

Declaration
public Shade Shade { get; set; }
Property Value
Type Description
ShadeGets or sets the color shade of the button.

Sizelink

Gets or sets the size.

Declaration
public ButtonSize Size { get; set; }
Property Value
Type Description
ButtonSizeGets or sets the size.

TabIndexlink

Gets or sets the index of the tab.

Declaration
public int TabIndex { get; set; }
Property Value
Type Description
intGets or sets the index of the tab.

Textlink

Gets or sets the text.

Declaration
public string Text { get; set; }
Property Value
Type Description
stringGets or sets the text.

Variantlink

Gets or sets the design variant of the button.

Declaration
public Variant Variant { get; set; }
Property Value
Type Description
VariantGets or sets the design variant of the button.

Methods

AddItemlink

Adds the item.

Declaration
public void AddItem(RadzenSplitButtonItem item)
Parameters
Type Name Description
RadzenSplitButtonItem item The item.

BuildRenderTreelink

Declaration
protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)
Parameters
Type Name Description
Rendering.RenderTreeBuilder __builder

Closelink

Closes this instance popup.

Declaration
public void Close()

Disposelink

Declaration
public override void Dispose()

GetComponentCssClasslink

Declaration
protected override string GetComponentCssClass()
Returns
Type Description
string

OnClicklink

Handles the click event.

Declaration
public Task OnClick(MouseEventArgs args)
Parameters
Type Name Description
MouseEventArgs args The MouseEventArgs instance containing the event data.
Returns
Type Description
Task

RemoveItemlink

Removes the item.

Declaration
public void RemoveItem(RadzenSplitButtonItem item)
Parameters
Type Name Description
RadzenSplitButtonItem item The item.
An error has occurred. This app may no longer respond until reloaded. Reload 🗙