Difference between revisions of "Lianja"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
Line 1: | Line 1: | ||
− | |||
− | |||
====Properties==== | ====Properties==== | ||
Line 24: | Line 22: | ||
|valign="top"|Character | |valign="top"|Character | ||
|valign="top"|Full path of the current App directory | |valign="top"|Full path of the current App directory | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 40: | Line 38: | ||
|valign="top"|Numeric | |valign="top"|Numeric | ||
|valign="top"|Number of [[PageBuilder|Pages]] in the current App | |valign="top"|Number of [[PageBuilder|Pages]] in the current App | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 56: | Line 54: | ||
|valign="top"|Character | |valign="top"|Character | ||
|valign="top"|Full path of the current database directory | |valign="top"|Full path of the current database directory | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 72: | Line 70: | ||
|valign="top"|Boolean (Int) | |valign="top"|Boolean (Int) | ||
|valign="top"|Set / unset main window to fullscreen | |valign="top"|Set / unset main window to fullscreen | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 80: | Line 78: | ||
|valign="top"|Character | |valign="top"|Character | ||
|valign="top"|Full path of the current library directory | |valign="top"|Full path of the current library directory | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 88: | Line 86: | ||
|valign="top"|Boolean | |valign="top"|Boolean | ||
|valign="top"|Lock screen, disabling screen updates | |valign="top"|Lock screen, disabling screen updates | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 104: | Line 102: | ||
|valign="top"|Boolean (Int) | |valign="top"|Boolean (Int) | ||
|valign="top"|Set / unset main window to maximized | |valign="top"|Set / unset main window to maximized | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 112: | Line 110: | ||
|valign="top"|Character | |valign="top"|Character | ||
|valign="top"|Progress bar text label | |valign="top"|Progress bar text label | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 120: | Line 118: | ||
|valign="top"|Int | |valign="top"|Int | ||
|valign="top"|Progress bar maximum value | |valign="top"|Progress bar maximum value | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 128: | Line 126: | ||
|valign="top"|Int | |valign="top"|Int | ||
|valign="top"|Progress bar minimum value | |valign="top"|Progress bar minimum value | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 136: | Line 134: | ||
|valign="top"|Int | |valign="top"|Int | ||
|valign="top"|Set progress bar to the specified value | |valign="top"|Set progress bar to the specified value | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 168: | Line 166: | ||
|valign="top"|Character | |valign="top"|Character | ||
|valign="top"|Set/Get the current App theme | |valign="top"|Set/Get the current App theme | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 202: | Line 200: | ||
|valign="top"|id as Character, caption as Character | |valign="top"|id as Character, caption as Character | ||
|valign="top"|Add a new [[PageBuilder|Page]] with the specified id and caption | |valign="top"|Add a new [[PageBuilder|Page]] with the specified id and caption | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 237: | Line 235: | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Close the currently open App | |valign="top"|Close the currently open App | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 251: | Line 249: | ||
|valign="top"|output as Character | |valign="top"|output as Character | ||
|valign="top"|Write the output string to the Console Output Window | |valign="top"|Write the output string to the Console Output Window | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 258: | Line 256: | ||
|valign="top"|app as Character | |valign="top"|app as Character | ||
|valign="top"|Create the specified App | |valign="top"|Create the specified App | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 272: | Line 270: | ||
|valign="top"|app as Character, filename as Character [, pagecenter as Logical] | |valign="top"|app as Character, filename as Character [, pagecenter as Logical] | ||
|valign="top"|Deploy image file for App or Page Center. | |valign="top"|Deploy image file for App or Page Center. | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 314: | Line 312: | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Returns a JSON string of App Categories and the Apps in those Categories | |valign="top"|Returns a JSON string of App Categories and the Apps in those Categories | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: green"| | |style="background: green"| | ||
|style="background: green"| | |style="background: green"| | ||
Line 321: | Line 319: | ||
|valign="top"|app as Character | |valign="top"|app as Character | ||
|valign="top"|Returns a JSON string of information about the specified App | |valign="top"|Returns a JSON string of information about the specified App | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: green"| | |style="background: green"| | ||
|style="background: green"| | |style="background: green"| | ||
Line 398: | Line 396: | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Hide the ProgressBar if one is visible | |valign="top"|Hide the ProgressBar if one is visible | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 405: | Line 403: | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Return to the App Center | |valign="top"|Return to the App Center | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: green"| | |style="background: green"| | ||
|style="background: green"| | |style="background: green"| | ||
Line 440: | Line 438: | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Return logical true if in runtime mode, false otherwise | |valign="top"|Return logical true if in runtime mode, false otherwise | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: green"| | |style="background: green"| | ||
|style="background: green"| | |style="background: green"| | ||
Line 447: | Line 445: | ||
|valign="top"|position as Numeric | |valign="top"|position as Numeric | ||
|valign="top"|Return a reference to the [[PageBuilder|Page]] object at the specified position | |valign="top"|Return a reference to the [[PageBuilder|Page]] object at the specified position | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 454: | Line 452: | ||
|valign="top"|logtext as Character | |valign="top"|logtext as Character | ||
|valign="top"|Write the logtext string to the log | |valign="top"|Write the logtext string to the log | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 461: | Line 459: | ||
|valign="top"|username as Character, password as Character | |valign="top"|username as Character, password as Character | ||
|valign="top"|Log in with the specified username and password | |valign="top"|Log in with the specified username and password | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 468: | Line 466: | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Log out and return to the login screen | |valign="top"|Log out and return to the login screen | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: green"| | |style="background: green"| | ||
|style="background: green"| | |style="background: green"| | ||
Line 496: | Line 494: | ||
|valign="top"|id as Character | |valign="top"|id as Character | ||
|valign="top"|Remove the specified [[PageBuilder|Page]] | |valign="top"|Remove the specified [[PageBuilder|Page]] | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 503: | Line 501: | ||
|valign="top"|property as Character | |valign="top"|property as Character | ||
|valign="top"|Remove the specified property | |valign="top"|Remove the specified property | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 510: | Line 508: | ||
|valign="top"|existing as Object | |valign="top"|existing as Object | ||
|valign="top"|Remove the specified tool | |valign="top"|Remove the specified tool | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 517: | Line 515: | ||
|valign="top"|executable as Character [, args as Character] | |valign="top"|executable as Character [, args as Character] | ||
|valign="top"|Run the specified executable passing the optionally specified comma-separated list of arguments | |valign="top"|Run the specified executable passing the optionally specified comma-separated list of arguments | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 524: | Line 522: | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Return the runtime caption | |valign="top"|Return the runtime caption | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 531: | Line 529: | ||
|valign="top"|workspace as Character | |valign="top"|workspace as Character | ||
|valign="top"|Select the specified Workspace | |valign="top"|Select the specified Workspace | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 538: | Line 536: | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Set the focus to the Instant Search Box | |valign="top"|Set the focus to the Instant Search Box | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 573: | Line 571: | ||
|valign="top"|title as Character, tablename as Character[, topic as Character[, showbuttons as Boolean]] | |valign="top"|title as Character, tablename as Character[, topic as Character[, showbuttons as Boolean]] | ||
|valign="top"|Display help information. The tablename is the name of a table with the structure of:<br>helptopic char(60)<br>helptext memo<br>The table should be indexed on helptopic. For examples, please see the [[SHOWHELP()]] function. | |valign="top"|Display help information. The tablename is the name of a table with the structure of:<br>helptopic char(60)<br>helptext memo<br>The table should be indexed on helptopic. For examples, please see the [[SHOWHELP()]] function. | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 594: | Line 592: | ||
|valign="top"|value as Numeric, maxvalue as Numeric | |valign="top"|value as Numeric, maxvalue as Numeric | ||
|valign="top"|Shows the ProgressBar at position value with a maximum of maxvalue | |valign="top"|Shows the ProgressBar at position value with a maximum of maxvalue | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 608: | Line 606: | ||
|valign="top"|executable as Character [, args as Character] | |valign="top"|executable as Character [, args as Character] | ||
|valign="top"|Run the specified executable passing the optionally specified comma-separated list of arguments | |valign="top"|Run the specified executable passing the optionally specified comma-separated list of arguments | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 615: | Line 613: | ||
|valign="top"|command as Character | |valign="top"|command as Character | ||
|valign="top"|Run the specified [[Command Line Switches|command]] | |valign="top"|Run the specified [[Command Line Switches|command]] | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 622: | Line 620: | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Return the domain/tenancy for the current user | |valign="top"|Return the domain/tenancy for the current user | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 629: | Line 627: | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Return the username for the current user | |valign="top"|Return the username for the current user | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 636: | Line 634: | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Return the roles for the current user | |valign="top"|Return the roles for the current user | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 643: | Line 641: | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Return the current Lianja version (HTML formatted) | |valign="top"|Return the current Lianja version (HTML formatted) | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 657: | Line 655: | ||
|valign="top"|debugtext as Character | |valign="top"|debugtext as Character | ||
|valign="top"|Write the debugtext string to the debug file | |valign="top"|Write the debugtext string to the debug file | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
|style="background: red"| | |style="background: red"| | ||
|style="background: red"| | |style="background: red"| | ||
Line 700: | Line 698: | ||
| Supported on this client | | Supported on this client | ||
|- | |- | ||
− | |style="text-align: center;background: | + | |style="text-align: center;background: lightgreen"| |
| Supported in Lianja/VFP scripting only on this client | | Supported in Lianja/VFP scripting only on this client | ||
|- | |- |
Revision as of 13:03, 3 September 2015
Contents
Properties
This class supports the Common Properties plus the following:
Property | Access | Value | Description | Desktop | Web | Mobile |
---|---|---|---|---|---|---|
activepage | RW | Object | Return an object reference to the currently active Page | |||
Appdir | R | Character | Full path of the current App directory | |||
application | R | Character | Currently active App | |||
Count | R | Numeric | Number of Pages in the current App | |||
database | R | Character | Currently active database | |||
Datadir | R | Character | Full path of the current database directory | |||
editor | R | Object | Return an object reference to the Editor | |||
Fullscreen | W | Boolean (Int) | Set / unset main window to fullscreen | |||
Libdir | R | Character | Full path of the current library directory | |||
LockScreen | W | Boolean | Lock screen, disabling screen updates | |||
localStorage | R | Object | Return an object reference to the currently active LocalStorage | |||
Maximized | W | Boolean (Int) | Set / unset main window to maximized | |||
ProgressLabel | W | Character | Progress bar text label | |||
ProgressMaximum | W | Int | Progress bar maximum value | |||
ProgressMinimum | W | Int | Progress bar minimum value | |||
ProgressValue | W | Int | Set progress bar to the specified value | |||
sessionStorage | R | Object | Return an object reference to the currently active SessionStorage | |||
sidebarvisible | W | Boolean (Int) | Set / unset SideBar visibility | |||
table | R | Character | Currently active table | |||
Theme | RW | Character | Set/Get the current App theme | |||
version | R | Character | Software version |
Methods
This class supports the Common Methods plus the following:
Method | Args | Description | Desktop | Web | Mobile |
---|---|---|---|---|---|
addObject | existing as Object | newobject as Character, class as Character [, caption as Character] | Add an existing object or a new object, in which case the object's class must also be specified and optionally its caption | |||
AddPage | id as Character, caption as Character | Add a new Page with the specified id and caption | |||
addProperty | property as Character, value as Expression | Add a property and set its value | |||
AddTool | class as Character, caption as Character | Add a tool | |||
alert | message as Character | Show the specified message. (From v2.0.0). | |||
beep | None | Sounds a 'beep' | |||
CloseApp | None | Close the currently open App | |||
confirm | message as Character, callback as Function | Show the specified message and pass the result (true|false) to the callback function. (From v2.0.0). | |||
Console | output as Character | Write the output string to the Console Output Window | |||
CreateApp | app as Character | Create the specified App | |||
createCursor | database as Character, table as Character | Return a reference to a Cursor object for the specified table from the specified database. | |||
DeployAppIcon | app as Character, filename as Character [, pagecenter as Logical] | Deploy image file for App or Page Center. | |||
evaluate | expression as Character | Evaluate expression | |||
evaluateJavaScript | functioncall as Character | Call server-side JavaScript function and return any result. (From v2.0.0). | |||
execute | command as Character | Execute command | |||
FindElementByID | id as Character | Return a reference to the object with the specified id | |||
get | id as Character | Return a reference to the object with the specified id | |||
GetAppCategories | None | Returns a JSON string of App Categories and the Apps in those Categories | |||
GetAppInfo | app as Character | Returns a JSON string of information about the specified App | |||
getConnection | None | Return the connection type, e.g. 'WiFi connection'. (From v2.0.0). | |||
getCursor | alias as Character | Return a reference to a Cursor object for the specified table alias | |||
getCurrentAcceleration | onSuccess as Function, onError as Function | Return the current acceleration along the x, y, and z axes as an object. (From v2.0.0). | |||
GetCurrentLocation | None | Currently unused; returns .F. | |||
getCurrentPosition | onSuccess as Function, onError as Function | Return the current position as a position object. (From v2.0.0). | |||
getElementByID | id as Character | Return a reference to the object with the specified id | |||
getPicture | onSuccess as Function, onError as Function [, cameraOptions as Object] |
Take a photo using the camera or retrieve a photo from the device's image gallery. Returns a file URI or base64 string. If cameraOptions isnot specified, a source selection prompt is displayed and the file URI is returned. (From v2.0.0). | |||
hideDialog | None | Hide the current modal Dialog if one is visible | |||
hideDialogPanel | None | Hide the current DialogPanel if one is visible | |||
hideMessage | None | Hide the current Message if one is visible | |||
HideProgressBar | None | Hide the ProgressBar if one is visible | |||
home | None | Return to the App Center | |||
isDevMode | None | Return logical true if in development mode, false otherwise | |||
IsLoadingApp | None | Return logical true if loading App, false otherwise | |||
IsKioskMode | None | Return logical true if in kiosk mode, false otherwise | |||
isPhoneGap | None | Return logical true if client is mobile device, false otherwise. (From v2.0.0). | |||
isRuntimeMode | None | Return logical true if in runtime mode, false otherwise | |||
Item | position as Numeric | Return a reference to the Page object at the specified position | |||
Log | logtext as Character | Write the logtext string to the log | |||
login | username as Character, password as Character | Log in with the specified username and password | |||
logout | None | Log out and return to the login screen | |||
openApp | app as Character | Open the specified App | |||
openDatabase | database as Character | Open the specified database and return a Database object reference | |||
RemoveObject | existing as Object | Remove the specified object | |||
RemovePage | id as Character | Remove the specified Page | |||
RemoveProperty | property as Character | Remove the specified property | |||
RemoveTool | existing as Object | Remove the specified tool | |||
Run | executable as Character [, args as Character] | Run the specified executable passing the optionally specified comma-separated list of arguments | |||
RuntimeCaption | None | Return the runtime caption | |||
SelectWorkspace | workspace as Character | Select the specified Workspace | |||
SetFocusInSearchBox | None | Set the focus to the Instant Search Box | |||
showDialog | title as Character, page as Character[, width as Numeric[, height as Numeric[, buttons as Numeric[, ontop as Numeric[, modal as Numeric[, action as Character[, text as Character[, resizable as Numeric]]]]]]]] | Pop up a standard dialog and embed the specified page from the page library into it. For the Web Client, the page must be a .rsp or .jssp script. | |||
showDialogPanel | title as Character, page as Character[, width as Numeric[, action as Character[, text as Character]]] | Slide a dialogPanel in from the right of the main window and embed the specified page from the page library into it. For the Web Client, the page must be a .rsp or .jssp script. If width is a negative number, the dialogPanel will slide from the left. Specifying a width of "100%" will animate the dialogPanel in place and it will occupy the whole page viewport (Web client). | |||
showDocument | action as Character | filename as Character | Perform a Lianja UI action. On the desktop, it can also open filename using its file association. For examples, see the SHOWDOCUMENT() function. | |||
showErrorMessage | message as Character[, minimumwidth as Numeric | webtitle as Character] | Show the specified message. The minimumwidth is supported on the desktop in Lianja/VFP. If specified, the message stays visible until Lianja.hideMessage() is called. If minimumwidth is > 1 this is the minimum width of the displayed message. If it is = 1, the message is displayed top right; if < 1, centred. The webtitle is supported in web/mobile and if specified, is displayed as the title of the message box. | |||
ShowHelp | title as Character, tablename as Character[, topic as Character[, showbuttons as Boolean]] | Display help information. The tablename is the name of a table with the structure of: helptopic char(60) helptext memo The table should be indexed on helptopic. For examples, please see the SHOWHELP() function. |
|||
showMessage | message as Character[, minimumwidth as Numeric | webtitle as Character] | Show the specified message. The minimumwidth is supported on the desktop in Lianja/VFP. If specified, the message stays visible until Lianja.hideMessage() is called. If minimumwidth is > 1 this is the minimum width of the displayed message. If it is = 1, the message is displayed top right; if < 1, centred. The webtitle is supported in web/mobile and if specified, is displayed as the title of the message box. | |||
showNotification | message as Character, wait as Boolean[, count as Numeric] | [webtitle as Character] | Show the specified notification message. On the desktop, the message is displayed until dismissed by the user if wait is True and the remaining number of notifications can optionally be specified. The webtitle is supported in web/mobile and if specified, is displayed as the title of the message box. | |||
ShowProgressBar | value as Numeric, maxvalue as Numeric | Shows the ProgressBar at position value with a maximum of maxvalue | |||
showSuccessMessage | message as Character[, minimumwidth as Numeric | webtitle as Character] | Show the specified message. The minimumwidth is supported on the desktop in Lianja/VFP. If specified, the message stays visible until Lianja.hideMessage() is called. If minimumwidth is > 1 this is the minimum width of the displayed message. If it is = 1, the message is displayed top right; if < 1, centred. The webtitle is supported in web/mobile and if specified, is displayed as the title of the message box. | |||
Spawn | executable as Character [, args as Character] | Run the specified executable passing the optionally specified comma-separated list of arguments | |||
SpawnApp | command as Character | Run the specified command | |||
UserDomain | None | Return the domain/tenancy for the current user | |||
UserName | None | Return the username for the current user | |||
UserRoles | None | Return the roles for the current user | |||
Version | None | Return the current Lianja version (HTML formatted) | |||
vibrate | seconds as Numeric | On mobile devices, vibrates for the specified number of seconds. On Web Client, sounds a 'beep'. (From v2.0.0). | |||
WriteDebug | debugtext as Character | Write the debugtext string to the debug file | |||
writeError | errortext as Character | Write the errortext string to the Console. | |||
writeLog | logtext as Character | Write the logtext string to the log (desktop) or JavaScript Console (web/mobile). | |||
writeOutput | output as Character | Write the output string to the Output Window (desktop) or JavaScript Console (web/mobile). |
Events
This class supports the Common Events plus the following:
Event | Args | Description |
---|
Key
Supported on this client | |
Supported in Lianja/VFP scripting only on this client | |
Not currently supported on this client |