OpusScript functions supported by Opus Flex

This OpusScript Reference List is a list of all the OpusScript functions in alphabetical order that are supported by Opus Flex. When using an OpusScript function in a Script Object or Script Action, you must enter the function name as it appears in this list.

 

Function Name:

Category:

Description:

 

Date

A list of all the Date functions

 

Math

A list of all the Math functions

Backward

MultiFrames

Go back one frame

bool

Global String

Convert a value to a Boolean

ClearBookmark

Pages

Clear a Bookmark for the current page

contains

Global String

Test if one string contains another string

Continue

Slideshow

Continue a Slideshow

Enable

Graphical Objects

Enable or disable this object

ExitPublication

Global

Exit the publication, via an Exit page (if any)

Fade

Graphical Objects

Fade an object by an amount

FindChild

Basic Objects

Finds the child of this object with a particular name

FindDescendent

Basic Objects

Finds the descendent of this object with a particular name

format

Global String

Format a number as a string

Forward

Browsers

Goes forward one page in the browser history

Forward

MultiFrames

Go forward one frame

GetBookmarkPage

Pages

Get Bookmark page by its index number

GetChild

Basic Objects

Gets a child of this object by index

GetFirstBookmark

Pages

Get the first Bookmark page

GetFirstChild

Basic Objects

Gets the first child of this object

GetHeight

Graphical Objects

Get the height of the object

GetLayer

Graphical Objects

Get the layer that the object is on

GetLength

Video

Get the length of the video in seconds

GetMousePosition

Pages

Get the x and y coordinates of the current mouse position

GetName

Basic Objects

Gets the name of the object

GetNextBookmark

Pages

Get the next Bookmark page

GetNextChild

Basic Objects

Gets the child of this object that follows another

GetNumberChildren

Basic Objects

Gets the number of children of this object

GetParent

Basic Objects

Gets the parent of this object

GetPersistentObject

Graphical Objects

Get an object for storing information that will persist when the page is not visible

GetPosition

Graphical Objects

Get the x and y coordinate of the objects position

GetPosition

Video

Get the current position of a video in seconds

GetSlide

Slideshow

Get the slide currently visible

GetSlideCount

Slideshow

Count the number of slides in a slideshow

GetState

Buttons

Returns the current state of a push button

GetType

Global

Get the object’s Object Type e.g. button, image etc.

GetUniqueObjectID

Basic Objects

Gets a string that is unique to this object

GetVolume

Sound

Get the volume level of a specified device

GetWidth

Graphical Objects

Get the width of the object

GetXPosition

Graphical Objects

Get the x coordinate of the objects position

GetYPosition

Graphical Objects

Get the y coordinate of the objects position

Go

Video

Set the first frame of a video

GotoBackwardPage

Global

Go to the previous page in the publication

GotoBookmark

Pages

Go to a specific Bookmark

GotoForwardPage

Global

Go to the next page in the publication

GotoNextPage

Global

Go to the next page in the page history

GotoNextRandomPage

Global

Go to a random page within the chapter without repeating

GotoPreviousPage

Global

Go to the previous page in the page history

GotoRandomPage

Global

Go to a random page within the chapter

GotoSlide

Slideshow

Go to a specific slide

Hide

Graphical Objects

Hide this object

integer

Global String

Convert a value to an integer

IsEnabled

Graphical Objects

Test if this object is enabled

IsObjectIntersecting

Graphical Objects

Test if this object is intersecting another

IsPlaying

Slideshow

Check if a specified Slideshow is playing

IsPlaying

Video

Check if a specified video is playing

IsShowing

Graphical Objects

Test if this object is showing

LaunchSearch

Global

Open the Search dialog box

LaunchURL

Global

Open a URL

left

Global String

Get the left end of a string

length

Global String

Get the length of a string

length

String

The length of the string

mid

Global String

Get part of the middle of a string

Move

Graphical Objects

Move the object by its x and y coordinates

MoveX

Graphical Objects

Move the object by its x coordinate

MoveY

Graphical Objects

Move the object by its y coordinate

number

Global String

Convert a value to a number

Pause

Slideshow

Pause a Slideshow

Play

Slideshow

Play a Slideshow

Play

Video

Play a specified video

random

Global String

Get a random integer

ReallyExitPublication

Global

Exit the publication immediately

RegisterEventHandler

Event Objects

Set a function to be called when a certain event triggers on the object.

ResetAnimation

Graphical Objects

Reset an animation

ResetVariables

Publications

Reset all the publications variables to their default

ResetVars

Pages

Reset all page properties variables

right

Global String

Get the right end of a string

Rotate

Graphical Objects

Rotate an object by a specified angle

Scale

Graphical Objects

Scale an object horizontally and vertically by a percentage

ScaleH

Graphical Objects

Scale an object horizontally by a percentage

ScaleV

Graphical Objects

Scale an object vertically by a percentage

Seek

Video

Reposition the starting point of a video

SetBookmark

Pages

Bookmark the current page

SetLayer

Graphical Objects

Set the layer that the object is on

SetPosition

Graphical Objects

Set aspects of the objects position

SetPosition

Sound

Set the current position in seconds for a sound file

SetPositionX

Graphical Objects

Set the x coordinate of the objects position

SetPositionY

Graphical Objects

Set the y coordinate of the objects position

SetRotation

Graphical Objects

Set an objects rotation to a specified angle

SetScale

Graphical Objects

Set the horizontal and vertical scale of an object to a percentage

SetScaleH

Graphical Objects

Set the horizontal scale of an object to a percentage

SetScaleV

Graphical Objects

Set the vertical scale of an object to a percentage

SetSelection

Text Objects

Selects a range of characters in the text object

SetState

Buttons

Sets the current state of a push button

SetTransparency

Graphical Objects

Set the objects transparency

Show

Graphical Objects

Show this object

ShowBookmarkDialog

Pages

Show the Bookmark Dialog box

Stop

Slideshow

Stop a Slideshow

Stop

Video

Stop a specified video

StopAnimation

Graphical Objects

Stop an animation

string

Global String

Convert a value to a string

TimeGetSeconds

Publications

Get the number of seconds a publication has been running

ToEnd

MultiFrames

Go to last frame in the MultiFrame

ToFrame

MultiFrames

Go to a given frame in the MultiFrame

tolower

Global String

Get a lower case version of a string

ToStart

MultiFrames

Go to first frame in the MultiFrame

toupper

Global String

Get an upper case version of a string

TriggerComponentEvent

Event Objects

Activate a Custom Trigger for a specified object.

UnregisterEventHandler

Event Objects

Remove a previously registered event handler.

word

Global String

Get a word from a string