Skip to content

Animation view context objects

In animation views, a very complex and complete context is available in the event code attributes. In runtime, all symbols and Views in View Containers are exposed with their names. Consider the following view structure:

View elements
View1
    Arguments
    Elements
        Button1
        Numeric2
        Text2
        ViewContainer1 - with configuration to sub view.
SubView
View2   
    Arguments
    Elements
        ButtonA
        ButtonB
        SymbolA

In runtime, when the View Container loads its View, the resulting object hierarchy looks like 

graph TD
Session-->View1
View1-->Button1
View1-->Numeric2
View1-->Text2
View1-->ViewContainer1
ViewContainer1-->View
ViewContainer1--currentView-->View

View-->ButtonA
View-->ButtonB
View-->SymbolA

this.view

The this.view always points to the nearest View object available. Example

Button1 - OnManeuver
   this.view.ViewContainer1.openview(file,args);
The Element Button1 is a child object to the parent view. The View Container ViewContainer1 is exposed under the view.

this.parent

Always the nearest parent. For Symbol1:
this.parent refers to the View inside ViewContainer1. this.parent.parent refers to ViewContainer1. this.parent.parent.parent refers to View1.

this.session

Always the top most session object.

Tip

To investigate the context and arguments to the OnOpen, OnClose, OnManeuver or OnChanged event code, simply put a debugger; statement in the event code. Press ++F12++ or open DevTools from the browser menu and refresh the page, then use the right panel to explore the context.

Tip

If you expand the Prototype of the object in DevTools, the available methods for the selected object are displayed.

Elements by function

title

Get/Set
  let value = this.title() //Get the value
  this.title(value) //Set the value
Type Get Set
Static Yes Yes
Numeric Yes Yes
Text Yes Yes
TextSelect Yes Yes
Time Yes Yes
Date Yes Yes
CheckBox Yes Yes
Button Yes Yes
Symbol Yes Yes
View Yes Yes
TableRow Yes Yes
ListView Yes Yes

icon

Get/Set
  let value = this.icon() //Get the value
  this.icon(value) //Set the value
Type Get Set
Static Yes No
Numeric Yes No
Text Yes No
TextSelect Yes No
Time Yes No
Date Yes No
CheckBox Yes No
Symbol Yes No
ViewContainer Yes No
View Yes No

userDescription

Get/Set
  let value = this.userDescription() //Get the value
  this.userDescription(value) //Set the value
Type Get Set
Static Yes Yes
Numeric Yes Yes
Text Yes Yes
TextSelect Yes Yes
Time Yes Yes
Date Yes Yes
CheckBox Yes Yes
Button Yes Yes
Symbol Yes Yes

value

Get/Set
  let value = this.value() //Get the value
  this.value(value) //Set the value
Type Get Set
Numeric Yes Yes
Text Yes Yes
TextSelect Yes Yes
Time Yes Yes
Date Yes Yes
CheckBox Yes Yes
Button Yes Yes
Symbol Yes Yes

unit

Get/Set
  let value = this.unit() //Get the value
  this.unit(value) //Set the value
Type Get Set
Numeric Yes Yes

format

Get/Set
  let value = this.format() //Get the value
  this.format(value) //Set the value
Type Get Set
Numeric Yes Yes
Time Yes Yes
Date Yes Yes

enabled

Get/Set
  let value = this.enabled() //Get the value
  this.enabled(value) //Set the value
Type Get Set
Static Yes Yes
Numeric Yes Yes
Text Yes Yes
TextSelect Yes Yes
Time Yes Yes
Date Yes Yes
CheckBox Yes Yes
Button Yes Yes
Symbol Yes Yes
ViewContainer No No
TableRow Yes Yes

minValue

Get/Set
  let value = this.minValue() //Get the value
  this.minValue(value) //Set the value
Type Get Set
Numeric Yes Yes
Symbol Yes Yes

maxValue

Get/Set
  let value = this.maxValue() //Get the value
  this.maxValue(value) //Set the value
Type Get Set
Numeric Yes Yes
Symbol Yes Yes

expanded

