API:Class/UIPageLayout


ExplorerImageIndex26.pngUIPageLayout : Object Icon.pngUIGridStyleLayout : Object Icon.pngUILayout : Object Icon.pngUIComponent : Object Icon.pngUIBase : Object Icon.pngInstance

Creates a paged viewing window, like the home screen of a mobile device. You can use a UIPageLayout by parenting it to a GuiObject. The UIPageLayout will then apply itself to all of its GuiObject siblings.

Properties

PropertiesmemberhiddenProperties [toggle]

boolAnimated

Whether or not to animate transitions between pages.

|RMD member="API:Class/UIPageLayout/Animated"|Whether or not to animate transitions between pages.|/RMD|
boolCircular

Whether or not the page layout wraps around at the ends.

|RMD member="API:Class/UIPageLayout/Circular"|Whether or not the page layout wraps around at the ends.|/RMD|
Ref<GuiObject>CurrentPage [readonly]

The page that is either currently being displayed or is the target of the current animation.

|RMD member="API:Class/UIPageLayout/CurrentPage"|The page that is either currently being displayed or is the target of the current animation.|/RMD|
EasingDirectionEasingDirection

The easing direction to use when performing an animation.

|RMD member="API:Class/UIPageLayout/EasingDirection"|The easing direction to use when performing an animation.|/RMD|
EasingStyleEasingStyle

The easing style to use when performing an animation.

|RMD member="API:Class/UIPageLayout/EasingStyle"|The easing style to use when performing an animation.|/RMD|
boolGamepadInputEnabled

No documentation found.

|RMD member="API:Class/UIPageLayout/GamepadInputEnabled"|No documentation found.|/RMD|
UDimPadding

Determines the amount that pages are separated from each other by.

|RMD member="API:Class/UIPageLayout/Padding"|Determines the amount that pages are separated from each other by.|/RMD|
boolScrollWheelInputEnabled

No documentation found.

|RMD member="API:Class/UIPageLayout/ScrollWheelInputEnabled"|No documentation found.|/RMD|
boolTouchInputEnabled

No documentation found.

|RMD member="API:Class/UIPageLayout/TouchInputEnabled"|No documentation found.|/RMD|
floatTweenTime

The length of the animation.

|RMD member="API:Class/UIPageLayout/TweenTime"|The length of the animation.|/RMD|
Whether or not to animate transitions between pages.
Whether or not the page layout wraps around at the ends.
CurrentPage [readonly]
The page that is either currently being displayed or is the target of the current animation.
The easing direction to use when performing an animation.
The easing style to use when performing an animation.
No documentation found.
Determines the amount that pages are separated from each other by.
No documentation found.
No documentation found.
The length of the animation.
Inherited from Object Icon.pngUIGridStyleLayout:
Vector2AbsoluteContentSize [readonly]

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

|RMD member="API:Class/UIGridStyleLayout/AbsoluteContentSize"|The absolute size of space being taken up by the grid layout.|/RMD|
FillDirectionFillDirection

Determines which direction to fill the grid. Can be Horizontal or Vertical.

|RMD member="API:Class/UIGridStyleLayout/FillDirection"|Determines which direction to fill the grid. Can be Horizontal or Vertical.|/RMD|
HorizontalAlignmentHorizontalAlignment

Determines how grid is placed within it's parent's container in the x direction. Can be Left, Center, or Right.

|RMD member="API:Class/UIGridStyleLayout/HorizontalAlignment"|Determines how grid is placed within it's parent's container in the x direction. Can be Left, Center, or Right.|/RMD|
SortOrderSortOrder

SortOrder determines how we decide which element to place next. The value can be Name or LayoutOrder. Name is an alphabetical sort. LayoutOrder sorts using the LayoutOrder property on each element.

|RMD member="API:Class/UIGridStyleLayout/SortOrder"|SortOrder determines how we decide which element to place next. The value can be Name or LayoutOrder. Name is an alphabetical sort. LayoutOrder sorts using the LayoutOrder property on each element.|/RMD|
VerticalAlignmentVerticalAlignment

Determines how grid is placed within it's parent's container in the y direction.

|RMD member="API:Class/UIGridStyleLayout/VerticalAlignment"|Determines how grid is placed within it's parent's container in the y direction.|/RMD|
The absolute size of space being taken up by the grid layout.
Determines which direction to fill the grid. Can be Horizontal or Vertical.
Determines how grid is placed within it's parent's container in the x direction. Can be Left, Center, or Right.
SortOrder determines how we decide which element to place next. The value can be Name or LayoutOrder. Name is an alphabetical sort. LayoutOrder sorts using the LayoutOrder property on each element.
Determines how grid is placed within it's parent's container in the y direction.
Inherited from Object Icon.pngInstance:
boolArchivable

