ShowObject

Purpose:

Show a hidden object with an optional effect. Effect speed is a value between 0 (fastest) and 80 (slowest). A speed of 1 equals 50 ms, 2 equals 100 ms and so on.

Category:

Objects

Syntax:

ShowObject "object name" "effect" speed

object name

The object to show.

effect

Choose one of the available effects.

speed

A numeric between 0 (fastest) and 80 (slowest).

Example:

The following example will show a previously hidden Container with a fadein effect:


ShowObject "Container1" "fadein" 12


HideObject

Purpose:

Hide a hidden object with an optional effect. Effect speed is a value between 0 (fastest) and 80 (slowest). A speed of 1 equals 50 ms, 2 equals 100 ms and so on.

Category:

Objects

Syntax:

HideObject "object name" "effect" speed

object name

The object to show.

effect

Choose one of the available effects.

speed

A numeric between 0 (fastest) and 80 (slowest).

Example:

The following example will hide a Container with a fadeout effect:


ShowObject "Container1" "fadeout" 12

EnableObject

Purpose:

Enable an object. An enabled object can respond to keyboard and mouse events.

Category:

Objects

Syntax:

EnableObject "object name"

object name

The object to enable.

Example:

The following example will enable a previuosly disabled Container:


EnableObject "Container1"

DisableObject

Purpose:

Disable an object. An enabled object can respond to keyboard and mouse events.

Category:

Objects

Syntax:

EnableObject "object name"

object name

The object to disable.

Example:

The following example will disable a Container:


DisableObject "Container1"


DisableObjectTextSelection

Purpose:

Disable text selection by user in an object

Category:

Objects

Syntax:

DisableObjectTextSelection "object name"

object name

The object to disable text selection

Example:

The following example will disable selecting text in a Container:


DisableObjectTextSelection "Container1"


SetObjectBounds

Purpose:

Modify an object's top, left, width and height properties at the same time
Use null for properties that you do not want to set.

Category:

Objects

Syntax:

SetObjectsBounds "object name" "left" "top" "width" "height"

left

New distance from the left to assign to the object (x coordinate).

top

New distance from the top to assign to the object (y coordinate).

width

New width to assign to the object.

height

New height to assign to the object.

Example:

The following example will position the object Container1 into the 10, 15 coordinates with a width of 300 pixels and a height of 250 pixels:


SetObjectBounds "Container1" 10 15 300 250

MoveObject

Purpose:

Change an object’s position on the screen by changing its left and top properties.

Category:

Objects

Syntax:

MoveObject "object name" "left" "top"

object name

The name of an existing object.

left and top

The new left/top coordinates for the object. Coordinates are relative to the upper left corner of the publication window. If the object is attached to a container then the coordinates are relative to the container's upper left corner.

Example:

This example moves object Container1 to the upper left corner of the publication:

MoveObject "Container1" "5" "5"


MoveObjectIntoContainer

Purpose:

Move an object into from its current place to a Container object

Category:

Objects

Syntax:

MoveObjectIntoContainer "object name" "Container name"

object name

The name of an existing object to be moved.

Container name

The name of an existing Container where the object will be moved.

Example:

MoveObjectIntoContainer "Container2" "Container1"


AnimateObject

Purpose:

Change an object left and top coordinates through animation.

Category:

Objects

Syntax:

AnimateObject "object name" "left" "top" duration "easing" "subroutine"

object name

The name of an existing object.

left and top

The new left/top coordinates for the object. Coordinates are relative to the upper left corner of the publication window. If the object is attached to a container then the coordinates are relative to the container's upper left corner.

duration

Animation duration in milliseconds.

subroutine

Optional subroutine name to execute once the animation has finished.

Example:

This example animates object Container1 to the upper left corner of the publication with an elastic motion effect:

AnimateObject "Container1" "5" "5" 1500 "easeOutElastic" ""


AnimateObjectCSS

Purpose:

Change a set of CSS properties through animation.

Category:

Objects

Syntax:

AnimateObjectCSS "object name" [css object] duration delay "easing" "subroutine name"

