Class IgbDropdown

Represents a DropDown component.

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

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

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

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

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

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 PopoverPlacement Placement { get; set; }
Property Value
Type Description
PopoverPlacement

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 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

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

DisconnectedCallback()

Declaration
public void DisconnectedCallback()

DisconnectedCallbackAsync()

Declaration
public Task DisconnectedCallbackAsync()
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

GetGroups()

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

GetGroupsAsync()

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

GetItems()

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

GetItemsAsync()

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

GetSelectedItem()

Declaration
public IgbDropdownItem GetSelectedItem()
Returns
Type Description
IgbDropdownItem

GetSelectedItemAsync()

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

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>

Show(Object)

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

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(Object)

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

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