Widget

Widget

Windows
MacOS
Linux
On this page

Actions

Add Child to Grid

Add Child to Grid

Target is Grid Panel

Add Child to Horizontal Box

Add Child to Horizontal Box

Target is Horizontal Box

Add Child to Overlay

Add Child to Overlay

Target is Overlay

Add Child to Uniform Grid

Add Child to Uniform Grid

Target is Uniform Grid Panel

Clear Error

Clear Error

Target is Text Box

Force Layout Prepass

Forces a pre-pass. A pre-pass caches the desired size of the widget hierarchy owned by this widget. One pre-pass is already happens for every widget before Tick occurs. You only need to perform another pre-pass if you are adding child widgets this frame and want them to immediately be visible this frame.

Target is Widget

Force Volatile

Sets the forced volatility of the widget.

Target is Widget

Get All Widgets Of Class

Find all widgets of a certain class.

Target is Widget Blueprint Library

Get All Widgets with Interface

Find all widgets in the world with the specified interface. This is a slow operation, use with caution e.g. do not use every frame.

Target is Widget Blueprint Library

Get Cached Geometry

Gets the last geometry used to Tick the widget. This data may not exist yet if this call happens prior to the widget having been ticked/painted, or it may be out of date, or a frame behind.

We recommend not to use this data unless there's no other way to solve your problem. Normally in Slate we try and handle these issues by making a dependent widget part of the hierarchy, as to avoid frame behind or what are referred to as hysteresis problems, both caused by depending on geometry from the previous frame being used to advise how to layout a dependent object the current frame.

Target is Widget

Get Checked State

Returns the full current checked state.

Target is Check Box

Get Clipping

Gets the clipping state of this widget.

Target is Widget

Get Decorator by Class

Get Decorator by Class

Target is Rich Text Block

Get Desired Size

Gets the widgets desired size. NOTE: The underlying Slate widget must exist and be valid, also at least one pre-pass must have occurred before this value will be of any use.

Target is Widget

Get Game Instance

Gets the game instance associated with this UI.

Target is Widget

Get Input Event from Character Event

Get Input Event from Character Event

Target is Widget Blueprint Library

Get Input Event from Key Event

Get Input Event from Key Event

Target is Widget Blueprint Library

Get Input Event from Navigation Event

Get Input Event from Navigation Event

Target is Widget Blueprint Library

Get Input Event from Pointer Event

Get Input Event from Pointer Event

Target is Widget Blueprint Library

Get Is Enabled

Gets the current enabled status of the widget

Target is Widget

Get Is Selecting Key

Returns true if the widget is currently selecting a key, otherwise returns false.

Target is Input Key Selector

Get Key Event from Analog Input Event

Get Key Event from Analog Input Event

Target is Widget Blueprint Library

Get Owning Local Player

Gets the local player associated with this UI.

Target is Widget

Get Owning Player

Gets the player controller associated with this UI.

Target is Widget

Get Parent

Gets the parent widget

Target is Widget

Get Render Opacity

Gets the current visibility of the widget.

Target is Widget

Get Scroll Offset

Gets the scroll offset of the scrollbox in Slate Units.

Target is Scroll Box

Get View Offset Fraction

Get View Offset Fraction

Target is Scroll Box

Get Visibility

Gets the current visibility of the widget.

Target is Widget

GetText (Editable Text)

Gets the widget text

Target is Editable Text

GetText (Multi-Line Editable Text)

Get Text

Target is Editable Text (Multi-Line)

GetText (Multi-Line Text Box)

Get Text

Target is Text Box (Multi-Line)

GetText (Text Box)

Get Text

Target is Text Box

GetText (Text)

Gets the widget text

Target is Text

Has Any User Focus

Returns true if this widget is focused by any user.

Target is Widget

Has Error

Has Error

Target is Text Box

Has Keyboard Focus

Checks to see if this widget currently has the keyboard focus

Target is Widget

Has Mouse Capture

Checks to see if this widget is the current mouse captor

Target is Widget

Has Mouse Capture by User

Checks to see if this widget is the current mouse captor

Target is Widget

Has User Focus

Returns true if this widget is focused by a specific user.

Target is Widget

Has User Focused Descendants

Returns true if any descendant widget is focused by a specific user.

Target is Widget

HasAnyUserFocusedDescendants

Returns true if any descendant widget is focused by any user.

Target is Widget

Invalidate Layout and Volatility

Invalidates the widget from the view of a layout caching widget that may own this widget. will force the owning widget to redraw and cache children on the next paint pass.

