UIGridStyleLayout

Show Deprecated
Not Creatable
Not Browsable

The base class for grid style UI layouts.

Summary

Properties

The absolute size of space being taken up by the grid layout.

READ ONLY
NOT REPLICATED

Determines the axis in which UI elements are laid out.

Determines the horizontal alignment of UI elements within the parent element.

Determines the manner in which the next UI element is chosen when being laid out.

Determines the vertical alignment of UI elements within the parent element.

Events

Methods

Properties

AbsoluteContentSize

Read Only
Not Replicated

The AbsoluteContentSize property of a UIGridStyleLayout shows how much space the elements of the grid are taking up, including any padding created by the grid. This property is particularly useful to size containers of grids such as Frames and Frame to make sure they aren't any larger than the grid itself.

It updates as soon as it's read. It won't fire a changed event immediately after the UI has changed, but if the value is read it will be up to date. A Instance.Changed event should fire on the next render step.

FillDirection

The FillDirection property determines the axis in which UI elements are laid out. Horizontal will arrange elements from left to right, while Vertical will arrange from top to bottom. To reverse elements (for instance, arrange right to left) you will need to reverse the sorting. This can be done by negating the child UI elements' GuiObject.LayoutOrder values when UIGridStyleLayout.SortOrder is set to LayoutOrder.

HorizontalAlignment

The HorizontalAlignment property determines the X-axis alignment of the laid-out grid of UI elements, much like TextLabel.TextXAlignment does with TextLabel.Text.

SortOrder

The SortOrder property determines the next UI element to be placed in a layout. For Name, a simple alphabetic sort is used on the Name property of the child UI elements. For LayoutOrder, a low-to-high sort is used on the GuiObject.LayoutOrder property of child UI elements. If two share the same GuiObject.LayoutOrder, whichever was added sooner to the parent object takes precedence. An easy way to reverse the sorting order is to negate LayoutOrder.

VerticalAlignment

The VerticalAlignment property determines the Y-axis alignment of the laid-out grid of UI elements, much like TextLabel.TextYAlignment does with TextLabel.Text.

Events

Methods