Engine

ScrollingFrame

Show Deprecated

The ScrollingFrame is a special Frame that handles all scrolling for you, with a range of different ways to customize how the scrolling works.

Summary

Properties

Properties inherited from GuiObjectProperties inherited from GuiBase2d

Methods

Methods inherited from GuiObject

Events

Events inherited from GuiObjectEvents inherited from GuiBase2d

Properties

AbsoluteCanvasSize

read only
not replicated

The size in offsets of the area that is scrollable.

AbsoluteWindowSize

read only
not replicated

The size in offsets of the frame, without the scrollbars.

AutomaticCanvasSize

read parallel

This property is used to automatically size parent UI objects based on the size of its descendants. Developers can use this property to dynamically add text and other content to a UI object at edit or run time, and the size will adjust to fit that content.

When AutomaticCanvasSize is set to an Enum.AutomaticSize value to anything other than None, ScrollingFrame.CanvasSize may resize depending on its child content.

BottomImage

read parallel

The Down image on the vertical scrollbar. Size of this is always ScrollBarThickness by ScrollBarThickness. This is also used as the image on the horizontal scroll bar.

CanvasPosition

read parallel

The location within the canvas, in offsets, that should be drawn at the top left of the scroll frame

CanvasSize

read parallel

Determines the size of the area that is scrollable. The UDim2 is calculated using the parent gui's size, similar to the regular Size property on gui objects.

ElasticBehavior

read parallel

This property determines if and when the ScrollingFrame canvas is elastic. Defaults to WhenScrollable.

HorizontalScrollBarInset

read parallel

Indicates the inset behavior of the horizontal scrolling bar.

MidImage

read parallel

The middle image on the vertical scrollbar. The size of this can vary in the y direction, but is always set as ScrollingFrame.ScrollBarThickness in the x direction. This is also used as the middle image on the horizontal scroll bar.

ScrollBarImageColor3

read parallel

Determines how a scrolling bar image is colorized. When set to white, no colorization occurs. This property is very useful for reusing image assets: If the source image is completely white with transparency, you can set the entire color of the image at once with this property.

ScrollBarImageTransparency

read parallel

Determines the alpha of a scroll bar's rendered image. A value of 0 is completely opaque, and a value of 1 is completely transparent (invisible). This property behaves similarly to GuiObject.BackgroundTransparency or BasePart.Transparency.

ScrollBarThickness

read parallel

How thick the scroll bar appears. This applies to both the horizontal and vertical scroll bars. If set to 0, no scroll bars are rendered.

ScrollingDirection

read parallel

This property determines the direction scrolling is allowed. If scrolling is disallowed in a direction, the scrollbar will not appear. Defaults to XY.

ScrollingEnabled

read parallel

Determines whether or not scrolling is allowed on the frame. If false, no scroll bars will be rendered.

TopImage

read parallel

The Up image on the vertical scrollbar. The size of this is always ScrollBarThickness by ScrollBarThickness. This is also used as the left image on the horizontal scroll bar.

VerticalScrollBarInset

read parallel

Indicates the inset behavior of the vertical scrolling bar.

VerticalScrollBarPosition

read parallel

Indicates the side that the vertical scrollbar will be located at.

Methods

Events