Get/Set
  let value = this.expanded() //Get the value
  this.expanded(value) //Set the value
Type Get Set
Static Yes Yes
TextSelect Yes Yes

selected

Get/Set
  let value = this.selected() //Get the value
  this.selected(value) //Set the value
Type Get Set
Static Yes Yes
Numeric Yes Yes
Text Yes Yes
TextSelect Yes Yes
Time Yes Yes
Date Yes Yes
CheckBox Yes Yes
Button Yes Yes
Symbol Yes Yes
ViewContainer Yes Yes

visible

Get/Set
  let value = this.visible() //Get the value
  this.visible(value) //Set the value
Type Get Set
Static Yes Yes
Numeric Yes Yes
Text Yes Yes
TextSelect Yes Yes
Time Yes Yes
Date Yes Yes
CheckBox Yes Yes
Button Yes Yes
Symbol Yes Yes
ViewContainer Yes Yes
TableRow Yes Yes
TableValueColumn Yes Yes
List Yes Yes
Table Yes Yes
Separator Yes Yes

visualControl

Get/Set
  let value = this.visualControl() //Get the value
  this.visualControl(value) //Set the value
Type Get Set
Numeric Yes Yes
Text Yes Yes
TextSelect Yes Yes
Time Yes Yes
Date Yes Yes
TableRow Yes Yes
Static Yes Yes
Symbol Yes Yes

left

Get/Set
  let value = this.left() //Get the value
  this.left(value) //Set the value
Type Get Set
Session Yes No
Static Yes Yes
Numeric Yes Yes
Text Yes Yes
TextSelect Yes Yes
Time Yes Yes
Date Yes Yes
CheckBox Yes Yes
Button Yes Yes
Symbol Yes Yes
ViewContainer Yes Yes

top

Get/Set
  let value = this.top() //Get the value
  this.top(value) //Set the value
Type Get Set
Session Yes No
Static Yes Yes
Numeric Yes Yes
Text Yes Yes
TextSelect Yes Yes
Time Yes Yes
Date Yes Yes
CheckBox Yes Yes
Button Yes Yes
Symbol Yes Yes
ViewContainer Yes Yes

width

Get/Set
  let value = this.width() //Get the value
  this.width(value) //Set the value
Type Get Set
Session Yes No
Static Yes Yes
Numeric Yes Yes
Text Yes Yes
TextSelect Yes Yes
Time Yes Yes
Date Yes Yes
CheckBox Yes Yes
Button Yes Yes
Symbol Yes Yes
ViewContainer Yes Yes

height

Get/Set
  let value = this.height() //Get the value
  this.height(value) //Set the value
Type Get Set
Session Yes No
Static Yes Yes
Numeric Yes Yes
Text Yes Yes
TextSelect Yes Yes
Time Yes Yes
Date Yes Yes
CheckBox Yes Yes
Button Yes Yes
Symbol Yes Yes
ViewContainer Yes Yes

openView

Get/Set
  let value = this.openView() //Get the value
  this.openView(value) //Set the value
Type Get Set
ViewContainer Yes No

close

Get/Set
  let value = this.close() //Get the value
  this.close(value) //Set the value
Type Get Set
ViewContainer Yes No
View Yes No

currentView

Get/Set
  let value = this.currentView() //Get the value
  this.currentView(value) //Set the value
Type Get Set
ViewContainer Yes No

scaleMode

Get/Set
  let value = this.scaleMode() //Get the value
  this.scaleMode(value) //Set the value
Type Get Set
View Yes Yes

scaleValue

Get/Set
  let value = this.scaleValue() //Get the value
  this.scaleValue(value) //Set the value
Type Get Set
View Yes Yes

currentLanguage

Get/Set
  let value = this.currentLanguage() //Get the value
  this.currentLanguage(value) //Set the value
Type Get Set
Session Yes Yes

user

Get/Set
  let value = this.user() //Get the value
  this.user(value) //Set the value
Type Get Set
Session Yes No

msgBox

Get/Set
  let value = this.msgBox() //Get the value
  this.msgBox(value) //Set the value