Determines if an object can be Clone or saved to file.

|RMD member="API:Class/Instance/Archivable"|Determines if an object can be Clone or saved to file.|/RMD|
stringClassName [readonly]

The unique name of this type of Instance.

|RMD member="API:Class/Instance/ClassName"|The unique name of this type of Instance.|/RMD|
stringName

A non-unique identifier for the object.

|RMD member="API:Class/Instance/Name"|A non-unique identifier for the object.|/RMD|
Ref<Instance>Parent

The hierarchical parent of the object.

|RMD member="API:Class/Instance/Parent"|The hierarchical parent of the object.|/RMD|
intDataCost [LocalUserSecurity] [deprecated] [readonly]

Deprecated. Do not use.

|RMD member="API:Class/Instance/DataCost"|Deprecated. Do not use.|/RMD|
boolRobloxLocked [PluginSecurity]

If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.

|RMD member="API:Class/Instance/RobloxLocked"|If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.|/RMD|
boolarchivable [deprecated] [hidden]

Deprecated in favor of Archivable.

|RMD member="API:Class/Instance/archivable"|Deprecated in favor of Archivable.|/RMD|
stringclassName [deprecated] [readonly]

Deprecated in favor of ClassName.

|RMD member="API:Class/Instance/className"|Deprecated in favor of ClassName.|/RMD|
Determines if an object can be Clone or saved to file.
ClassName [readonly]
The unique name of this type of Instance.
A non-unique identifier for the object.
The hierarchical parent of the object.
DataCost [LocalUserSecurity] [deprecated] [readonly]
Deprecated. Do not use.
RobloxLocked [PluginSecurity]
If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.
archivable [deprecated] [hidden]
Deprecated in favor of Archivable.
className [deprecated] [readonly]
Deprecated in favor of ClassName.

Functions

FunctionsmemberhiddenFunctions [toggle]

voidJumpTo ( GuiObject page )

If the page is in the UIPageLayout, then it sets CurrentPage to it and animates to it. If the circular layout is enabled, it will take the shortest path to this page.

|RMD member="API:Class/UIPageLayout/JumpTo"|If the page is in the UIPageLayout, then it sets CurrentPage to it and animates to it. If the circular layout is enabled, it will take the shortest path to this page.|/RMD|
voidJumpToIndex ( int index )

If the index is >= 0 and less than the size of the layout, this method acts like JumpTo. If it's out of bounds and circular is set, it will animate the full distance between the in-bounds index of CurrentPage and the new index.

|RMD member="API:Class/UIPageLayout/JumpToIndex"|If the index is >= 0 and less than the size of the layout, this method acts like JumpTo. If it's out of bounds and circular is set, it will animate the full distance between the in-bounds index of CurrentPage and the new index.|/RMD|
voidNext ( )

Sets CurrentPage to the page after the current page and animates to it, or does nothing if there isn't a next page.

|RMD member="API:Class/UIPageLayout/Next"|Sets CurrentPage to the page after the current page and animates to it, or does nothing if there isn't a next page.|/RMD|
voidPrevious ( )

Sets CurrentPage to the page before the current page and animates to it, or does nothing if there isn't a previous page.

|RMD member="API:Class/UIPageLayout/Previous"|Sets CurrentPage to the page before the current page and animates to it, or does nothing if there isn't a previous page.|/RMD|
JumpTo ( GuiObject page )
If the page is in the UIPageLayout, then it sets CurrentPage to it and animates to it. If the circular layout is enabled, it will take the shortest path to this page.
JumpToIndex ( int index )
If the index is >= 0 and less than the size of the layout, this method acts like JumpTo. If it's out of bounds and circular is set, it will animate the full distance between the in-bounds index of CurrentPage and the new index.
Next ( )
Sets CurrentPage to the page after the current page and animates to it, or does nothing if there isn't a next page.
Sets CurrentPage to the page before the current page and animates to it, or does nothing if there isn't a previous page.
Inherited from Object Icon.pngUIGridStyleLayout:
voidApplyLayout ( )

Forces a re-layout of all elements. Useful when sort is set to Custom.

