Class IgbSelect

Represents a control that provides a menu of options.

Inheritance
System.Object
BaseRendererControl
IgbBaseComboBoxLike
IgbSelect
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbSelect : IgbBaseComboBoxLike, RefSink, JsonSerializable, IDisposable

Constructors

IgbSelect()

Declaration
public IgbSelect()

Properties

Autofocus

The autofocus attribute of the control.

Declaration
public bool Autofocus { get; set; }
Property Value
Type Description
System.Boolean

Blur

Declaration
public EventCallback<IgbVoidEventArgs> Blur { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

BlurScript

Declaration
public string BlurScript { get; set; }
Property Value
Type Description
System.String

Change

Declaration
public EventCallback<IgbSelectItemComponentEventArgs> Change { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbSelectItemComponentEventArgs>

ChangeScript

Declaration
public string ChangeScript { get; set; }
Property Value
Type Description
System.String

Closed

Declaration
public EventCallback<IgbVoidEventArgs> Closed { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

ClosedScript

Declaration
public string ClosedScript { get; set; }
Property Value
Type Description
System.String

Closing

Declaration
public EventCallback<IgbVoidEventArgs> Closing { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

ClosingScript

Declaration
public string ClosingScript { get; set; }
Property Value
Type Description
System.String

DirectRenderElementName

Declaration
protected override string DirectRenderElementName { get; }
Property Value
Type Description
System.String
Overrides

Disabled

The disabled state of the component

Declaration
public bool Disabled { get; set; }
Property Value
Type Description
System.Boolean

Distance

The distance of the select dropdown from its input.

Declaration
public double Distance { get; set; }
Property Value
Type Description
System.Double

Focus

Declaration
public EventCallback<IgbVoidEventArgs> Focus { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

FocusScript

Declaration
public string FocusScript { get; set; }
Property Value
Type Description
System.String

Invalid

Control the validity of the control.

Declaration
public bool Invalid { get; set; }
Property Value
Type Description
System.Boolean

Label

The label attribute of the control.

Declaration
public string Label { get; set; }
Property Value
Type Description
System.String

Opened

Declaration
public EventCallback<IgbVoidEventArgs> Opened { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

OpenedScript

Declaration
public string OpenedScript { get; set; }
Property Value
Type Description
System.String

Opening

Declaration
public EventCallback<IgbVoidEventArgs> Opening { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

OpeningScript

Declaration
public string OpeningScript { get; set; }
Property Value
Type Description
System.String

Outlined

The outlined attribute of the control.

Declaration
public bool Outlined { get; set; }
Property Value
Type Description
System.Boolean

ParentTypeName

Declaration
protected override string ParentTypeName { get; }
Property Value
Type Description
System.String
Overrides

Placeholder

The placeholder attribute of the control.

Declaration
public string Placeholder { get; set; }
Property Value
Type Description
System.String

Placement

The preferred placement of the select dropdown around its input.

Declaration
public PopoverPlacement Placement { get; set; }
Property Value
Type Description
PopoverPlacement

Required

Makes the control a required field in a form context.

Declaration
public bool Required { get; set; }
Property Value
Type Description
System.Boolean

ScrollStrategy

Determines the behavior of the component during scrolling of the parent container.

Declaration
public PopoverScrollStrategy ScrollStrategy { get; set; }
Property Value
Type Description
PopoverScrollStrategy

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UseDirectRender

Declaration
protected override bool UseDirectRender { get; }
Property Value
Type Description
System.Boolean
Overrides

Value

The value attribute of the control.

Declaration
public string Value { get; set; }
Property Value
Type Description
System.String

ValueChanged

Declaration
public EventCallback<string> ValueChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.String>

Methods

BlurComponent()

Declaration
[WCWidgetMemberName("Blur")]
public void BlurComponent()

BlurComponentAsync()

Removes focus from the component.

Declaration
[WCWidgetMemberName("Blur")]
public Task BlurComponentAsync()
Returns
Type Description
System.Threading.Tasks.Task

CheckValidity()

Declaration
public void CheckValidity()

CheckValidityAsync()

Checks for validity of the control and emits the invalid event if it invalid.

Declaration
public Task CheckValidityAsync()
Returns
Type Description
System.Threading.Tasks.Task

ClearSelection()

Declaration
public void ClearSelection()

ClearSelectionAsync()

Resets the current value and selection of the component.

Declaration
public Task ClearSelectionAsync()
Returns
Type Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

FocusComponent(IgbFocusOptions)

Declaration
[WCWidgetMemberName("Focus")]
public void FocusComponent(IgbFocusOptions options)
Parameters
Type Name Description
IgbFocusOptions options

FocusComponentAsync(IgbFocusOptions)

Sets focus on the component.

Declaration
[WCWidgetMemberName("Focus")]
public Task FocusComponentAsync(IgbFocusOptions options)
Parameters
Type Name Description
IgbFocusOptions options
Returns
Type Description
System.Threading.Tasks.Task

GetCurrentValue()

Declaration
public string GetCurrentValue()
Returns
Type Description
System.String

GetCurrentValueAsync()

Declaration
public Task<string> GetCurrentValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetGroups()

Declaration
public IgbSelectGroup[] GetGroups()
Returns
Type Description
IgbSelectGroup[]

GetGroupsAsync()

Declaration
public Task<IgbSelectGroup[]> GetGroupsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbSelectGroup[]>

GetItems()

Declaration
public IgbSelectItem[] GetItems()
Returns
Type Description
IgbSelectItem[]

GetItemsAsync()

Declaration
public Task<IgbSelectItem[]> GetItemsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbSelectItem[]>

GetSelectedItem()

Declaration
public IgbSelectItem GetSelectedItem()
Returns
Type Description
IgbSelectItem

GetSelectedItemAsync()

Declaration
public Task<IgbSelectItem> GetSelectedItemAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbSelectItem>

ReportValidity()

Declaration
public bool ReportValidity()
Returns
Type Description
System.Boolean

ReportValidityAsync()

Checks the validity of the control and moves the focus to it if it is not valid.

Declaration
public Task<bool> ReportValidityAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

ResolveDisplay()

Declaration
protected override string ResolveDisplay()
Returns
Type Description
System.String
Overrides

SetCustomValidity(String)

Declaration
public void SetCustomValidity(string message)
Parameters
Type Name Description
System.String message

SetCustomValidityAsync(String)

Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.

Declaration
public Task SetCustomValidityAsync(string message)
Parameters
Type Name Description
System.String message
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable