Class IgbDropdown

Represents a DropDown component.

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

Constructors

IgbDropdown()

Declaration
public IgbDropdown()

Properties

Change

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

ChangeScript

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

ContentItems

Declaration
public IgbDropdownItemCollection ContentItems { get; }
Property Value
Type Description
IgbDropdownItemCollection

DirectRenderElementName

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

Distance

The distance from the target element.

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

Flip

Whether the component should be flipped to the opposite side of the target once it's about to overflow the visible area. When true, once enough space is detected on its preferred side, it will flip back.

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

KeepOpenOnOutsideClick

Whether the component should be kept open on clicking outside of it.

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

KeepOpenOnSelect

Whether the dropdown should be kept open on selection.

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

Open

Sets the open state of the component.

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

ParentTypeName

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

Placement

The preferred placement of the component around the target element. @type {"top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end" | "right" | "right-start" | "right-end" | "left" | "left-start" | "left-end"}

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

PositionStrategy

Sets the component's positioning strategy.

Declaration
public DropdownPositionStrategy PositionStrategy { get; set; }
Property Value
Type Description
DropdownPositionStrategy

SameWidth

Whether the dropdown's width should be the same as the target's one.

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

ScrollStrategy

Determines the behavior of the component during scrolling the container.

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

Size

Declaration
public SizableComponentSize Size { get; set; }
Property Value
Type Description
SizableComponentSize

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

Methods

ClearSelection()

Declaration
public void ClearSelection()

ClearSelectionAsync()

Clears the current selection of the dropdown.

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

Hide()

Declaration
public void Hide()

HideAsync()

Hides the dropdown.

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

NavigateTo(Object)

Declaration
public IgbDropdownItem NavigateTo(object index)
Parameters
Type Name Description
System.Object index
Returns
Type Description
IgbDropdownItem

NavigateToAsync(Object)

Navigates to the item at the specified index. If it exists, returns the found item, otherwise - null.

Declaration
public Task<IgbDropdownItem> NavigateToAsync(object index)
Parameters
Type Name Description
System.Object index
Returns
Type Description
System.Threading.Tasks.Task<IgbDropdownItem>

ResolveDisplay()

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

Select(Object)

Declaration
public IgbDropdownItem Select(object value)
Parameters
Type Name Description
System.Object value
Returns
Type Description
IgbDropdownItem

SelectAsync(Object)

Selects the item with the specified value. If it exists, returns the found item, otherwise - null.

Declaration
public Task<IgbDropdownItem> SelectAsync(object value)
Parameters
Type Name Description
System.Object value
Returns
Type Description
System.Threading.Tasks.Task<IgbDropdownItem>

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

Show()

Declaration
public void Show()

Show(Object)

Declaration
public void Show(object target_)
Parameters
Type Name Description
System.Object target_

ShowAsync()

Shows the dropdown.

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

ShowAsync(Object)

Shows the dropdown.

Declaration
public Task ShowAsync(object target_)
Parameters
Type Name Description
System.Object target_
Returns
Type Description
System.Threading.Tasks.Task

Toggle()

Declaration
public void Toggle()

Toggle(Object)

Declaration
public void Toggle(object target_)
Parameters
Type Name Description
System.Object target_

ToggleAsync()

Toggles the open state of the dropdown.

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

ToggleAsync(Object)

Toggles the open state of the dropdown.

Declaration
public Task ToggleAsync(object target_)
Parameters
Type Name Description
System.Object target_
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable