New to Telerik UI for Blazor? Start a free 30-day trial

TelerikSegmentedControl<TItem, TValue>

Class

A segmented control component that allows users to select one option from a group of related options.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

TValue

Syntax:

public class TelerikSegmentedControl<TItem, TValue> : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikSegmentedControl<TItem, TValue>

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Constructors

TelerikSegmentedControl()

public TelerikSegmentedControl()

Properties

Data

IEnumerable<TItem>

The collection of items that will be rendered inside the SegmentedControl.

[Parameter]
public IEnumerable<TItem> Data { get; set; }

DisabledField

string

Data field containing disabled identifier. Default: "Disabled".

[Parameter]
public string DisabledField { get; set; }

IconClassField

string

Data field containing icon class identifier. Default: "IconClass".

[Parameter]
public string IconClassField { get; set; }

IconField

string

Data field containing icon identifiers. Default: "Icon".

[Parameter]
public string IconField { get; set; }

ItemTemplate

RenderFragment<TItem>

A template for rendering custom item content.

[Parameter]
public RenderFragment<TItem>? ItemTemplate { get; set; }

LayoutMode

SegmentedControlLayoutMode

Specifies the layout mode of the component. Compact sizes items based on content. Stretch stretches items to fill the available horizontal space.

[Parameter]
public SegmentedControlLayoutMode LayoutMode { get; set; }

Size

string

Sets the size of the control. Default value is Medium.

[Parameter]
public string? Size { get; set; }

TextField

string

Data field containing text identifier. Default: "Text".

[Parameter]
public string TextField { get; set; }

TitleField

string

Data field containing title identifier. Default: "Title".

[Parameter]
public string TitleField { get; set; }

Value

TValue

The currently selected item.

[Parameter]
public TValue? Value { get; set; }

ValueChanged

EventCallback<TValue>

Event fired when an item is clicked and the selection changes.

[Parameter]
public EventCallback<TValue?> ValueChanged { get; set; }

ValueField

string

Data field containing value identifier. Default: "Value".

[Parameter]
public string ValueField { get; set; }

VisibleField

string

Data field containing visible identifier. Default: "Visible".

[Parameter]
public string VisibleField { get; set; }

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

public override void Dispose()

Overrides: BaseComponent.Dispose()

InitJsComponentAsync()

Task

protected Task InitJsComponentAsync()

Returns:

Task

OnAfterRenderAsync(bool)

Task

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters:firstRenderboolReturns:

Task

Overrides: BaseComponent.OnAfterRenderAsync(bool)