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

RadzenPickList component.

Declaration
public RadzenPickList<TItem>()

Properties

AllowFilteringlink

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

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

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

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

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

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

Gets or sets the buttons spacing

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

ButtonJustifyContentlink

Gets or sets the buttons style

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

ButtonShadelink

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

Gets or sets the buttons size.

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

ButtonStylelink

Gets or sets the buttons style

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

ButtonVariantlink

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

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

Gets or sets the disabled property

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

EditContextlink

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

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

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

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

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

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

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

Gets or sets the orientation

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

Placeholderlink

Gets or sets the common placeholder

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

SelectAllTextlink

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

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

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

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

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

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

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

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

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.

SourceChangedlink

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

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

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

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

Gets or sets the source header

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

SourcePlaceholderlink

Gets or sets the source placeholder

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

SourceToTargetIconlink

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

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

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.

TargetChangedlink

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

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

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

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

Gets or sets the target header

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

TargetPlaceholderlink

Gets or sets the target placeholder

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

TargetToSourceIconlink

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

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

Gets or sets the source template

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

TextPropertylink

Gets or sets the text property

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

ValuePropertylink

Gets or sets the value property

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

Methods

BuildRenderTreelink

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

GetComponentCssClasslink

Declaration
protected override string GetComponentCssClass()
Returns
Type Description
string

GetSelectedSourceslink

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

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

GetSelectedTargetslink

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

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

GetStylelink

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

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 🗙