UBorder

class UMG Blueprint Since 4.5

Inherits: UObjectBase › UObjectBaseUtility › UObject › UVisual › UWidget › UPanelWidget › UContentWidget › UBorder

#include "Components/Border.h"

Description

A single-child container that renders a configurable background brush (solid color, texture, or material) with padding. Commonly used to visually frame or highlight a section of UI.

Caveats & Gotchas

• UBorder holds only one child — it derives from UContentWidget. Use UOverlay or UCanvasPanel if you need a shared background behind multiple widgets.
• BrushColor tints the background image; ContentColorAndOpacity tints the child content. They are independent multipliers applied separately.
• For animated or parameterized backgrounds, call GetDynamicMaterial() to obtain or create a UMaterialInstanceDynamic that can be driven at runtime.

Example

Set a semi-transparent dark background C++

MyBorder->SetBrushColor(FLinearColor(0.05f, 0.05f, 0.05f, 0.8f));
MyBorder->SetPadding(FMargin(8.f));

Functions (19)

Appearance 19

Appearance

19 ▼

Access	Type	Name	Description
public	function	UBorder::GetHorizontalAlignment	Returns how the border's content is aligned horizontally within the available space.
public	function	UBorder::GetPadding	Returns the padding applied between the border's edge and its content.
public	function	UBorder::GetVerticalAlignment	Returns how the border's content is aligned vertically within the available space.
public	function	UBorder::SetBrushColor	Sets the tint color applied to the border's background brush image.
public	function	UBorder::SetContentColorAndOpacity	Sets the color and opacity multiplier applied to the border's child content, without affecting the border's own background brush.
public	function	UBorder::SetHorizontalAlignment	Sets how the border's content is aligned horizontally within the space allotted to it.
public	function	UBorder::SetPadding	Sets the padding between the border's edge and the content it contains.
public	function	UBorder::SetVerticalAlignment	Sets how the border's content is aligned vertically within the space allotted to it.
public	function	UBorder::GetBrushColor	Returns the color and opacity multiplier applied to the border's background brush image.
public	function	UBorder::GetContentColorAndOpacity	Returns the current color and opacity multiplier applied to the border's content.
public	function	UBorder::GetDesiredSizeScale	Returns the current desired-size scale multiplier previously set with SetDesiredSizeScale.
public	function	UBorder::SetBrush	Replaces the border's entire background brush with a new FSlateBrush, overriding the image, tiling, and margin settings in one call.
public	function	UBorder::SetBrushFromAsset	Sets the border's background brush by copying the brush definition from a USlateBrushAsset.
public	function	UBorder::SetBrushFromMaterial	Sets the border's background brush to render the given material instead of a texture.
public	function	UBorder::SetBrushFromTexture	Sets the border's background brush to display the given 2D texture, keeping the brush's other settings unchanged.
public	function	UBorder::SetDesiredSizeScale	Scales the border's computed desired size, useful for animating things like slide-open panels without hard-coding their target size.
public	function	UBorder::SetShowEffectWhenDisabled	Sets whether the border applies the standard disabled-widget visual effect when its IsEnabled state is false.
public	function	UBorder::GetDynamicMaterial	Returns a dynamic material instance for the border's background brush, creating one from the brush's current material if it isn't already a UMaterialInstanceDynamic.
public	function	UBorder::GetShowEffectWhenDisabled	Returns whether the border darkens/desaturates itself using the standard disabled-widget effect when its enabled state is false.

Properties

Access	Type	Name	Description
public	property	UBorder::Background	The brush drawn as the border's background — controls the image, tiling, margins, and tint used to render the border.
public	property	UBorder::BackgroundDelegate	Bindable delegate backing the Background brush property binding in the UMG Designer, letting the brush be driven from a bound function each frame.
public	property	UBorder::BrushColorDelegate	Bindable delegate backing the border's BrushColor property binding in the UMG Designer, letting the background tint be driven from a bound function.
public	property	UBorder::ContentColorAndOpacityDelegate	Bindable delegate backing the border's ContentColorAndOpacity property binding in the UMG Designer, letting the content tint be driven from a bound function instead of a static value.
public	property	UBorder::OnMouseButtonDownEvent	Bindable event fired when a mouse button is pressed while the pointer is over the border, letting a bound handler consume the input and control the resulting FEventReply.
public	property	UBorder::OnMouseButtonUpEvent	Bindable event fired when a mouse button is released while the pointer is over the border, letting a bound handler consume the input and control the resulting FEventReply.
public	property	UBorder::OnMouseDoubleClickEvent	Bindable event fired when the border receives a mouse double-click.
public	property	UBorder::OnMouseMoveEvent	Bindable event fired when the mouse moves over the border.
public	property	UBorder::bFlipForRightToLeftFlowDirection	Controls whether the border's background image is horizontally flipped when the active culture's localization flow direction is right-to-left.

Version History

Introduced in: 4.5

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?