Type Get Set
Session Yes No
Static Yes No
Numeric Yes No
Text Yes No
TextSelect Yes No
Time Yes No
Date Yes No
CheckBox Yes No
Button Yes No
Symbol Yes No
View Yes No
ViewContainer Yes No
ListView Yes No
List Yes No
Table Yes No
TableRow Yes No

debugMsg

Get/Set
  let value = this.debugMsg() //Get the value
  this.debugMsg(value) //Set the value
Type Get Set
Session Yes No

next

Get/Set
  let value = this.next() //Get the value
  this.next(value) //Set the value
Type Get Set
List Yes No
Table Yes No

previous

Get/Set
  let value = this.previous() //Get the value
  this.previous(value) //Set the value
Type Get Set
List Yes No
Table Yes No

currentSelection

Get/Set
  let value = this.currentSelection() //Get the value
  this.currentSelection(value) //Set the value
Type Get Set
List Yes No
Table Yes No

peek

Get/Set
  let value = this.peek() //Get the value
  this.peek(value) //Set the value
Type Get Set
Session Yes No

poke

Get/Set
  let value = this.poke() //Get the value
  this.poke(value) //Set the value
Type Get Set
Session Yes No

elements

Get/Set
  let value = this.elements() //Get the value
  this.elements(value) //Set the value
Type Get Set
View Yes No
ListView Yes No

noOfElements

Get/Set
  let value = this.noOfElements() //Get the value
  this.noOfElements(value) //Set the value
Type Get Set
View Yes No
ListView Yes No

getLocalSettings

Get/Set
  let value = this.getLocalSettings() //Get the value
  this.getLocalSettings(value) //Set the value
Type Get Set
Session Yes No

saveLocalSettings

Get/Set
  let value = this.saveLocalSettings() //Get the value
  this.saveLocalSettings(value) //Set the value
Type Get Set
Session Yes Yes

removeLocalSettings

Get/Set
  let value = this.removeLocalSettings() //Get the value
  this.removeLocalSettings(value) //Set the value
Type Get Set
Session Yes Yes

clearAllLocalSettings

Get/Set
  let value = this.clearAllLocalSettings() //Get the value
  this.clearAllLocalSettings(value) //Set the value
Type Get Set
Session Yes Yes

args

Get/Set
  let value = this.args() //Get the value
  this.args(value) //Set the value
Type Get Set
View Yes No
ListView Yes No

viewArgs

Get/Set
  let value = this.viewArgs() //Get the value
  this.viewArgs(value) //Set the value
Type Get Set
View Yes No
ListView Yes No

viewVariables

Get/Set
  let value = this.viewVariables() //Get the value
  this.viewVariables(value) //Set the value
Type Get Set
View Yes Yes
ListView Yes Yes

viewFunctions

Get/Set
  let value = this.viewFunctions() //Get the value
  this.viewFunctions(value) //Set the value
Type Get Set
View Yes Yes
ListView Yes Yes

executeManeuver

Get/Set
  let value = this.executeManeuver() //Get the value
  this.executeManeuver(value) //Set the value
Type Get Set
Numeric Yes Yes
Text Yes Yes
TextSelect Yes Yes
Time Yes Yes
Date Yes Yes
CheckBox Yes Yes
Button Yes Yes
Symbol Yes Yes

texts

Get/Set
  let value = this.texts() //Get the value
  this.texts(value) //Set the value
Type Get Set
TextSelect Yes Yes

pictures

Get/Set
  let value = this.pictures() //Get the value
  this.pictures(value) //Set the value
Type Get Set
TextSelect Yes Yes

logLevel

Get/Set
  let value = this.logLevel() //Get the value
  this.logLevel(value) //Set the value
Type Get Set
Session Yes Yes

commLogLevel

Get/Set
  let value = this.commLogLevel() //Get the value
  this.commLogLevel(value) //Set the value
Type Get Set
Session Yes Yes

touchEditable

Get/Set
  let value = this.touchEditable() //Get the value
  this.touchEditable(value) //Set the value
Type Get Set
Numeric Yes No
Text Yes No

densityFactor