|RMD member="API:Class/UIGridStyleLayout/ApplyLayout"|Forces a re-layout of all elements. Useful when sort is set to Custom.|/RMD|
voidSetCustomSortFunction ( function function = nil ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/UIGridStyleLayout/SetCustomSortFunction"|Deprecated. Do not use.|/RMD|
Forces a re-layout of all elements. Useful when sort is set to Custom.
SetCustomSortFunction ( function function = nil ) [deprecated]
Deprecated. Do not use.
Inherited from Object Icon.pngInstance:
voidClearAllChildren ( )

Removes all descendants of the object.

|RMD member="API:Class/Instance/ClearAllChildren"|Removes all descendants of the object.|/RMD|
Ref<Instance>Clone ( )

Returns a copy of the object, including descendants, but only if the object is Archivable.

|RMD member="API:Class/Instance/Clone"|Returns a copy of the object, including descendants, but only if the object is Archivable.|/RMD|
voidDestroy ( )

Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.

|RMD member="API:Class/Instance/Destroy"|Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.|/RMD|
Ref<Instance>FindFirstAncestor ( string name )

Returns the first ancestor whose Name is equal to name, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestor"|Returns the first ancestor whose Name is equal to name, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorOfClass ( string className )

Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorOfClass"|Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorWhichIsA"|Returns the first ancestor that inherits the class className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstChild ( string name, bool recursive = false )

Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.

|RMD member="API:Class/Instance/FindFirstChild"|Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.|/RMD|
Ref<Instance>FindFirstChildOfClass ( string className )

Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.

|RMD member="API:Class/Instance/FindFirstChildOfClass"|Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.|/RMD|
Ref<Instance>FindFirstChildWhichIsA ( string className, bool recursive = false )

Returns the first child that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstChildWhichIsA"|Returns the first child that inherits the class className, or nil if none can be found.|/RMD|
array<Instance>GetChildren ( )

Returns an array of the object's children.

|RMD member="API:Class/Instance/GetChildren"|Returns an array of the object's children.|/RMD|
array<Instance>GetDescendants ( )

Returns an array containing all of the descendants of the instance.

|RMD member="API:Class/Instance/GetDescendants"|Returns an array containing all of the descendants of the instance.|/RMD|
stringGetFullName ( )

Returns a string which shows the object's ancestry chain.

|RMD member="API:Class/Instance/GetFullName"|Returns a string which shows the object's ancestry chain.|/RMD|
RBXScriptSignalGetPropertyChangedSignal ( string property )

Returns a signal that is fired when the specified property is changed on this object.

|RMD member="API:Class/Instance/GetPropertyChangedSignal"|Returns a signal that is fired when the specified property is changed on this object.|/RMD|
boolIsA ( string className )

Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.

|RMD member="API:Class/Instance/IsA"|Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.|/RMD|
boolIsAncestorOf ( Instance descendant )

Returns true if the object is an ancestor of the given descendant.

|RMD member="API:Class/Instance/IsAncestorOf"|Returns true if the object is an ancestor of the given descendant.|/RMD|
boolIsDescendantOf ( Instance ancestor )

Returns true if the object is a descendant of the given ancestor.

|RMD member="API:Class/Instance/IsDescendantOf"|Returns true if the object is a descendant of the given ancestor.|/RMD|
Ref<Instance>WaitForChild ( string childName, double timeOut )

Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.

|RMD member="API:Class/Instance/WaitForChild"|Yields the current thread until a child with the given name is found, then returns the child.

If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.|/RMD|

stringGetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]

Returns a coded string of the object's DebugId used internally by Roblox.

|RMD member="API:Class/Instance/GetDebugId"|Returns a coded string of the object's DebugId used internally by Roblox.|/RMD|
voidRemove ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Instance/Remove"|Deprecated. Do not use.|/RMD|
array<Instance>children ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/children"|Deprecated in favor of GetChildren.|/RMD|
Instanceclone ( ) [deprecated]

Deprecated in favor of Clone.

|RMD member="API:Class/Instance/clone"|Deprecated in favor of Clone.|/RMD|
voiddestroy ( ) [deprecated]

Deprecated in favor of Destroy.

|RMD member="API:Class/Instance/destroy"|Deprecated in favor of Destroy.|/RMD|
InstancefindFirstChild ( string name, bool recursive = false ) [deprecated]

Deprecated in favor of FindFirstChild.

|RMD member="API:Class/Instance/findFirstChild"|Deprecated in favor of FindFirstChild.|/RMD|
array<Instance>getChildren ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/getChildren"|Deprecated in favor of GetChildren.|/RMD|
boolisA ( string className ) [deprecated]

Deprecated in favor of IsA.

|RMD member="API:Class/Instance/isA"|Deprecated in favor of IsA.|/RMD|
boolisDescendantOf ( Instance ancestor ) [deprecated]

Deprecated in favor of IsDescendantOf.

|RMD member="API:Class/Instance/isDescendantOf"|Deprecated in favor of IsDescendantOf.|/RMD|
voidremove ( ) [deprecated]

Deprecated in favor of Remove.