Target is Widget

Is Checked

Returns true if the checkbox is currently checked

Target is Check Box

Is Hovered

Returns true if the widget is currently being hovered by a pointer device

Target is Widget

Is Pressed

Returns true if this button is currently pressed

Target is Check Box

Is Visible

Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible.

Target is Widget

Remove from Parent

Removes the widget from its parent widget. If this widget was added to the player's screen or the viewport it will also be removed from those containers.

Target is Widget

Reset Cursor

Resets the cursor to use on the widget, removing any customization for it.

Target is Widget

Scroll to End

Scrolls the ScrollBox to the bottom instantly during the next layout pass.

Target is Scroll Box

Scroll to Start

Scrolls the ScrollBox to the top instantly

Target is Scroll Box

Scroll Widget Into View

Scrolls the ScrollBox to the widget during the next layout pass.

Target is Scroll Box

Set All Navigation Rules

Sets the widget navigation rules for all directions. This can only be called on widgets that are in a widget tree.

Target is Widget

Set Allow Gamepad Keys

Sets whether or not gamepad keys are allowed in the selected key.

Target is Input Key Selector

Set Allow Modifier Keys

Sets whether or not modifier keys are allowed in the selected key.

Target is Input Key Selector

Set Checked State

Sets the checked state.

Target is Check Box

Set Clipping

Sets the clipping state of this widget.

Target is Widget

Set Column Fill

Set Column Fill

Target is Grid Panel

Set Cursor

Sets the cursor to show over the widget.

Target is Widget

Set Escape Keys

Sets escape keys.

Target is Input Key Selector

Set Hint Text

Set Hint Text

Target is Editable Text

Set Hint Text (Text Box)

Set Hint Text

Target is Text Box

Set Is Checked

Sets the checked state.

Target is Check Box

Set Is Enabled

Sets the current enabled status of the widget

Target is Widget

Set Is Password

Set Is Password

Target is Editable Text

Set Key Selection Text

Sets the text which is displayed while selecting keys.

Target is Input Key Selector

Set Keyboard Focus

Sets the focus to this widget.

Target is Widget

Set Navigation Rule

Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree.

Target is Widget

Set No Key Specified Text

Sets the text to display when no key text is available or not selecting a key.

Target is Input Key Selector

Set Render Opacity

Sets the visibility of the widget.

Target is Widget

Set Row Fill

Set Row Fill

Target is Grid Panel

Set Scroll Offset

Updates the scroll offset of the scrollbox.

Target is Scroll Box

Set Selected Key

Sets the currently selected key.

Target is Input Key Selector

Set Size

Sets the size of the spacer

Target is Spacer

Set Text

Set Text

Target is Rich Text Block

Set Text Block Visibility

Sets the visibility of the text block.

Target is Input Key Selector

Set Tool Tip

Sets a custom widget as the tooltip of the widget.

Target is Widget

Set Tool Tip Text

Sets the tooltip text for the widget.

Target is Widget

Set User Focus

Sets the focus to this widget for a specific user

Target is Widget

Set Visibility

Sets the visibility of the widget.

Target is Widget

SetError (Multi-Line Text Box)

Set Error

Target is Text Box (Multi-Line)

SetError (Text Box)

Set Error

Target is Text Box

SetIsReadOnly (Editable Text)

Set Is Read Only

Target is Editable Text

SetIsReadOnly (Multi-Line Editable Text

Set Is Read Only

Target is Editable Text (Multi-Line)

SetIsReadOnly (Multi-Line Text Box)

Set Is Read Only

Target is Text Box (Multi-Line)

SetIsReadOnly (Text Box)

Set Is Read Only

Target is Text Box

SetText (Editable Text)

Directly sets the widget text. Warning: This will wipe any binding created for the Text property!

Target is Editable Text

SetText (Multi-Line Editable Text)

Set Text

Target is Editable Text (Multi-Line)

SetText (Multi-Line Text Box)

Set Text

Target is Text Box (Multi-Line)

SetText (Text Box)

Set Text

Target is Text Box

SetText (Text)

Directly sets the widget text. Warning: This will wipe any binding created for the Text property!

Target is Text

Categories

Accessibility

Accessibility

Brush

Brush

Drag And Drop

Event Reply

Event Reply

Hardware Cursor

Hardware Cursor

Menu

Menu

Panel

Panel

Safe Zone

Safe Zone

Transform

Transform

Window Title Bar

Window Title Bar

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback