Represents a DropDown component.
Inheritance
object
ComponentBase
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbDropdown()Returns IgbDropdown
Properties
Section titled "Properties"KeepOpenOnSelect
Section titled "KeepOpenOnSelect"Inherited from: IgbComboBoxBaseLike
Whether the component dropdown should be kept open on selection. false
[Parameter]
public bool KeepOpenOnSelect { get; set; }KeepOpenOnOutsideClick
Section titled "KeepOpenOnOutsideClick"Inherited from: IgbComboBoxBaseLike
Whether the component dropdown should be kept open on clicking outside of it. false
[Parameter]
public bool KeepOpenOnOutsideClick { get; set; }DefaultEventBehavior
Section titled "DefaultEventBehavior"Inherited from: IgbBaseComboBox
Gets the components default event behavior.
protected override ControlEventBehavior DefaultEventBehavior { get; }Inherited from: IgbBaseComboBox
Sets the open state of the component. false
[Parameter]
public bool Open { get; set; }IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererControl
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }Height
Section titled "Height"Inherited from: BaseRendererControl
[Parameter]
public string Height { get; set; }Width
Section titled "Width"Inherited from: BaseRendererControl
[Parameter]
public string Width { get; set; }Class
Section titled "Class"Inherited from: BaseRendererControl
[Parameter]
public string Class { get; set; }AdditionalAttributes
Section titled "AdditionalAttributes"Inherited from: BaseRendererControl
[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }EventBehavior
Section titled "EventBehavior"Inherited from: BaseRendererControl
Gets or sets how events are bubbled up from JavaScript to Blazor.
[Parameter]
public ControlEventBehavior EventBehavior { get; set; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererControl
[Parameter]
public RenderFragment ChildContent { get; set; }RoundTripDateConversion
Section titled "RoundTripDateConversion"Inherited from: BaseRendererControl
Gets or sets what type of date conversion to make when round tripping dates.
[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }NeedsDynamicContent
Section titled "NeedsDynamicContent"Inherited from: BaseRendererControl
protected virtual bool NeedsDynamicContent { get; }UseCamelEnumValues
Section titled "UseCamelEnumValues"Inherited from: BaseRendererControl
protected virtual bool UseCamelEnumValues { get; }ContentItems
Section titled "ContentItems"public IgbDropdownItemCollection ContentItems { get; }DirectRenderElementName
Section titled "DirectRenderElementName"protected override string DirectRenderElementName { get; }Distance
Section titled "Distance"The distance from the target element.
[Parameter]
public double Distance { get; set; }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.
[Parameter]
public bool Flip { get; set; }ParentTypeName
Section titled "ParentTypeName"protected override string ParentTypeName { get; }Placement
Section titled "Placement"The preferred placement of the component around the target element.
[Parameter]
public PopoverPlacement Placement { get; set; }SameWidth
Section titled "SameWidth"Whether the dropdown's width should be the same as the target's one.
[Parameter]
public bool SameWidth { get; set; }ScrollStrategy
Section titled "ScrollStrategy"Determines the behavior of the component during scrolling of the parent container.
[Parameter]
public PopoverScrollStrategy ScrollStrategy { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"protected override bool SupportsVisualChildren { get; }public override string Type { get; }UseDirectRender
Section titled "UseDirectRender"protected override bool UseDirectRender { get; }Accessors
Section titled "Accessors"eventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererControl
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererControl
protected string _cachedSerializedContentMethods
Section titled "Methods"SetNativeElementAsync(object)
Section titled "SetNativeElementAsync(object)"Inherited from: IgbBaseComboBox
public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"Inherited from: IgbBaseComboBox
public void SetNativeElement(object element)Parameters
- element:
object
Returns any
ShowAsync()
Section titled "ShowAsync()"Inherited from: IgbBaseComboBox
Shows the component.
public Task<bool> ShowAsync()Returns any
Show()
Section titled "Show()"Inherited from: IgbBaseComboBox
public bool Show()Returns any
HideAsync()
Section titled "HideAsync()"Inherited from: IgbBaseComboBox
Hides the component.
public Task<bool> HideAsync()Returns any
Hide()
Section titled "Hide()"Inherited from: IgbBaseComboBox
public bool Hide()Returns any
ToggleAsync()
Section titled "ToggleAsync()"Inherited from: IgbBaseComboBox
Toggles the open state of the component.
public Task<bool> ToggleAsync()Returns any
Toggle()
Section titled "Toggle()"Inherited from: IgbBaseComboBox
public bool Toggle()Returns any
ResolveEventBehavior()
Section titled "ResolveEventBehavior()"Inherited from: BaseRendererControl
Resolves the components event behavior if Auto is selected.
protected ControlEventBehavior ResolveEventBehavior()Returns any
ToSpinal(string)
Section titled "ToSpinal(string)"Inherited from: BaseRendererControl
protected string ToSpinal(string value)Parameters
- value:
string
Returns any
TransformSimpleKey(string)
Section titled "TransformSimpleKey(string)"Inherited from: BaseRendererControl
protected virtual string TransformSimpleKey(string key)Parameters
- key:
string
Returns any
IsTransformedEnumValue(string)
Section titled "IsTransformedEnumValue(string)"Inherited from: BaseRendererControl
protected virtual bool IsTransformedEnumValue(string key)Parameters
- key:
string
Returns any
TransformPotentialEnumValue(string, object)
Section titled "TransformPotentialEnumValue(string, object)"Inherited from: BaseRendererControl
protected virtual object TransformPotentialEnumValue(string key, object value)Parameters
- key:
string - value:
object
Returns any
BuildSequenceInfo(int)
Section titled "BuildSequenceInfo(int)"Inherited from: BaseRendererControl
protected virtual SequenceInfo BuildSequenceInfo(int startSequence)Parameters
- startSequence:
int
Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererControl
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
TemplateContentType(string)
Section titled "TemplateContentType(string)"Inherited from: BaseRendererControl
protected Type TemplateContentType(string templateId)Parameters
- templateId:
string
Returns any
OnAfterRenderAsync(bool)
Section titled "OnAfterRenderAsync(bool)"Inherited from: BaseRendererControl
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
- firstRender:
bool
Returns any
EnsureReady()
Section titled "EnsureReady()"Inherited from: BaseRendererControl
public Task EnsureReady()Returns any
MarkPropDirty(string)
Section titled "MarkPropDirty(string)"Inherited from: BaseRendererControl
protected void MarkPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererControl
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererControl
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererControl
public string Serialize()Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
SuspendNotifications(object)
Section titled "SuspendNotifications(object)"Inherited from: BaseRendererControl
Prevents data change notifications from be propagated to the component.
public void SuspendNotifications(object dataSource)Parameters
- dataSource:
object
Returns any
ResumeNotifications(object, bool)
Section titled "ResumeNotifications(object, bool)"Inherited from: BaseRendererControl
Resumes data change notifications.
public void ResumeNotifications(object dataSource, bool notify = true)Parameters
- dataSource:
object - notify:
bool
Returns any
NotifyInsertItem(object, int, object)
Section titled "NotifyInsertItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyInsertItem(object dataSource, int index, object refItem)Parameters
- dataSource:
object - index:
int - refItem:
object
Returns any
NotifyRemoveItem(object, int, object)
Section titled "NotifyRemoveItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyRemoveItem(object dataSource, int index, object oldItem)Parameters
- dataSource:
object - index:
int - oldItem:
object
Returns any
NotifyClearItems(object)
Section titled "NotifyClearItems(object)"Inherited from: BaseRendererControl
public void NotifyClearItems(object dataSource)Parameters
- dataSource:
object
Returns any
NotifySetItem(object, int, object, object)
Section titled "NotifySetItem(object, int, object, object)"Inherited from: BaseRendererControl
public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)Parameters
- dataSource:
object - index:
int - oldItem:
object - newItem:
object
Returns any
NotifyUpdateItem(object, int, object, bool)
Section titled "NotifyUpdateItem(object, int, object, bool)"Inherited from: BaseRendererControl
public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)Parameters
- dataSource:
object - index:
int - refItem:
object - syncDataOnly:
bool
Returns any
OnRefChanged(string, object)
Section titled "OnRefChanged(string, object)"Inherited from: BaseRendererControl
public void OnRefChanged(string refName, object refValue)Parameters
- refName:
string - refValue:
object
Returns any
OnInvokeReturn(long, object)
Section titled "OnInvokeReturn(long, object)"Inherited from: BaseRendererControl
public void OnInvokeReturn(long invokeId, object returnValue)Parameters
- invokeId:
long - returnValue:
object
Returns any
Camelize(string)
Section titled "Camelize(string)"Inherited from: BaseRendererControl
protected string Camelize(string value)Parameters
- value:
string
Returns any
ToPascal(string)
Section titled "ToPascal(string)"Inherited from: BaseRendererControl
protected string ToPascal(string value)Parameters
- value:
string
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererControl
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
Dispose(bool)
Section titled "Dispose(bool)"Inherited from: BaseRendererControl
protected virtual void Dispose(bool disposing)Parameters
- disposing:
bool
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
SetPropertyValue(object, PropertyInfo, JsonElement)
Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)Parameters
- item:
object - property:
PropertyInfo - jsonElement:
JsonElement
Returns any
SetPropertyValue(object, PropertyInfo, object)
Section titled "SetPropertyValue(object, PropertyInfo, object)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, object value)Parameters
- item:
object - property:
PropertyInfo - value:
object
Returns any
Dispose()
Section titled "Dispose()"Inherited from: BaseRendererControl
public void Dispose()Returns any
ClearSelection()
Section titled "ClearSelection()"public void ClearSelection()Returns any
ClearSelectionAsync()
Section titled "ClearSelectionAsync()"Clears the current selection of the dropdown.
public Task ClearSelectionAsync()Returns any
DisconnectedCallback()
Section titled "DisconnectedCallback()"public void DisconnectedCallback()Returns any
DisconnectedCallbackAsync()
Section titled "DisconnectedCallbackAsync()"public Task DisconnectedCallbackAsync()Returns any
EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"protected override void EnsureModulesLoaded()Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
GetGroups()
Section titled "GetGroups()"public IgbDropdownGroup[] GetGroups()Returns any
GetGroupsAsync()
Section titled "GetGroupsAsync()"public Task<IgbDropdownGroup[]> GetGroupsAsync()Returns any
GetItems()
Section titled "GetItems()"public IgbDropdownItem[] GetItems()Returns any
GetItemsAsync()
Section titled "GetItemsAsync()"public Task<IgbDropdownItem[]> GetItemsAsync()Returns any
GetSelectedItem()
Section titled "GetSelectedItem()"public IgbDropdownItem? GetSelectedItem()Returns any
GetSelectedItemAsync()
Section titled "GetSelectedItemAsync()"public Task<IgbDropdownItem?> GetSelectedItemAsync()Returns any
NavigateTo(object)
Section titled "NavigateTo(object)"public IgbDropdownItem NavigateTo(object index)Parameters
- index:
object
Returns any
NavigateToAsync(object)
Section titled "NavigateToAsync(object)"Navigates to the item at the specified index. If it exists, returns the found item, otherwise - null.
public Task<IgbDropdownItem> NavigateToAsync(object index)Parameters
- index:
object
Returns any
ResolveDisplay()
Section titled "ResolveDisplay()"protected override string ResolveDisplay()Returns any
Select(object)
Section titled "Select(object)"public IgbDropdownItem Select(object value)Parameters
- value:
object
Returns any
SelectAsync(object)
Section titled "SelectAsync(object)"Selects the item with the specified value. If it exists, returns the found item, otherwise - null.
public Task<IgbDropdownItem> SelectAsync(object value)Parameters
- value:
object
Returns any
Show(object)
Section titled "Show(object)"public void Show(object target_)Parameters
- target_:
object
Returns any
ShowAsync(object)
Section titled "ShowAsync(object)"Shows the dropdown.
public Task ShowAsync(object target_)Parameters
- target_:
object
Returns any
Toggle(object)
Section titled "Toggle(object)"public void Toggle(object target_)Parameters
- target_:
object
Returns any
ToggleAsync(object)
Section titled "ToggleAsync(object)"Toggles the open state of the dropdown.
public Task ToggleAsync(object target_)Parameters
- target_:
object
Returns any
Events
Section titled "Events"Change
Section titled "Change"[Parameter]
public EventCallback<IgbDropdownItemComponentEventArgs> Change { get; set; }Closed
Section titled "Closed"[Parameter]
public EventCallback<IgbVoidEventArgs> Closed { get; set; }Closing
Section titled "Closing"[Parameter]
public EventCallback<IgbVoidEventArgs> Closing { get; set; }Opened
Section titled "Opened"[Parameter]
public EventCallback<IgbVoidEventArgs> Opened { get; set; }Opening
Section titled "Opening"[Parameter]
public EventCallback<IgbVoidEventArgs> Opening { get; set; }ChangeScript
Section titled "ChangeScript"[Parameter]
public string ChangeScript { get; set; }ClosedScript
Section titled "ClosedScript"[Parameter]
public string ClosedScript { get; set; }ClosingScript
Section titled "ClosingScript"[Parameter]
public string ClosingScript { get; set; }OpenedScript
Section titled "OpenedScript"[Parameter]
public string OpenedScript { get; set; }OpeningScript
Section titled "OpeningScript"[Parameter]
public string OpeningScript { get; set; }