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

Light Theme

Dark Theme

UButton

The button is a click-able primitive widget to enable basic interaction, you can place any other widget inside a button to make a more complex and interesting click-able element in your UI.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UPanelWidget

UContentWidget

UButton

References

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

Syntax

class UButton : public UContentWidget

Remarks

The button is a click-able primitive widget to enable basic interaction, you can place any other widget inside a button to make a more complex and interesting click-able element in your UI.

Single Child
Clickable

Variables

	Name	Description
FLinearColor	BackgroundColor	The color multiplier for the button background
TEnumAsByte< EB...	ClickMethod	The type of mouse action required by the user to trigger the buttons 'Click'
FLinearColor	ColorAndOpacity	The color multiplier for the button content
bool	IsFocusable	Sometimes a button should only be mouse-clickable and never keyboard focusable.
TSharedPtr< SBu...	MyButton	Cached pointer to the underlying slate button owned by this UWidget
FOnButtonClicke...	OnClicked	Called when the button is clicked
FOnButtonHoverE...	OnHovered
FOnButtonPresse...	OnPressed	Called when the button is pressed
FOnButtonReleas...	OnReleased	Called when the button is released
FOnButtonHoverE...	OnUnhovered
TEnumAsByte< EB...	PressMethod	The type of keyboard/gamepad button press action required by the user to trigger the buttons 'Click'
TEnumAsByte< EB...	TouchMethod	The type of touch action required by the user to trigger the buttons 'Click'
FButtonStyle	WidgetStyle	The button style used at runtime

Constructors

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

Functions

	Name	Description
bool	IsPressed()	Returns true if the user is actively pressing the button.
void	SetBackgroundColor ( FLinearColor InBackgroundColor )	Sets the color multiplier for the button background
void	SetClickMethod ( EButtonClickMethod::Type InClickMet... )
void	SetColorAndOpacity ( FLinearColor InColorAndOpacity )	Sets the color multiplier for the button content
void	SetPressMethod ( EButtonPressMethod::Type InPressMet... )
void	SetStyle ( const FButtonStyle& InStyle )	Sets the color multiplier for the button background
void	SetTouchMethod ( EButtonTouchMethod::Type InTouchMet... )
FReply	SlateHandleClicked()	Handle the actual click event from slate and forward it on
void	SlateHandleHovered()
void	SlateHandlePressed()
void	SlateHandleReleased()
void	SlateHandleUnhovered()

Overridden from UPanelWidget

	Name	Description
UClass *	GetSlotClass()	UPanelWidget.
void	OnSlotAdded ( UPanelSlot* Slot )
void	OnSlotRemoved ( UPanelSlot* Slot )

Overridden from UWidget

	Name	Description
TSharedPtr< ...	GetAccessibleWidget()	Gets the widget that accessibility properties should synchronize to.
const FText	GetPaletteCategory()	Gets the palette category of the widget
TSharedRef< ...	RebuildDesignWidget ( TSharedRef< SWidget > Content )
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	PostLoad()	Begin UObject.

Deprecated Variables

		Name	Description
	USlateWidgetSty...	Style_DEPRECATED	The template style asset, used to seed the mutable instance of the style.

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

Take our survey

Dismiss