object name

The name of an existing object.

css object

An object variable storing CSS properties and values to be animated.

duration

Animation duration in milliseconds.

delay

Delay until animation starts.

subroutine

Optional subroutine name to execute once the animation has finished.

Example:

CreateEmptyObject [mycss]

SetVar [mycss("left")] "+=200"

SetVar [mycss("top")] "+=100"

SetVar [mycss("width")] "+=100"
SetVar [mycss("height")] "+50"

AnimateObjectCSS "Container1" [mycss] 2000 0 "easeOutQuad" ""


SetObjectCSS

Purpose:

Change a set of CSS properties.

Category:

Objects

Syntax:

SetObjectCSS "object name" [css object]

object name

The name of an existing object.

css object

An object variable storing CSS properties and their new values.

Example:

CreateEmptyObject [mycss]

SetVar [mycss("left")] "+=200"

SetVar [mycss("top")] "+=100"

SetVar [mycss("width")] "+=100"
SetVar [mycss("height")] "+50"

SetObjectCSS "Container1" [mycss]


SetRelativePosition

Purpose:

Set objects horizontal and vertical position relative to its container.

Category:

Objects

Syntax:

SetRelativePosition "object name" "vertical position" "horizontal position"

object name

The name of an existing object.

vertical position

Choose between top, middle or bottom values to set vertical positioning.

horizontal position

Choose between left, center and right values to set horizontal positioning.

Example:

SetRelativePosition "Container1" "top" "center"


SizeObject

Purpose:

Change the width and height of an object.

Category:

Objects

Syntax:

SizeObject "object name" "width" "height"

object name

The name of an existing object.

width, height

The object’s new width and height.

Example:

SizeObject "Container1" "150" "100"

RotateObject

Purpose:

Rotate an object by degrees (0-360). Use a positive value to rotate clockwise or negative values to rotate counter-clockwise.

Category:

Objects

Syntax:

RotateObject "object name" "degrees"

object name

The name of an existing object.

degrees

Angle the object will be rotated.

Example:

RotateObject "Container1" "45"


AddClass

Purpose:

Adds one or more CSS classes to the selected object.

Category:

Objects

Syntax:

AddClass "object" "css class"

object

The name of an existing object.

css class

CSS class name to add.

Example:

AddClass "Container1" "myclass"


RemoveClass

Purpose:

Remove one or more CSS classes from the selected object.

Category:

Objects

Syntax:

RemoveClass "object" "css class"

object

The name of an existing object.

css class

CSS class name to remove.

Example:

RemoveClass "Container1" "myclass"


ToggleClass

Purpose:

Toggles between adding/removing classes from the selected object.

Category:

Objects

Syntax:

ToggleClass "object" "css class"

object

The name of an existing object.

css class

CSS class name to toggle.

Example:

ToggleClass "Container1" "myclass"


FocusObject

Purpose:

Set the keyboard input focus to a specific object. This Action is primarily used to activate Text Input objects. Objects that don’t accept keyboard input are not affected by this Action.

Category:

Objects

Syntax:

FocusObject "object name"

object name

The name of an existing object.

Example:

FocusObject "TextInput1"


ObjectToFront

Purpose:

Move an object to the foreground

Category:

Objects

Syntax:

ObjectToFront "object name"

object name

The name of an existing object.

Example:

ObjectToFront "Container1"


ObjectToBack

Purpose:

Move an object to the background

Category:

Objects

Syntax:

ObjectToBack "object name"

object name

The name of an existing object.

Example:

ObjectToBack "Container1"


ClickObject

Purpose:

Simulates a mouse click on the given object

Category:

Objects

Syntax:

ClickObject "object name"

object name

The name of an existing object with actions.

Example:

ClickObject "MyButton"


SetObjectAttribute

Purpose:

Set an individual HTML atribute for an object.

Category:

Objects

Syntax:

SetObjectStyle "object name" "HTML attibute" "value"

object name

The name of an existing object.

css property

The name of a HTML property.

value

Value to assign to the HTML property.

Example:

SetObjectStyle "Image1" "src" "./img/imagefile.jpg"


