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

Light Theme

Dark Theme

UBorder

A border is a container widget that can contain one child widget, providing an opportunity to surround it with a background image and adjustable padding.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UPanelWidget

UContentWidget

UBorder

References

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

Syntax

class UBorder : public UContentWidget

Remarks

A border is a container widget that can contain one child widget, providing an opportunity to surround it with a background image and adjustable padding.

Single Child
Image

Variables

	Name	Description
FSlateBrush	Background	Brush to drag as the background
FGetSlateBrush	BackgroundDelegate	A bindable delegate for the Brush.
bool	bFlipForRightToLeftFlowDirection	Flips the background image if the localization's flow direction is RightToLeft
FLinearColor	BrushColor	Color and opacity of the actual border image
FGetLinearColor	BrushColorDelegate	A bindable delegate for the BrushColor.
uint8: 1	bShowEffectWhenDisabled	Whether or not to show the disabled effect when this border is disabled
FLinearColor	ContentColorAndOpacity	Color and opacity multiplier of content in the border
FGetLinearColor	ContentColorAndOpacityDelegate	A bindable delegate for the ContentColorAndOpacity.
FVector2D	DesiredSizeScale	Scales the computed desired size of this border and its contents.
TEnumAsByte< EH...	HorizontalAlignment	The alignment of the content horizontally.
FLinearColor	K2_Cache_ContentColorAndOpacity
TSharedPtr< SBo...	MyBorder
FOnPointerEvent	OnMouseButtonDownEvent
FOnPointerEvent	OnMouseButtonUpEvent
FOnPointerEvent	OnMouseDoubleClickEvent
FOnPointerEvent	OnMouseMoveEvent
FMargin	Padding	The padding area between the slot and the content it contains.
TEnumAsByte< EV...	VerticalAlignment	The alignment of the content vertically.

Constructors

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

Functions

	Name	Description
const FSlate...	ConvertImage ( TAttribute< FSlateBrush > InImageAs... )	Translates the bound brush data and assigns it to the cached brush used by this widget.
UMaterialIns...	GetDynamicMaterial()
FReply	HandleMouseButtonDown ( const FGeometry& Geometry, const FPointerEvent& MouseEvent )
FReply	HandleMouseButtonUp ( const FGeometry& Geometry, const FPointerEvent& MouseEvent )
FReply	HandleMouseDoubleClick ( const FGeometry& Geometry, const FPointerEvent& MouseEvent )
FReply	HandleMouseMove ( const FGeometry& Geometry, const FPointerEvent& MouseEvent )
FLinearColor	K2_Gate_ContentColorAndOpacity()
void	SetBrush ( const FSlateBrush& InBrush )
void	SetBrushColor ( FLinearColor InBrushColor )
void	SetBrushFromAsset ( USlateBrushAsset* Asset )
void	SetBrushFromMaterial ( UMaterialInterface* Material )
void	SetBrushFromTexture ( UTexture2D* Texture )
void	SetContentColorAndOpacity ( FLinearColor InContentColorAndOpaci... )
void	SetDesiredSizeScale ( FVector2D InScale )	Sets the DesireSizeScale of this border.
void	SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAl... )
void	SetPadding ( FMargin InPadding )
void	SetVerticalAlignment ( EVerticalAlignment InVerticalAlignm... )

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 )

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
	void	PostLoad()	Begin UObject.

Deprecated Variables

		Name	Description
	USlateBrushAsse...	Brush_DEPRECATED	Image to use for the border

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

Take our survey

Dismiss