RadzenPickList<TItem> Class

RadzenPickList component.

Inheritance

Object

ComponentBase

RadzenComponent

RadzenPickList<TItem>

Implements

IComponent

IHandleEvent

IHandleAfterRender

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenPickList<TItem> : RadzenComponent, IComponent, IHandleEvent, IHandleAfterRender

Type Parameters

Name Description
TItem

Constructors

RadzenPickList<TItem>Link to this section

RadzenPickList component.

Declaration
public RadzenPickList<TItem>()

Properties

AllowFilteringLink to this section

Gets or sets value if filtering is allowed.

Declaration
public bool AllowFiltering { get; set; }
Property Value
Type Description
boolGets or sets value if filtering is allowed.

AllowMoveAllLink to this section

Gets or sets a value indicating whether it is allowed to move all items.

Declaration
public bool AllowMoveAll { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether it is allowed to move all items.

AllowMoveAllSourceToTargetLink to this section

Gets or sets a value indicating whether it is allowed to move all items from source to target.

Declaration
public bool AllowMoveAllSourceToTarget { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether it is allowed to move all items from source to target.

AllowMoveAllTargetToSourceLink to this section

Gets or sets a value indicating whether it is allowed to move all items from target to source.

Declaration
public bool AllowMoveAllTargetToSource { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether it is allowed to move all items from target to source.

AllowSelectAllLink to this section

Gets or sets a value indicating whether selecting all items is allowed.

Declaration
public bool AllowSelectAll { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether selecting all items is allowed.

AllowVirtualizationLink to this section

Gets or sets a value indicating whether virtualization is enabled for the source and target listboxes.

Declaration
public bool AllowVirtualization { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether virtualization is enabled for the source and target listboxes.

ButtonGapLink to this section

Gets or sets the buttons spacing

Declaration
public string ButtonGap { get; set; }
Property Value
Type Description
stringGets or sets the buttons spacing

ButtonJustifyContentLink to this section

Gets or sets the buttons style

Declaration
public JustifyContent ButtonJustifyContent { get; set; }
Property Value
Type Description
JustifyContentGets or sets the buttons style

ButtonShadeLink to this section

Gets or sets the color shade of the buttons.

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

ButtonSizeLink to this section

Gets or sets the buttons size.

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

ButtonStyleLink to this section

Gets or sets the buttons style

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

ButtonVariantLink to this section

Gets or sets the design variant of the buttons.

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

DisabledLink to this section

Gets or sets a value indicating whether component is disabled.

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

DisabledPropertyLink to this section

Gets or sets the disabled property

Declaration
public string DisabledProperty { get; set; }
Property Value
Type Description
stringGets or sets the disabled property

EditContextLink to this section

Gets or sets the edit context.

Declaration
public Forms.EditContext EditContext { get; set; }
Property Value
Type Description
Forms.EditContextGets or sets the edit context.

EmptyTemplateLink to this section

Gets or sets the empty template shown when a list has no items.

Declaration
public RenderFragment EmptyTemplate { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the empty template shown when a list has no items.

EmptyTextLink to this section

Gets or sets the empty text shown when a list has no items.

Declaration
public string EmptyText { get; set; }
Property Value
Type Description
stringGets or sets the empty text shown when a list has no items.

ItemRenderLink to this section

Gets or sets the row render callback. Use it to set row attributes.

Declaration
public Action<PickListItemRenderEventArgs<TItem>> ItemRender { get; set; }
Property Value
Type Description
Action<PickListItemRenderEventArgs<TItem>>Gets or sets the row render callback. Use it to set row attributes.

MoveLink to this section

Gets or sets the callback that is invoked when items are moved between the source and target collections. Fires after SourceChanged and TargetChanged, so the bound collections already reflect the move.

Declaration
public EventCallback<PickListMoveEventArgs<TItem>> Move { get; set; }
Property Value
Type Description
EventCallback<PickListMoveEventArgs<TItem>>Gets or sets the callback that is invoked when items are moved between the source and target collections. Fires after SourceChanged and TargetChanged, so the bound collections already reflect the move.

MoveFilteredItemsOnlyOnMoveAllLink to this section

Gets or sets a value indicating whether to move all or only avaialable after filter items.

Declaration
public bool MoveFilteredItemsOnlyOnMoveAll { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether to move all or only avaialable after filter items.

MultipleLink to this section

Gets or sets a value indicating whether multiple selection is allowed.

Declaration
public bool Multiple { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether multiple selection is allowed.

OrientationLink to this section

Gets or sets the orientation

Declaration
public Orientation Orientation { get; set; }
Property Value
Type Description
OrientationGets or sets the orientation

PlaceholderLink to this section

Gets or sets the common placeholder

Declaration
public string Placeholder { get; set; }
Property Value
Type Description
stringGets or sets the common placeholder

SelectAllTextLink to this section

Gets or sets the select all text.

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

SelectedSourceChangedLink to this section

Gets or sets the callback that is invoked when the selected source items change.

Declaration
public EventCallback<IEnumerable<TItem>> SelectedSourceChanged { get; set; }
Property Value
Type Description
EventCallback<IEnumerable<TItem>>Gets or sets the callback that is invoked when the selected source items change.

SelectedSourceToTargetIconLink to this section

Gets or sets the selected source to target icon

Declaration
public string SelectedSourceToTargetIcon { get; set; }
Property Value
Type Description
stringGets or sets the selected source to target icon

SelectedSourceToTargetTitleLink to this section

Gets or sets the selected source to target title

Declaration
public string SelectedSourceToTargetTitle { get; set; }
Property Value
Type Description
stringGets or sets the selected source to target title

SelectedTargetChangedLink to this section

Gets or sets the callback that is invoked when the selected target items change.

Declaration
public EventCallback<IEnumerable<TItem>> SelectedTargetChanged { get; set; }
Property Value
Type Description
EventCallback<IEnumerable<TItem>>Gets or sets the callback that is invoked when the selected target items change.

SelectedTargetToSourceIconLink to this section

Gets or sets the selected target to source icon

Declaration
public string SelectedTargetToSourceIcon { get; set; }
Property Value
Type Description
stringGets or sets the selected target to source icon

SelectedTargetToSourceTitleLink to this section

Gets or sets the selected target to source title

Declaration
public string SelectedTargetToSourceTitle { get; set; }
Property Value
Type Description
stringGets or sets the selected target to source title

ShowHeaderLink to this section

Gets or sets value if headers are shown.

Declaration
public bool ShowHeader { get; set; }
Property Value
Type Description
boolGets or sets value if headers are shown.

SourceLink to this section

Gets or sets the source collection.

Declaration
public IEnumerable<TItem> Source { get; set; }
Property Value
Type Description
IEnumerable<TItem>Gets or sets the source collection.

SourceAriaLabelLink to this section

Gets or sets the aria-label of the source list. Ignored when SourceHeader is rendered - the source list is labelled by the header instead.

Declaration
public string SourceAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the aria-label of the source list. Ignored when SourceHeader is rendered - the source list is labelled by the header instead.

SourceChangedLink to this section

Gets or sets the source changed.

Declaration
public EventCallback<IEnumerable<TItem>> SourceChanged { get; set; }
Property Value
Type Description
EventCallback<IEnumerable<TItem>>Gets or sets the source changed.

SourceEmptyTemplateLink to this section

Gets or sets the empty template shown when the source list has no items. Overrides EmptyTemplate.

Declaration
public RenderFragment SourceEmptyTemplate { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the empty template shown when the source list has no items. Overrides EmptyTemplate.

SourceEmptyTextLink to this section

Gets or sets the empty text shown when the source list has no items. Overrides EmptyText.

Declaration
public string SourceEmptyText { get; set; }
Property Value
Type Description
stringGets or sets the empty text shown when the source list has no items. Overrides EmptyText.

SourceExpressionLink to this section

Gets or sets the source expression used to create the FieldIdentifier for source validation.

Declaration
public Expressions.Expression<Func<IEnumerable<TItem>>> SourceExpression { get; set; }
Property Value
Type Description
Expressions.Expression<Func<IEnumerable<TItem>>>Gets or sets the source expression used to create the FieldIdentifier for source validation.

SourceHeaderLink to this section

Gets or sets the source header

Declaration
public RenderFragment SourceHeader { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the source header

SourcePlaceholderLink to this section

Gets or sets the source placeholder

Declaration
public string SourcePlaceholder { get; set; }
Property Value
Type Description
stringGets or sets the source placeholder

SourceTemplateLink to this section

Gets or sets the source template. Overrides Template.

Declaration
public RenderFragment<TItem> SourceTemplate { get; set; }
Property Value
Type Description
RenderFragment<TItem>Gets or sets the source template. Overrides Template.

SourceToTargetIconLink to this section

Gets or sets the source to target icon

Declaration
public string SourceToTargetIcon { get; set; }
Property Value
Type Description
stringGets or sets the source to target icon

SourceToTargetTitleLink to this section

Gets or sets the source to target title

Declaration
public string SourceToTargetTitle { get; set; }
Property Value
Type Description
stringGets or sets the source to target title

TargetLink to this section

Gets or sets the target collection.

Declaration
public IEnumerable<TItem> Target { get; set; }
Property Value
Type Description
IEnumerable<TItem>Gets or sets the target collection.

TargetAriaLabelLink to this section

Gets or sets the aria-label of the target list. Ignored when TargetHeader is rendered - the target list is labelled by the header instead.

Declaration
public string TargetAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the aria-label of the target list. Ignored when TargetHeader is rendered - the target list is labelled by the header instead.

TargetChangedLink to this section

Gets or sets the target changed.

Declaration
public EventCallback<IEnumerable<TItem>> TargetChanged { get; set; }
Property Value
Type Description
EventCallback<IEnumerable<TItem>>Gets or sets the target changed.

TargetEmptyTemplateLink to this section

Gets or sets the empty template shown when the target list has no items. Overrides EmptyTemplate.

Declaration
public RenderFragment TargetEmptyTemplate { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the empty template shown when the target list has no items. Overrides EmptyTemplate.

TargetEmptyTextLink to this section

Gets or sets the empty text shown when the target list has no items. Overrides EmptyText.

Declaration
public string TargetEmptyText { get; set; }
Property Value
Type Description
stringGets or sets the empty text shown when the target list has no items. Overrides EmptyText.

TargetExpressionLink to this section

Gets or sets the target expression used to create the FieldIdentifier for target validation.

Declaration
public Expressions.Expression<Func<IEnumerable<TItem>>> TargetExpression { get; set; }
Property Value
Type Description
Expressions.Expression<Func<IEnumerable<TItem>>>Gets or sets the target expression used to create the FieldIdentifier for target validation.

TargetHeaderLink to this section

Gets or sets the target header

Declaration
public RenderFragment TargetHeader { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the target header

TargetPlaceholderLink to this section

Gets or sets the target placeholder

Declaration
public string TargetPlaceholder { get; set; }
Property Value
Type Description
stringGets or sets the target placeholder

TargetTemplateLink to this section

Gets or sets the target template. Overrides Template.

Declaration
public RenderFragment<TItem> TargetTemplate { get; set; }
Property Value
Type Description
RenderFragment<TItem>Gets or sets the target template. Overrides Template.

TargetToSourceIconLink to this section

Gets or sets the target to source icon

Declaration
public string TargetToSourceIcon { get; set; }
Property Value
Type Description
stringGets or sets the target to source icon

TargetToSourceTitleLink to this section

Gets or sets the target to source title

Declaration
public string TargetToSourceTitle { get; set; }
Property Value
Type Description
stringGets or sets the target to source title

TemplateLink to this section

Gets or sets the template.

Declaration
public RenderFragment<TItem> Template { get; set; }
Property Value
Type Description
RenderFragment<TItem>Gets or sets the template.

TextPropertyLink to this section

Gets or sets the text property

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

ValuePropertyLink to this section

Gets or sets the value property

Declaration
public string ValueProperty { get; set; }
Property Value
Type Description
stringGets or sets the value property

Methods

BuildRenderTreeLink to this section

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

GetComponentCssClassLink to this section

Declaration
protected override string GetComponentCssClass()
Returns
Type Description
string

GetSelectedSourcesLink to this section

Returns a collection of TItem that are selected in the source list.

Declaration
public IEnumerable<TItem> GetSelectedSources()
Returns
Type Description
IEnumerable<TItem>

GetSelectedTargetsLink to this section

Returns a collection of TItem that are selected in the target list.

Declaration
public IEnumerable<TItem> GetSelectedTargets()
Returns
Type Description
IEnumerable<TItem>

GetStyleLink to this section

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

Declaration
protected string GetStyle()
Returns
Type Description
string

SetParametersAsyncLink to this section

Set parameters as an asynchronous operation.

Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
Type Name Description
ParameterView parameters The parameters.
Returns
Type Description
TaskA Task representing the asynchronous operation.
An error has occurred. This app may no longer respond until reloaded. Reload 🗙