Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > UMG > Components > UComboBoxKey

Light Theme

Dark Theme

UComboBoxKey

The combobox allows you to display a list of options to the user in a dropdown menu for them to select one.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UComboBoxKey

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Components/ComboBoxKey.h
Include	#include "Components/ComboBoxKey.h"

Syntax

class UComboBoxKey : public UWidget

Remarks

The combobox allows you to display a list of options to the user in a dropdown menu for them to select one. Use OnGenerateConentWidgetEvent to return a custom built widget.

Variables

	Name	Description
bool	bEnableGamepadNavigationMode	When false, directional keys will change the selection.
bool	bHasDownArrow	When false, the down arrow is not generated and it is up to the API consumer to make their own visual hint that this is a drop down.
bool	bIsFocusable	When true, allows the combo box to receive keyboard focus
FMargin	ContentPadding
FSlateColor	ForegroundColor	The foreground color to pass through the hierarchy.
FTableRowStyle	ItemStyle	The item row style.
float	MaxListHeight	The max height of the combobox list that opens
FGenerateWidget...	OnGenerateContentWidget	Called when the widget is needed for the content.
FGenerateWidget...	OnGenerateItemWidget	Called when the widget is needed for the item.
FOnOpeningEvent	OnOpening	Called when the combobox is opening
FOnSelectionCha...	OnSelectionChanged	Called when a new item is selected in the combobox.
FComboBoxStyle	WidgetStyle	The combobox style.

Constructors

	Name	Description
	UComboBoxKey()

Functions

	Name	Description
void	AddOption ( FName Option )	Add an element to the option list.
void	ClearOptions()	Remove all the elements of the option list.
void	ClearSelection()	Clear the current selection.
FName	GetSelectedOption()	Get the current selected option
bool	IsOpen()	Is the combobox menu openned.
bool	RemoveOption ( FName Option )	Remove an element to the option list.
void	SetSelectedOption ( FName Option )	Set the current selected option.

Overridden from UWidget

		Name	Description
	const FText	GetPaletteCategory()	Gets the palette category of the widget

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Classes

	Name	Description
	FGenerateWidgetEvent
	FOnOpeningEvent
	FOnSelectionChangedEvent