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

Light Theme

Dark Theme

UScrollBox

An arbitrary scrollable collection of widgets.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UPanelWidget

UScrollBox

UCommonHierarchicalScrollBox

References

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

Syntax

class UScrollBox : public UPanelWidget

Remarks

An arbitrary scrollable collection of widgets. Great for presenting 10-100 widgets in a list. Doesn't support virtualization.

Variables

	Name	Description
bool	AllowOverscroll	Disable to stop scrollbars from activating inertial overscrolling
bool	AlwaysShowScrollbar
bool	AlwaysShowScrollbarTrack
bool	BackPadScrolling	Whether to back pad this scroll box, allowing user to scroll backward until child contents are no longer visible
bool	bAllowRightClickDragScrolling	Option to disable right-click-drag scrolling
bool	bAnimateWheelScrolling	True to lerp smoothly when wheel scrolling along the scroll box
EConsumeMouseWh...	ConsumeMouseWheel	When mouse wheel events should be consumed.
float	DesiredScrollOffset	The desired scroll offset for the underlying scrollbox.
bool	FrontPadScrolling	Whether to front pad this scroll box, allowing user to scroll forward until child contents are no longer visible
TSharedPtr< cla...	MyScrollBox
EDescendantScro...	NavigationDestination	Sets where to scroll a widget to when using explicit navigation or if ScrollWhenFocusChanges is enabled
float	NavigationScrollPadding	The amount of padding to ensure exists between the item being navigated to, at the edge of the scrollbox.
FOnUserScrolled...	OnUserScrolled	Called when the scroll has changed
TEnumAsByte< EO...	Orientation	The orientation of the scrolling and stacking in the box.
FMargin	ScrollbarPadding	The margin around the scrollbar
FVector2D	ScrollbarThickness	The thickness of the scrollbar thumb
ESlateVisibilit...	ScrollBarVisibility	Visibility
EScrollWhenFocu...	ScrollWhenFocusChanges	Scroll behavior when user focus is given to a child widget
FTSTicker::FDel...	TickHandle
float	WheelScrollMultiplier	The multiplier to apply when wheel scrolling
FScrollBarStyle	WidgetBarStyle	The bar style
FScrollBoxStyle	WidgetStyle	The style

Constructors

	Name	Description
	UScrollBox ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	EndInertialScrolling()	Instantly stops any inertial scrolling that is currently in progress
float	GetScrollOffset()	Gets the scroll offset of the scrollbox in Slate Units.
float	GetScrollOffsetOfEnd()	Gets the scroll offset of the bottom of the ScrollBox in Slate Units.
float	GetViewOffsetFraction()
void	ScrollToEnd()	Scrolls the ScrollBox to the bottom instantly during the next layout pass.
void	ScrollToStart()	Scrolls the ScrollBox to the top instantly
void	ScrollWidgetIntoView ( UWidget* WidgetToFind, bool AnimateScroll, EDescendantScrollDestination Scroll..., float Padding )	Scrolls the ScrollBox to the widget during the next layout pass.
void	SetAllowOverscroll ( bool NewAllowOverscroll )
void	SetAlwaysShowScrollbar ( bool NewAlwaysShowScrollbar )
void	SetAnimateWheelScrolling ( bool bShouldAnimateWheelScrolling )
void	SetConsumeMouseWheel ( EConsumeMouseWheel NewConsumeMouseW... )
void	SetNavigationDestination ( const EDescendantScrollDestination ... )
void	SetOrientation ( EOrientation NewOrientation )
void	SetScrollbarPadding ( const FMargin& NewScrollbarPadding )
void	SetScrollbarThickness ( const FVector2D& NewScrollbarThick... )
void	SetScrollBarVisibility ( ESlateVisibility NewScrollBarVisibi... )
void	SetScrollOffset ( float NewScrollOffset )	Updates the scroll offset of the scrollbox.
void	SetScrollWhenFocusChanges ( EScrollWhenFocusChanges NewScrollWh... )
void	SetWheelScrollMultiplier ( float NewWheelScrollMultiplier )
void	SlateHandleUserScrolled ( float CurrentOffset )

Overridden from UPanelWidget

	Name	Description
UClass *	GetSlotClass()	UPanelWidget.
void	OnSlotAdded ( UPanelSlot* Slot )
void	OnSlotRemoved ( UPanelSlot* Slot )

Overridden from UWidget

	Name	Description
const FText	GetPaletteCategory()	Gets the palette category of the widget
void	OnDescendantDeselectedByDesigner ( UWidget* DescendantWidget )
void	OnDescendantSelectedByDesigner ( UWidget* DescendantWidget )
TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
void	SynchronizeProperties()	Applies all properties to the native widget if possible.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from UObject

		Name	Description
	void	PostLoad()	Begin UObject.
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

		Name	Description
	TObjectPtr< USl...	BarStyle_DEPRECATED
	TObjectPtr< USl...	Style_DEPRECATED