Get/Set
  let value = this.densityFactor() //Get the value
  this.densityFactor(value) //Set the value
Type Get Set
Session Yes Yes

type

Get/Set
  let value = this.type() //Get the value
  this.type(value) //Set the value
Type Get Set
ALL Yes No

name

Get/Set
  let value = this.name() //Get the value
  this.name(value) //Set the value
Type Get Set
ALL Yes No

multiplePopups

Get/Set
  let value = this.multiplePopups() //Get the value
  this.multiplePopups(value) //Set the value
Type Get Set
Session Yes Yes

theme

Get/Set
  let value = this.theme() //Get the value
  this.theme(value) //Set the value
Type Get Set
Session Yes No

gestures

Get/Set
  let value = this.gestures() //Get the value
  this.gestures(value) //Set the value
Type Get Set
Session Yes No

scaleModes

Get/Set
  let value = this.scaleModes() //Get the value
  this.scaleModes(value) //Set the value
Type Get Set
Session Yes No

transitions

Get/Set
  let value = this.transitions() //Get the value
  this.transitions(value) //Set the value
Type Get Set
Session Yes No
Get/Set
  let value = this.openLink() //Get the value
  this.openLink(value) //Set the value
Type Get Set
Session Yes Yes

setFocus

Get/Set
  let value = this.setFocus() //Get the value
  this.setFocus(value) //Set the value
Type Get Set
Numeric Yes No
Text Yes No

maneuverResolution

Get/Set
  let value = this.maneuverResolution() //Get the value
  this.maneuverResolution(value) //Set the value
Type Get Set
Time Yes Yes

Function by Elements

Static

Name Get Set
title let value = this.title() this.title(value)
icon let value = this.icon() Not Available
userDescription let value = this.userDescription() this.userDescription(value)
enabled let value = this.enabled() this.enabled(value)
expanded let value = this.expanded() this.expanded(value)
selected let value = this.selected() this.selected(value)
visible let value = this.visible() this.visible(value)
visualControl let value = this.visualControl() this.visualControl(value)
left let value = this.left() this.left(value)
top let value = this.top() this.top(value)
width let value = this.width() this.width(value)
height let value = this.height() this.height(value)
msgBox let value = this.msgBox() Not Available

Numeric

Name Get Set
title let value = this.title() this.title(value)
icon let value = this.icon() Not Available
userDescription let value = this.userDescription() this.userDescription(value)
value let value = this.value() this.value(value)
unit let value = this.unit() this.unit(value)
format let value = this.format() this.format(value)
enabled let value = this.enabled() this.enabled(value)
minValue let value = this.minValue() this.minValue(value)
maxValue let value = this.maxValue() this.maxValue(value)
selected let value = this.selected() this.selected(value)
visible let value = this.visible() this.visible(value)
visualControl let value = this.visualControl() this.visualControl(value)
left let value = this.left() this.left(value)
top let value = this.top() this.top(value)
width let value = this.width() this.width(value)
height let value = this.height() this.height(value)
msgBox let value = this.msgBox() Not Available
executeManeuver let value = this.executeManeuver() this.executeManeuver(value)
touchEditable let value = this.touchEditable() Not Available
setFocus let value = this.setFocus() Not Available

Text

Name Get Set
title let value = this.title() this.title(value)
icon let value = this.icon() Not Available
userDescription let value = this.userDescription() this.userDescription(value)
value let value = this.value() this.value(value)
enabled let value = this.enabled() this.enabled(value)
selected let value = this.selected() this.selected(value)
visible let value = this.visible() this.visible(value)
visualControl let value = this.visualControl() this.visualControl(value)
left let value = this.left() this.left(value)
top let value = this.top() this.top(value)
width let value = this.width() this.width(value)
height let value = this.height() this.height(value)
msgBox let value = this.msgBox() Not Available
executeManeuver let value = this.executeManeuver() this.executeManeuver(value)
touchEditable let value = this.touchEditable() Not Available
setFocus let value = this.setFocus() Not Available

TextSelect

Name Get Set
title let value = this.title() this.title(value)
icon let value = this.icon() Not Available
userDescription let value = this.userDescription() this.userDescription(value)
value let value = this.value() this.value(value)
enabled let value = this.enabled() this.enabled(value)
expanded let value = this.expanded() this.expanded(value)
selected let value = this.selected() this.selected(value)
visible let value = this.visible() this.visible(value)
visualControl let value = this.visualControl() this.visualControl(value)
left let value = this.left() this.left(value)
top let value = this.top() this.top(value)
width let value = this.width() this.width(value)
height let value = this.height() this.height(value)
msgBox let value = this.msgBox() Not Available
executeManeuver let value = this.executeManeuver() this.executeManeuver(value)
texts let value = this.texts() this.texts(value)
pictures let value = this.pictures() this.pictures(value)

Time

Name Get Set
title let value = this.title() this.title(value)
icon let value = this.icon() Not Available
userDescription let value = this.userDescription() this.userDescription(value)
value let value = this.value() this.value(value)
format let value = this.format() this.format(value)
enabled let value = this.enabled() this.enabled(value)
selected let value = this.selected() this.selected(value)
visible let value = this.visible() this.visible(value)
visualControl let value = this.visualControl() this.visualControl(value)
left let value = this.left() this.left(value)
top let value = this.top() this.top(value)
width let value = this.width() this.width(value)
height let value = this.height() this.height(value)
msgBox let value = this.msgBox() Not Available
executeManeuver let value = this.executeManeuver() this.executeManeuver(value)
maneuverResolution let value = this.maneuverResolution() this.maneuverResolution(value)

Date

Name Get Set
title let value = this.title() this.title(value)
icon let value = this.icon() Not Available
userDescription let value = this.userDescription() this.userDescription(value)
value let value = this.value() this.value(value)
format let value = this.format() this.format(value)
enabled let value = this.enabled() this.enabled(value)
selected let value = this.selected() this.selected(value)
visible let value = this.visible() this.visible(value)
visualControl let value = this.visualControl() this.visualControl(value)
left let value = this.left() this.left(value)
top let value = this.top() this.top(value)
width let value = this.width() this.width(value)
height let value = this.height() this.height(value)
msgBox let value = this.msgBox() Not Available
executeManeuver let value = this.executeManeuver() this.executeManeuver(value)

CheckBox

Name Get Set
title let value = this.title() this.title(value)
icon let value = this.icon() Not Available
userDescription let value = this.userDescription() this.userDescription(value)
value let value = this.value() this.value(value)
enabled let value = this.enabled() this.enabled(value)
selected let value = this.selected() this.selected(value)
visible let value = this.visible() this.visible(value)
left let value = this.left() this.left(value)
top let value = this.top() this.top(value)
width let value = this.width() this.width(value)
height let value = this.height() this.height(value)
msgBox let value = this.msgBox() Not Available
executeManeuver let value = this.executeManeuver() this.executeManeuver(value)

Button

Name Get Set
title let value = this.title() this.title(value)
userDescription let value = this.userDescription() this.userDescription(value)
value let value = this.value() this.value(value)
enabled let value = this.enabled() this.enabled(value)
selected let value = this.selected() this.selected(value)
visible let value = this.visible() this.visible(value)
left let value = this.left() this.left(value)
top let value = this.top() this.top(value)
width let value = this.width() this.width(value)
height let value = this.height() this.height(value)
msgBox let value = this.msgBox() Not Available
executeManeuver let value = this.executeManeuver() this.executeManeuver(value)

Symbol

Name Get Set
title let value = this.title() this.title(value)
icon let value = this.icon() Not Available
userDescription let value = this.userDescription() this.userDescription(value)
value let value = this.value() this.value(value)
enabled let value = this.enabled() this.enabled(value)
minValue let value = this.minValue() this.minValue(value)
maxValue let value = this.maxValue() this.maxValue(value)
selected let value = this.selected() this.selected(value)
visible let value = this.visible() this.visible(value)
visualControl let value = this.visualControl() this.visualControl(value)
left let value = this.left() this.left(value)
top let value = this.top() this.top(value)
width let value = this.width() this.width(value)
height let value = this.height() this.height(value)
msgBox let value = this.msgBox() Not Available
executeManeuver let value = this.executeManeuver() this.executeManeuver(value)

View

Name Get Set
title let value = this.title() this.title(value)
icon let value = this.icon() Not Available
close let value = this.close() Not Available
scaleMode let value = this.scaleMode() this.scaleMode(value)
scaleValue let value = this.scaleValue() this.scaleValue(value)
msgBox let value = this.msgBox() Not Available
elements let value = this.elements() Not Available
noOfElements let value = this.noOfElements() Not Available
args let value = this.args() Not Available
viewArgs let value = this.viewArgs() Not Available
viewVariables let value = this.viewVariables() this.viewVariables(value)
viewFunctions let value = this.viewFunctions() this.viewFunctions(value)

TableRow

Name Get Set
title let value = this.title() this.title(value)
enabled let value = this.enabled() this.enabled(value)
visible let value = this.visible() this.visible(value)
visualControl let value = this.visualControl() this.visualControl(value)
msgBox let value = this.msgBox() Not Available

ListView

Name Get Set
title let value = this.title() this.title(value)
msgBox let value = this.msgBox() Not Available
elements let value = this.elements() Not Available
noOfElements let value = this.noOfElements() Not Available
args let value = this.args() Not Available
viewArgs let value = this.viewArgs() Not Available
viewVariables let value = this.viewVariables() this.viewVariables(value)
viewFunctions let value = this.viewFunctions() this.viewFunctions(value)

ViewContainer

Name Get Set
icon let value = this.icon() Not Available
enabled Not Available Not Available
selected let value = this.selected() this.selected(value)
visible let value = this.visible() this.visible(value)
left let value = this.left() this.left(value)
top let value = this.top() this.top(value)
width let value = this.width() this.width(value)
height let value = this.height() this.height(value)
openView let value = this.openView() Not Available
close let value = this.close() Not Available
currentView let value = this.currentView() Not Available
msgBox let value = this.msgBox() Not Available

TableValueColumn

Name Get Set
visible let value = this.visible() this.visible(value)

List

Name Get Set
visible let value = this.visible() this.visible(value)
msgBox let value = this.msgBox() Not Available
next let value = this.next() Not Available
previous let value = this.previous() Not Available
currentSelection let value = this.currentSelection() Not Available

Table

Name Get Set
visible let value = this.visible() this.visible(value)
msgBox let value = this.msgBox() Not Available
next let value = this.next() Not Available
previous let value = this.previous() Not Available
currentSelection let value = this.currentSelection() Not Available

Separator

Name Get Set
visible let value = this.visible() this.visible(value)

Session

Name Get Set
left let value = this.left() Not Available
top let value = this.top() Not Available
width let value = this.width() Not Available
height let value = this.height() Not Available
currentLanguage let value = this.currentLanguage() this.currentLanguage(value)
user let value = this.user() Not Available
msgBox let value = this.msgBox() Not Available
debugMsg let value = this.debugMsg() Not Available
peek let value = this.peek() Not Available
poke let value = this.poke() Not Available
getLocalSettings let value = this.getLocalSettings() Not Available
saveLocalSettings let value = this.saveLocalSettings() this.saveLocalSettings(value)
removeLocalSettings let value = this.removeLocalSettings() this.removeLocalSettings(value)
clearAllLocalSettings let value = this.clearAllLocalSettings() this.clearAllLocalSettings(value)
logLevel let value = this.logLevel() this.logLevel(value)
commLogLevel let value = this.commLogLevel() this.commLogLevel(value)
densityFactor let value = this.densityFactor() this.densityFactor(value)
multiplePopups let value = this.multiplePopups() this.multiplePopups(value)
theme let value = this.theme() Not Available
gestures let value = this.gestures() Not Available
scaleModes let value = this.scaleModes() Not Available
transitions let value = this.transitions() Not Available
openLink let value = this.openLink() this.openLink(value)

ALL

Name Get Set
type let value = this.type() Not Available
name let value = this.name() Not Available