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

Light Theme

Dark Theme

USizeBox

A widget that allows you to specify the size it reports to have and desire.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UPanelWidget

UContentWidget

USizeBox

UCommonVisualAttachment

References

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

Syntax

class USizeBox : public UContentWidget

Remarks

A widget that allows you to specify the size it reports to have and desire. Not all widgets report a desired size that you actually desire. Wrapping them in a SizeBox lets you have the Size Box force them to be a particular size.

Single Child Fixed Size

Variables

	Name	Description
uint8: 1	bOverride_HeightOverride
uint8: 1	bOverride_MaxAspectRatio
uint8: 1	bOverride_MaxDesiredHeight
uint8: 1	bOverride_MaxDesiredWidth
uint8: 1	bOverride_MinAspectRatio
uint8: 1	bOverride_MinDesiredHeight
uint8: 1	bOverride_MinDesiredWidth
uint8: 1	bOverride_WidthOverride
float	HeightOverride	When specified, ignore the content's desired size and report the HeightOverride as the Box's desired height.
float	MaxAspectRatio
float	MaxDesiredHeight	When specified, will report the MaxDesiredHeight if smaller than the content's desired height.
float	MaxDesiredWidth	When specified, will report the MaxDesiredWidth if smaller than the content's desired width.
float	MinAspectRatio
float	MinDesiredHeight	When specified, will report the MinDesiredHeight if larger than the content's desired height.
float	MinDesiredWidth	When specified, will report the MinDesiredWidth if larger than the content's desired width.
TSharedPtr< SBo...	MySizeBox
float	WidthOverride	When specified, ignore the content's desired size and report the WidthOverride as the Box's desired width.

Constructors

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

Functions

	Name	Description
void	ClearHeightOverride()
void	ClearMaxAspectRatio()
void	ClearMaxDesiredHeight()
void	ClearMaxDesiredWidth()
void	ClearMinAspectRatio()
void	ClearMinDesiredHeight()
void	ClearMinDesiredWidth()
void	ClearWidthOverride()
void	SetHeightOverride ( float InHeightOverride )	When specified, ignore the content's desired size and report the HeightOverride as the Box's desired height.
void	SetMaxAspectRatio ( float InMaxAspectRatio )
void	SetMaxDesiredHeight ( float InMaxDesiredHeight )	When specified, will report the MaxDesiredHeight if smaller than the content's desired height.
void	SetMaxDesiredWidth ( float InMaxDesiredWidth )	When specified, will report the MaxDesiredWidth if smaller than the content's desired width.
void	SetMinAspectRatio ( float InMinAspectRatio )
void	SetMinDesiredHeight ( float InMinDesiredHeight )	When specified, will report the MinDesiredHeight if larger than the content's desired height.
void	SetMinDesiredWidth ( float InMinDesiredWidth )	When specified, will report the MinDesiredWidth if larger than the content's desired width.
void	SetWidthOverride ( float InWidthOverride )	When specified, ignore the content's desired size and report the WidthOverride as the Box's desired width.

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss