Difference between revisions of "On Timeout"

From SAP Enable Now Wiki
(Created page with "__NOTOC__ ==Scope== * '''Book Page''' > '''Time Control''' > '''On Timeout x''' property ==Purpose== The '''On Timeout''' property is used to specify the action(s) th...")
 
Line 16: Line 16:
 
*** '''Hide''': Hide the object (immediately, without regard to its '''[[Animate Out]]''' property).
 
*** '''Hide''': Hide the object (immediately, without regard to its '''[[Animate Out]]''' property).
 
*** '''Show''': Show the object (immediately, without regard to its '''[[Animate In]]''' property).
 
*** '''Show''': Show the object (immediately, without regard to its '''[[Animate In]]''' property).
*** ''Toggle'': Hide or show the object *immediately).
+
*** '''Toggle''': Hide or show the object *immediately).
 +
*** '''View Link''' (Mode Link objects only)
 
** For '''[[Time Control]] objects:
 
** For '''[[Time Control]] objects:
 
*** '''Start''': Start the timer.
 
*** '''Start''': Start the timer.
 
*** '''Stop''': Stop (and reset) the timer.
 
*** '''Stop''': Stop (and reset) the timer.
** For Audio or Video objects
+
** For '''[[Counter]]''' objects:
 +
*** '''Count Up'''
 +
*** '''Disable'''
 +
*** '''Enable'''
 +
*** '''Reset'''
 +
** For '''[[Collector]]''' objects:
 +
*** '''Disable'''
 +
*** '''Enable'''
 +
*** '''Flag 1'''..'''10'''
 +
*** '''Reset'''
 +
** For '''[[Object Visibility]] objects:
 +
*** '''Activate 1'''..'''10'''
 +
** For '''[[Animation]]''' objects:
 +
*** '''Start'''
 +
*** '''Stop'''
 +
** For '''[[Audio]]''' objects:
 
*** '''Pause'''
 
*** '''Pause'''
 
*** '''Play'''
 
*** '''Play'''
 
*** '''Rewind'''
 
*** '''Rewind'''
 
*** '''Stop'''
 
*** '''Stop'''
 +
** For '''[[Video]]''' objects:
 +
*** '''Hide'''
 +
*** '''Pause'''
 +
*** '''Play'''
 +
*** '''Rewind'''
 +
*** '''Show'''
 +
*** '''Stop'''
 +
*** '''Toggle'''
 +
** For '''[[Flash Animation]]''' objects:
 +
*** '''Hide'''
 +
*** '''Show'''
 +
*** '''Play'''
 +
*** '''Pause'''
 +
*** '''Toggle'''
  
 
A '''[[Time Control]]''' can contain up to eight '''Time'''/'''On Timeout''' pairs, each of which can trigger multiple actions.
 
A '''[[Time Control]]''' can contain up to eight '''Time'''/'''On Timeout''' pairs, each of which can trigger multiple actions.
  
 
[[Category:Property]]
 
[[Category:Property]]

Revision as of 06:12, 24 September 2019

Scope

Purpose

The On Timeout property is used to specify the action(s) that should be performed when the time (elapsed time after the start of the parent Time Control) specified in the associated associated Time x property is reached.

Use

When the On Timeout x property is initially activated it contains only an Add link. Clicking on this adds a two-column table to the property text area. The two columns are populated by way of drop-down pick-lists. These are (from left to right):

  • Target Object: The Book Page object against which the associated action should be performed. This drop-down is automatically populated with all objects in the page. (This is one reason why it is recommended that you always provide meaningful names for your objects.)
  • Action: The action that should be performed against the associated object. This can be one of:
    • For most 'display' objects:
      • Animate In: Display the object using the method defined in the object's Animate In property.
      • Animate Out: Hide the object using the method defined in the object's Animate Out property.
      • Animate Toggle: Show the object if it is currently hidden, or hide it if it is currently displayed, using the object's Animate In or Animate Out property as appropriate.
      • Hide: Hide the object (immediately, without regard to its Animate Out property).
      • Show: Show the object (immediately, without regard to its Animate In property).
      • Toggle: Hide or show the object *immediately).
      • View Link (Mode Link objects only)
    • For Time Control objects:
      • Start: Start the timer.
      • Stop: Stop (and reset) the timer.
    • For Counter objects:
      • Count Up
      • Disable
      • Enable
      • Reset
    • For Collector objects:
      • Disable
      • Enable
      • Flag 1..10
      • Reset
    • For Object Visibility objects:
      • Activate 1..10
    • For Animation objects:
      • Start
      • Stop
    • For Audio objects:
      • Pause
      • Play
      • Rewind
      • Stop
    • For Video objects:
      • Hide
      • Pause
      • Play
      • Rewind
      • Show
      • Stop
      • Toggle
    • For Flash Animation objects:
      • Hide
      • Show
      • Play
      • Pause
      • Toggle

A Time Control can contain up to eight Time/On Timeout pairs, each of which can trigger multiple actions.