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 > Slate > Widgets > Layout > SBorder

Light Theme

Dark Theme

SBorder

A border is an widget that can be used to contain other widgets.

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SBorder

SBuildProgressWidget

SButton

SHyperlink

SRichTextHyperlink

SCarouselNavigationButton::SPeekBorder

SDockTab

SLiveLinkCurveDebugUITab

SEditableTextBox

SSearchBox

SErrorText

SExpandableButton

SGraphEditorActionMenu

SGraphEditorActionMenuAI

SGraphPin

SGraphPinAI

SGraphPinBool

SGraphPinColor

SGraphPinExec

SGraphPinNameList

SGraphPinDataTableRowName

SGraphPinNum

SGraphPinInteger

SGraphPinObject

SGraphPinClass

SGraphPinString

SGraphPinStructInstance

SGraphPinVector

SGraphPinVector2D

SGraphPinVector4

SHeaderRow

SMultiLineEditableTextBox

SNiagaraGraphActionMenu

SScrollBar

SSeparator

STableRow

SAssetTagItemTableRow

SComboRow

SItemSelector::SItemSelectorItemTableRow

SMultiColumnTableRow

SAssetEntryRow

SBoneMappingListRow

SBonePairRow

SEventItem

SLiveLinkCurveDebugUIListItem

SOptionTableRow

SSceneOutlinerTreeRow

SSCS_RowWidget

	SSCS_RowWidget_ActorRoot
	SSCS_RowWidget_Separator

SMultiSelectTableRow

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Layout/SBorder.h
Include	#include "Widgets/Layout/SBorder.h"

Syntax

class SBorder : public SCompoundWidget

Remarks

A border is an widget that can be used to contain other widgets. It has a BorderImage property, which allows it to take on different appearances. Border also has a Content() slot as well as some parameters controlling the arrangement of said content.

Variables

	Name	Description
bool	bFlipForRightToLeftFlowDirection	Flips the image if the localization's flow direction is RightToLeft
TAttribute< FSl...	BorderBackgroundColor
FInvalidatableB...	BorderImage
TAttribute< FVe...	DesiredSizeScale
TAttribute< boo...	ShowDisabledEffect	Whether or not to show the disabled effect when this border is disabled

Constructors

	Name	Description
	SBorder()	Default constructor.

Functions

	Name	Description
void	ClearContent()	Clears out the content for the border
void	Construct ( const FArguments& InArgs )	Construct this widget
const TShare...	GetContent()	Gets the content for this border
void	SetBorderBackgroundColor ( const TAttribute< FSlateColor >& I... )	Sets the color and opacity of the background image of this border.
void	SetBorderImage ( const TAttribute< const FSlateBrush... )	See BorderImage attribute
void	SetContent ( TSharedRef< SWidget > InContent )	Sets the content for this border
void	SetDesiredSizeScale ( const TAttribute< FVector2D >& InD... )	Set the desired size scale multiplier
void	SetHAlign ( EHorizontalAlignment HAlign )	See HAlign argument
void	SetPadding ( const TAttribute< FMargin >& InPad... )	See Padding attribute
void	SetShowEffectWhenDisabled ( const TAttribute< bool >& InShowEf... )	See ShowEffectWhenDisabled attribute
void	SetVAlign ( EVerticalAlignment VAlign )	See VAlign argument

Overridden from SWidget

	Name	Description
FVector2D	ComputeDesiredSize ( float LayoutScaleMultiplier )	Compute the ideal size necessary to display this widget.
bool	ComputeVolatility()	Recomputes the volatility of the widget.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.

Classes

	Name	Description
	FArguments

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

Take our survey

Dismiss