1. Epic GamesDeveloper
  3. UBorder

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.

Unreal Engine C++ API Reference > Runtime > UMG > Components

Inheritance Hierarchy

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

  Type Name Description
Public variable FSlateBrush Background Brush to drag as the background
Public variable FGetSlateBrush BackgroundDelegate A bindable delegate for the Brush.
Public variable bool bFlipForRightToLeftFlowDirection Flips the background image if the localization's flow direction is RightToLeft
Public variable FGetLinearColor BrushColorDelegate A bindable delegate for the BrushColor.
Public variable FGetLinearColor ContentColorAndOpacityDelegate A bindable delegate for the ContentColorAndOpacity.
Protected variable FLinearColor K2_Cache_ContentColorAndOpacity  
Protected variable TSharedPtr< SBorder > MyBorder  
Public variable FOnPointerEvent OnMouseButtonDownEvent  
Public variable FOnPointerEvent OnMouseButtonUpEvent  
Public variable FOnPointerEvent OnMouseDoubleClickEvent  
Public variable FOnPointerEvent OnMouseMoveEvent  

Constructors

  Type Name Description
Public function  

UBorder ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Const const FSlateBrush *

ConvertImage ( TAttribute< FSlateBrush > InImageAsset
)

 Translates the bound brush data and assigns it to the cached brush used by this widget.
Public function Const FLinearColor  
Public function Const FLinearColor  
Public function Const FVector2D Gets the DesiredSizeScale of this border.
Public function UMaterialInstanceDynamic *  
Public function Const EHorizontalAlignment  
Public function Const FMargin  
Public function Const bool  
Public function Const EVerticalAlignment  
Protected function FReply

HandleMouseButtonDown ( const FGeometry& Geometry,
const FPointerEvent& MouseEvent
)

  
Protected function FReply

HandleMouseButtonUp ( const FGeometry& Geometry,
const FPointerEvent& MouseEvent
)

  
Protected function FReply

HandleMouseDoubleClick ( const FGeometry& Geometry,
const FPointerEvent& MouseEvent
)

  
Protected function FReply

HandleMouseMove ( const FGeometry& Geometry,
const FPointerEvent& MouseEvent
)

  
Protected function FLinearColor  
Public function void

SetBrush ( const FSlateBrush& InBrush
)

  
Public function void

SetBrushColor ( FLinearColor InBrushColor
)

  
Public function void  
Public function void  
Public function void  
Public function void

SetContentColorAndOpacity ( FLinearColor InContentColorAndOpacity
)

  
Public function void

SetDesiredSizeScale ( FVector2D InScale
)

 Sets the DesiredSizeScale of this border.
Public function void

SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAlignment
)

  
Public function void

SetPadding ( FMargin InPadding
)

  
Public function void

SetShowEffectWhenDisabled ( bool bInShowEffectWhenDisabled
)

  
Public function void

SetVerticalAlignment ( EVerticalAlignment InVerticalAlignment
)

  

Overridden from UPanelWidget

  Type Name Description
Protected function Virtual Const UClass * UPanelWidget.
Protected function Virtual void  
Protected function Virtual void  

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Begin UObject.

Deprecated Variables

  Type Name Description
Public variable FLinearColor BrushColor Direct access to BrushColor is deprecated. Please use the getter or setter.
Public variable uint8: 1 bShowEffectWhenDisabled Direct access to bShowEffectWhenDisabled is deprecated. Please use the getter or setter.
Public variable FLinearColor ContentColorAndOpacity Direct access to ContentColorAndOpacity is deprecated. Please use the getter or setter.
Public variable FVector2D DesiredSizeScale Direct access to DesiredSizeScale is deprecated. Please use the getter or setter.
Public variable TEnumAsByte< EHorizontalAlignment > HorizontalAlignment Direct access to HorizontalAlignment is deprecated. Please use the getter or setter.
Public variable FMargin Padding Direct access to Padding is deprecated. Please use the getter or setter.
Public variable TEnumAsByte< EVerticalAlignment > VerticalAlignment Direct access to VerticalAlignment is deprecated. Please use the getter or setter.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.