Accessible functions of the $app variable (spApplication object)

function

description

prototype

returns

Notes

findComponent

search component reference on component name

findComponentByName($theCompName)

component reference or false

Traverses the component tree to find the required component

login

wrapper around the root component to login

login($uid, $pwd)

true/false

logoff

wrapper around the root component to logoff

logoff()

true/false

redirect

redirect to the given url

Redirect($theUrl, $origin, $parms=,$initialformmode)

Can be used in a regular status and within an ajax event. Origin: current module as recepient, parms: a=b&c=d&… parameter pairs, initialformmode: the form mode to start the next application in (insert, edit, delete, none) The parameter string will be encrypted using the project settings for security.

showMessage

Sets a session variable

showMessage($theMsg)

nothing

This function sets a session variable that is maintained over the same session.