Navigation
API > API/Runtime > API/Runtime/UMG
A special box panel that auto-generates its entries at both design-time and runtime. Useful for cases where you can have a varying number of entries, but it isn't worth the effort or conceptual overhead to set up a list/tile view. Note that entries here are not virtualized as they are in the list views, so generally this should be avoided if you intend to scroll through lots of items.
No children can be manually added in the designer - all are auto-generated based on the given entry class.
| Name | UDynamicEntryBox |
| Type | class |
| Header File | /Engine/Source/Runtime/UMG/Public/Components/DynamicEntryBox.h |
| Include Path | #include "Components/DynamicEntryBox.h" |
Syntax
UCLASS (MinimalAPI)
class UDynamicEntryBox : public UDynamicEntryBoxBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UDynamicEntryBoxBase → UDynamicEntryBox
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| NumDesignerPreviewEntries | int32 | Components/DynamicEntryBox.h |
|
|
| OnPreviewEntryCreatedFunc | TFunction< void(UUserWidget *)> | Called whenever a preview entry is made for this widget in the designer. | Components/DynamicEntryBox.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EntryWidgetClass | TSubclassOf< UUserWidget > | The class of widget to create entries of. | Components/DynamicEntryBox.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
WidgetT * CreateEntry
(
const TSubclassOf< WidgetT >& ExplicitEntryClass |
Components/DynamicEntryBox.h | ||
TSubclassOf< UUserWidget > GetEntryWidgetClass() |
Components/DynamicEntryBox.h | ||
void RemoveEntry
(
UUserWidget* EntryWidget |
Components/DynamicEntryBox.h |
|
|
void Reset
(
bool bDeleteWidgets |
Clear out the box entries, optionally deleting the underlying Slate widgets entirely as well. | Components/DynamicEntryBox.h |
|
void Reset
(
TFunctionRef< void(WidgetT&)> ResetEntryFunc, |
Components/DynamicEntryBox.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void SynchronizeProperties () |
Applies all properties to the native widget if possible. | Components/DynamicEntryBox.h | |
virtual void ValidateCompiledDefaults
(
IWidgetCompilerLog& CompileLog |
Called at the end of Widget Blueprint compilation. | Components/DynamicEntryBox.h |