Class DynamicEntryBox
A special box panel that auto-generates its entries at both design-time and runtime.
Inherited Members
Namespace: UE4.UMG
Assembly: UE4DotNet.dll
Syntax
public class DynamicEntryBox : Widget
Remarks
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.
Properties
| Improve this Doc View SourceDefaultObject
Get UE4 Default Object for this Class
Declaration
public static DynamicEntryBox DefaultObject { get; }
Property Value
Type | Description |
---|---|
DynamicEntryBox |
EntryHorizontalAlignment
Horizontal alignment of generated entries. Horizontal/Vertical/Wrap boxes only.
Declaration
public byte EntryHorizontalAlignment { get; }
Property Value
Type | Description |
---|---|
System.Byte |
EntrySizeRule
Sizing rule to apply to generated entries. Horizontal/Vertical boxes only.
Declaration
public SlateChildSize EntrySizeRule { get; }
Property Value
Type | Description |
---|---|
SlateChildSize |
EntrySpacing
The padding to apply between entries in the box.
Declaration
public Vector2D EntrySpacing { get; }
Property Value
Type | Description |
---|---|
Vector2D |
Remarks
Note horizontal boxes only use the X and vertical boxes only use Y. Value is also ignored for the first entry in the box. Wrap and Overlay types use both X and Y for spacing.
EntryVerticalAlignment
Vertical alignment of generated entries. Horizontal/Vertical/Wrap boxes only.
Declaration
public byte EntryVerticalAlignment { get; }
Property Value
Type | Description |
---|---|
System.Byte |
EntryWidgetClass
The class of widget to create entries of.
Declaration
public SubclassOf<UserWidget> EntryWidgetClass { get; }
Property Value
Type | Description |
---|---|
SubclassOf<UserWidget> |
Remarks
If natively binding this widget, use the EntryClass UPROPERTY metadata to specify the desired entry widget base class.
MaxElementSize
The maximum size of each entry in the dominant axis of the box. Vertical/Horizontal boxes only.
Declaration
public int MaxElementSize { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
NumDesignerPreviewEntries
Num Designer Preview Entries
Declaration
public int NumDesignerPreviewEntries { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
StaticClass
Get UE4 Class
Declaration
public static Class StaticClass { get; }
Property Value
Type | Description |
---|---|
Class |
Methods
| Improve this Doc View SourceBP_CreateEntry()
Creates and establishes a new dynamic entry in the box
Declaration
public UserWidget BP_CreateEntry()
Returns
Type | Description |
---|---|
UserWidget |
BP_CreateEntryOfClass(SubclassOf<UserWidget>)
Creates and establishes a new dynamic entry in the box using the specified class instead of the default.
Declaration
public UserWidget BP_CreateEntryOfClass(SubclassOf<UserWidget> EntryClass)
Parameters
Type | Name | Description |
---|---|---|
SubclassOf<UserWidget> | EntryClass |
Returns
Type | Description |
---|---|
UserWidget |
GetAllEntries(Byte)
Get All Entries
Declaration
public void GetAllEntries(byte ReturnValue)
Parameters
Type | Name | Description |
---|---|---|
System.Byte | ReturnValue |
GetNumEntries()
Get Num Entries
Declaration
public int GetNumEntries()
Returns
Type | Description |
---|---|
System.Int32 |
New(UObject, Name)
Spawn an object of this class
Declaration
public static DynamicEntryBox New(UObject obj = null, Name name = default(Name))
Parameters
Type | Name | Description |
---|---|---|
UObject | obj | |
Name | name |
Returns
Type | Description |
---|---|
DynamicEntryBox |
RemoveEntry(UserWidget)
Remove Entry
Declaration
public void RemoveEntry(UserWidget EntryWidget)
Parameters
Type | Name | Description |
---|---|---|
UserWidget | EntryWidget |
Reset(Boolean)
Clear out the box entries, optionally deleting the underlying Slate widgets entirely as well.
Declaration
public void Reset(bool bDeleteWidgets)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | bDeleteWidgets |
SetEntrySpacing(Vector2D)
Set Entry Spacing
Declaration
public void SetEntrySpacing(Vector2D InEntrySpacing)
Parameters
Type | Name | Description |
---|---|---|
Vector2D | InEntrySpacing |
Operators
| Improve this Doc View SourceImplicit(IntPtr to DynamicEntryBox)
Convert from IntPtr to UObject
Declaration
public static implicit operator DynamicEntryBox(IntPtr p)
Parameters
Type | Name | Description |
---|---|---|
System.IntPtr | p |
Returns
Type | Description |
---|---|
DynamicEntryBox |