|RMD member="API:Class/Instance/remove"|Deprecated in favor of Remove.|/RMD|
Removes all descendants of the object.
Clone ( )
Returns a copy of the object, including descendants, but only if the object is Archivable.
Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Returns the first ancestor whose Name is equal to name, or nil if none can be found.
Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.
Returns the first ancestor that inherits the class className, or nil if none can be found.
FindFirstChild ( string name, bool recursive = false )
Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.
Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.
FindFirstChildWhichIsA ( string className, bool recursive = false )
Returns the first child that inherits the class className, or nil if none can be found.
Returns an array of the object's children.
Returns an array containing all of the descendants of the instance.
Returns a string which shows the object's ancestry chain.
Returns a signal that is fired when the specified property is changed on this object.
IsA ( string className )
Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.
IsAncestorOf ( Instance descendant )
Returns true if the object is an ancestor of the given descendant.
Returns true if the object is a descendant of the given ancestor.
WaitForChild ( string childName, double timeOut )
Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.
GetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]
Returns a coded string of the object's DebugId used internally by Roblox.
Remove ( ) [deprecated]
Deprecated. Do not use.
children ( ) [deprecated]
Deprecated in favor of GetChildren.
clone ( ) [deprecated]
Deprecated in favor of Clone.
destroy ( ) [deprecated]
Deprecated in favor of Destroy.
findFirstChild ( string name, bool recursive = false ) [deprecated]
Deprecated in favor of FindFirstChild.
getChildren ( ) [deprecated]
Deprecated in favor of GetChildren.
isA ( string className ) [deprecated]
Deprecated in favor of IsA.
isDescendantOf ( Instance ancestor ) [deprecated]
Deprecated in favor of IsDescendantOf.
remove ( ) [deprecated]
Deprecated in favor of Remove.


Events

EventsmemberhiddenEvents [toggle]

PageEnter ( GuiObject page )

Fires when a page comes into view, and is going to be rendered.

|RMD member="API:Class/UIPageLayout/PageEnter"|Fires when a page comes into view, and is going to be rendered.|/RMD|
PageLeave ( GuiObject page )

Fires when a page leaves view, and will not be rendered.

|RMD member="API:Class/UIPageLayout/PageLeave"|Fires when a page leaves view, and will not be rendered.|/RMD|
Stopped ( GuiObject currentPage )

Fires when an animation to CurrentPage is completed without being canceled, and the view stops scrolling.

|RMD member="API:Class/UIPageLayout/Stopped"|Fires when an animation to CurrentPage is completed without being canceled, and the view stops scrolling.|/RMD|
Fires when a page comes into view, and is going to be rendered.
Fires when a page leaves view, and will not be rendered.
Stopped ( GuiObject currentPage )
Fires when an animation to CurrentPage is completed without being canceled, and the view stops scrolling.
Inherited from Object Icon.pngInstance:
AncestryChanged ( Instance child, Instance parent )

Fires when the Parent property of the object or one of its ancestors is changed.

|RMD member="API:Class/Instance/AncestryChanged"|Fires when the Parent property of the object or one of its ancestors is changed.|/RMD|
Changed ( string property )

Fires after a property of the object changes.

|RMD member="API:Class/Instance/Changed"|Fires after a property of the object changes.|/RMD|
ChildAdded ( Instance child )

Fires when a child is added to the object.

|RMD member="API:Class/Instance/ChildAdded"|Fires when a child is added to the object.|/RMD|
ChildRemoved ( Instance child )

Fires when a child is removed from the object.

|RMD member="API:Class/Instance/ChildRemoved"|Fires when a child is removed from the object.|/RMD|
DescendantAdded ( Instance descendant )

Fires when a descendant is added to the object.

|RMD member="API:Class/Instance/DescendantAdded"|Fires when a descendant is added to the object.|/RMD|
DescendantRemoving ( Instance descendant )

Fires before a descendant of the object is removed.

|RMD member="API:Class/Instance/DescendantRemoving"|Fires before a descendant of the object is removed.|/RMD|
childAdded ( Instance child ) [deprecated]

Deprecated in favor of ChildAdded.

|RMD member="API:Class/Instance/childAdded"|Deprecated in favor of ChildAdded.|/RMD|
Fires when the Parent property of the object or one of its ancestors is changed.
Changed ( string property )
Fires after a property of the object changes.
Fires when a child is added to the object.
Fires when a child is removed from the object.
DescendantAdded ( Instance descendant )
Fires when a descendant is added to the object.
Fires before a descendant of the object is removed.
childAdded ( Instance child ) [deprecated]
Deprecated in favor of ChildAdded.

|RMD member="API:Class/UIPageLayout"| |/RMD|