GetObjectAttribute

Purpose:

Get an individual HTML atribute for an object.

Category:

Objects

Syntax:

GetObjectAttribute "object name" "HTML attibute" "[result var]"

object name

The name of an existing object.

HTML property

The name of a HTML property.

result var

Variable to store the result.

Example:

GetObjectAttribute "Image1" "src" "[myvar]"


SetObjectStyle

Purpose:

Set an individual CSS attribute for an object.

Category:

Objects

Syntax:

SetObjectStyle "object name" "css property" "value"

object name

The name of an existing object.

css property

The name of a CSS property.

value

Value to assign to the CSS property.

Example:

SetObjectStyle "PushButton1" "font-size" "20pt"


ClearObjectStyles

Purpose:

Remove all CSS styles for an object set with SetObjectStyle.

Category:

Objects

Syntax:

ClearObjectStyles "object name"

object name

The name of an existing object.

Example:

ClearObjectStyles "PushButton1"


GetObjectInfo

Purpose:

Obtain information about an object such as the current size, position, visible state, etc.

Category:

Objects

Syntax:

GetObjectInfo "object name" "css property" [result var]

object name

The name of an existing object.

css property

The name of a CSS property.

result var

Variable to store the result.

Example:

GetObjectInfo "PushButton1" "color" [myvar]


DuplicateObject

Purpose:

Duplicate an object and create a new run-time object inside a Container

Category:

Objects

Syntax:

DuplicateObject "source object" "new object name" "destination container"

source object

The name of an existing object to be duplicated.

new object name

The new object name.

destination container

The Container or Page name where the new object will be placed.

Example:

DuplicateObject "Container1" "mycontainer" "NewPage"


RemoveObject

Purpose:

Remove an object and its duplicated objects if they exist.

Category:

Objects

Syntax:

RemoveObject "object name"

object name

The name of an existing object to be removed.

Example:

RemoveObject "Container1"


SetObjectHTML

Purpose:

Set the HTML content (inner HTML) of an object.

Category:

Objects

Syntax:

SetObjectHTML "object name" "html content"

object name

The name of an existing object.

html content

Content in HTML format.

Example:

SetObjectHTML "Container1" "<strong>Hello</strong>"


GetObjectHTML

Purpose:

Get the HTML content (inner HTML) of an object.

Category:

Objects

Syntax:

GetObjectHTML "object name" [result var]

object name

The name of an existing object.

result var

Variable to store the result.

Example:

GetObjectHTML "Container1" [myvar]


SetObjectText

Purpose:

Set the text content of an object (HTML tags will be shown, not interpreted)

Category:

Objects

Syntax:

SetObjectText "object name" "text"

object name

The name of an existing object.

text

Text content.

Example:

SetObjectText "Container1" "<h1> is a HTML tag"


GetObjectText

Purpose:

Get the text content of an object (HTML tags will be removed)

Category:

Objects

Syntax:

GetObjectText "object name" [result var]

object name

The name of an existing object.

result var

Variable to store the result.

Example:

GetObjectText "Container1" [myvar]


ObjectEnterFullScreen

Purpose:

Shows the object in full screen mode (images, videos etc.)

Category:

Objects

Syntax:

ObjectEnterFullScreen "object name"

object name

The name of an existing object.

Example:

ObjectEnterFullScreen "Image1"


ObjectExitFullScreen

Purpose:

Returns to normal mode after ObjectEnterFullScreen

Category:

Objects

Syntax:

ObjectExitFullScreen "object name"

Example:

ObjectExitFullScreen "Image1"


TimerStart

Purpose:

Start a Timer object.

Category:

Objects

Syntax:

TimerStart "timer object name" milliseconds

timer object name

The name of an existing timer object.

milliseconds

Number of millisecods to perform the timer interval.

Example:

TimerStart "Timer1" 1000


TimerStop

Purpose:

Stop a Timer object.

Category:

Objects

Syntax:

TimerStop "timer object name"

timer object name

The name of an existing timer object.

Example:

TimerStop "Timer1"