OryUIPagination

Available Functions

OryUICreatePagination(parameters$)

Creates a pagination component and returns a pagination ID. See Available Parameters section below for the options.

OryUIDeletePagination(paginationID)

Deletes a pagination component.

OryUIGetPaginationHeight(paginationID)

Returns the height of the pagination component.

OryUIGetPaginationButtonCount(paginationID)

Returns the number of buttons in the pagination component.

OryUIGetPaginationButtonHeight(paginationID, buttonID)

Returns the height of a specific button in the pagination component.

OryUIGetPaginationButtonWidth(paginationID, buttonID)

Returns the width of a specific button in the pagination component.

OryUIGetPaginationChanged(paginationID)

Returns if the page number has changed.

OryUIGetPaginationSelectedPage(paginationID)

Returns the page number selected.

OryUIGetPaginationWidth(paginationID)

Returns the width of the pagination component.

OryUIGetPaginationX(paginationID)

Returns the X position of the pagination component.

OryUIGetPaginationY(paginationID)

Returns the Y position of the pagination component.

OryUIInsertPaginationListener(paginationID)

Required to register pagination component activity.

OryUISetPaginationButtonCount(paginationID)

Sets the number of buttons in the pagination component. Will remove or add buttons to the required amount.

OryUISetPaginationSelectedPage(paginationID, pageNumber)

Sets which page number is selected in the pagination component.

OryUIUpdatePagination(paginationID, parameters$)

Updates a pagination component. See Available Parameters section below for the options.

Available Parameters (all optional)

Parameter	Description
buttonMargin	The margin/spacing around each button in the pagination component. Accepts decimals.
color	The colour of the pagination component. Accepts RGB values, and RGBA values (comma delimited) Also accepts MakeColor() value/id, and hex color codes.
depth	The depth of the pagination component.
fixToScreen	Fixes the pagination component to screen.
height	The height of the pagination component. Accepts decimals.
imageID	Apply an image to the whole pagination component background. Requires a LoadImage() value/id.
inactiveColor	The colour of the inactive buttons. Accepts RGB values, and RGBA values (comma delimited) Also accepts MakeColor() value/id, and hex color codes.
inactiveTextBold	If the inactive button text is bold. Accepts the values true, false, 0, and 1.
inactiveTextColor	The colour of the inactive button text. Accepts RGB values, and RGBA values (comma delimited) Also accepts MakeColor() value/id, and hex color codes.
inactiveTextSize	The size of the inactive button text. Accepts decimals.
maxButtonsToDisplay	The maximum number of buttons to show in the pagination component. There can be more pages than buttons.
noOfPages	The number of pages in the pagination component.
offset	The x and y position where the offset should be placed, comma delimited. Also accepts a single value 'center'. Accepts decimals.
position	The x and y position where the template should be placed, comma delimited.
selectedColor	The colour of the selected buttons in the pagination component. Accepts RGB values, and RGBA values (comma delimited) Also accepts MakeColor() value/id, and hex color codes.
selectedTextBold	If the selected button text is bold. Accepts the values true, false, 0, and 1.
selectedTextColor	The colour of the selected button text. Accepts RGB values, and RGBA values (comma delimited) Also accepts MakeColor() value/id, and hex color codes.
selectedTextSize	The size of the selected button text. Accepts decimals.
showSkipToEndButtons	Whether or not skip to end buttons should be shown. Requires a minimum of 5 buttons in the pagination component. Accepts the values true, false, 0, and 1.
size	The width and height of the template, comma delimited. Also accepts -1 in either one to create a square button. Accepts decimals.
unselectedColor	The colour of the unselected buttons in the pagination component. Accepts RGB values, and RGBA values (comma delimited) Also accepts MakeColor() value/id, and hex color codes.
unselectedTextBold	If the unselected button text is bold. Accepts the values true, false, 0, and 1.
unselectedTextColor	The colour of the unselected button text. Accepts RGB values, and RGBA values (comma delimited) Also accepts MakeColor() value/id, and hex color codes.
width	The width of the pagination component. Accepts decimals.
x	The x position where the pagination component should be placed.
y	The y position where the pagination component should be placed.

Example Code

Example

pagination = OryUICreatePagination("position:0,20;noOfPages:49;maxButtonsToDisplay:9")

do
    OryUIStartTrackingTouch()

    OryUIInsertPaginationListener(pagination)

    OryUIEndTrackingTouch()

    Sync()
loop