Class ScrollBox

An arbitrary scrollable collection of widgets. Great for presenting 10-100 widgets in a list. Doesn't support virtualization.

Inheritance
System.Object
UObject
Visual
Widget
PanelWidget
ScrollBox
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.UMG
Assembly: UE4DotNet.dll
Syntax
public class ScrollBox : PanelWidget

Properties

| Improve this Doc View Source

AllowOverscroll

Declaration
public bool AllowOverscroll { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

AlwaysShowScrollbar

Declaration
public bool AlwaysShowScrollbar { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bAllowRightClickDragScrolling

Declaration
public bool bAllowRightClickDragScrolling { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static ScrollBox DefaultObject { get; }
Property Value
Type Description
ScrollBox
| Improve this Doc View Source

NavigationScrollPadding

The amount of padding to ensure exists between the item being navigated to, at the edge of the scrollbox.

Declaration
public float NavigationScrollPadding { get; }
Property Value
Type Description
System.Single
Remarks

Use this if you want to ensure there's a preview of the next item the user could scroll to.

| Improve this Doc View Source

Orientation

The orientation of the scrolling and stacking in the box.

Declaration
public byte Orientation { get; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

ScrollbarThickness

Scrollbar Thickness

Declaration
public Vector2D ScrollbarThickness { get; }
Property Value
Type Description
Vector2D
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

WidgetBarStyle

The bar style

Declaration
public ScrollBarStyle WidgetBarStyle { get; set; }
Property Value
Type Description
ScrollBarStyle
| Improve this Doc View Source

WidgetStyle

The style

Declaration
public ScrollBoxStyle WidgetStyle { get; set; }
Property Value
Type Description
ScrollBoxStyle

Methods

| Improve this Doc View Source

GetScrollOffset()

Gets the scroll offset of the scrollbox in Slate Units.

Declaration
public float GetScrollOffset()
Returns
Type Description
System.Single
| Improve this Doc View Source

GetViewOffsetFraction()

Get View Offset Fraction

Declaration
public float GetViewOffsetFraction()
Returns
Type Description
System.Single
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static ScrollBox New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
ScrollBox
| Improve this Doc View Source

ScrollToEnd()

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

Declaration
public void ScrollToEnd()
| Improve this Doc View Source

ScrollToStart()

Scrolls the ScrollBox to the top instantly

Declaration
public void ScrollToStart()
| Improve this Doc View Source

ScrollWidgetIntoView(Widget, Boolean, EDescendantScrollDestination)

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

Declaration
public void ScrollWidgetIntoView(Widget WidgetToFind, bool AnimateScroll, EDescendantScrollDestination ScrollDestination)
Parameters
Type Name Description
Widget WidgetToFind
System.Boolean AnimateScroll
EDescendantScrollDestination ScrollDestination
| Improve this Doc View Source

SetAllowOverscroll(Boolean)

Set Allow Overscroll

Declaration
public void SetAllowOverscroll(bool NewAllowOverscroll)
Parameters
Type Name Description
System.Boolean NewAllowOverscroll
| Improve this Doc View Source

SetAlwaysShowScrollbar(Boolean)

Set Always Show Scrollbar

Declaration
public void SetAlwaysShowScrollbar(bool NewAlwaysShowScrollbar)
Parameters
Type Name Description
System.Boolean NewAlwaysShowScrollbar
| Improve this Doc View Source

SetOrientation(Byte)

Set Orientation

Declaration
public void SetOrientation(byte NewOrientation)
Parameters
Type Name Description
System.Byte NewOrientation
| Improve this Doc View Source

SetScrollbarThickness(Vector2D)

Set Scrollbar Thickness

Declaration
public void SetScrollbarThickness(Vector2D NewScrollbarThickness)
Parameters
Type Name Description
Vector2D NewScrollbarThickness
| Improve this Doc View Source

SetScrollBarVisibility(ESlateVisibility)

Set Scroll Bar Visibility

Declaration
public void SetScrollBarVisibility(ESlateVisibility NewScrollBarVisibility)
Parameters
Type Name Description
ESlateVisibility NewScrollBarVisibility
| Improve this Doc View Source

SetScrollOffset(Single)

Updates the scroll offset of the scrollbox.

Declaration
public void SetScrollOffset(float NewScrollOffset)
Parameters
Type Name Description
System.Single NewScrollOffset
Remarks

@param NewScrollOffset is in Slate Units.

Operators

| Improve this Doc View Source

Implicit(IntPtr to ScrollBox)

Convert from IntPtr to UObject

Declaration
public static implicit operator ScrollBox(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
ScrollBox