Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 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.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SBorder

SButton

SHyperlink

SRichTextHyperlink

SPrimaryButton

SSimpleButton

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

SNotificationBackground

SScrollBar

SSeparator

STableRow

SWarningOrErrorBox

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.

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
FSlateColor	GetBorderBackgroundColor()
TSlateAttrib...	GetBorderBackgroundColorAttribute()
const FSlate...	GetBorderImage()
TSlateAttrib...	GetBorderImageAttribute()
const TShare...	GetContent()	Gets the content for this border
FVector2D	GetDesiredSizeScale()
TSlateAttrib...	GetDesiredSizeScaleAttribute()
bool	GetShowDisabledEffect()
TSlateAttrib...	GetShowDisabledEffectAttribute()
void	SetBorderBackgroundColor ( TAttribute< FSlateColor > InColorAn... )	Sets the color and opacity of the background image of this border.
void	SetBorderImage ( TAttribute< const FSlateBrush*... )	See BorderImage attribute
void	SetContent ( TSharedRef< SWidget > InContent )	Sets the content for this border
void	SetDesiredSizeScale ( TAttribute< FVector2D > InDesiredSi... )	Set the desired size scale multiplier
void	SetHAlign ( EHorizontalAlignment HAlign )	See HAlign argument
void	SetPadding ( TAttribute< FMargin > InPadding )	See Padding attribute
void	SetShowEffectWhenDisabled ( TAttribute< bool > InShowEffectWhen... )	See ShowEffectWhenDisabled attribute
void	SetVAlign ( EVerticalAlignment VAlign )	See VAlign argument
const FSlate...	StaticWidgetClass()

Overridden from SWidget

		Name	Description
	FVector2D	ComputeDesiredSize ( float LayoutScaleMultiplier )	Compute the ideal size necessary to display this 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.

Overridden from FSlateControlledConstruction

		Name	Description
	const FSlate...	GetWidgetClass()

Classes

	Name	Description
	FArguments

Typedefs

Name	Description
PrivateParentType
PrivateThisType
Super
ThisClass

Deprecated Variables

	Name	Description
TSlateDeprecate...	BorderBackgroundColor	Direct access to BorderBackgroundColor is now deprecated. Use the setter or getter.
FInvalidatableB...	BorderImage	Direct access to BorderImage is now deprecated. Use the setter or getter.
TSlateDeprecate...	DesiredSizeScale	Direct access to DesiredSizeScale is now deprecated. Use the setter or getter.
TSlateDeprecate...	ShowDisabledEffect	Direct access to ShowDisabledEffect is now deprecated. Use the setter or getter.