Lianja

From Lianjapedia
Jump to: navigation, search

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      
Minimized W Boolean (Int) Set / unset main window to minimized      
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).      
applyMetaData None Apply MetaData to all pages in the current App. (From v3.4).      
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).      
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. In the LianjaWebFramework, business procedures in custom libraries on the server can also be called. (From v2.0).
To call a procedure in a library, prefix the procedure name with the library name and '::'
var result = Lianja.evaluate("mylib::myproc()");
     
evaluateJavaScript functioncall as Character Call server-side JavaScript function and return any result. (From v2.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).      
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).      
GetCurrentLocation None Currently unused; returns .F.      
getCurrentPosition onSuccess as Function, onError as Function Return the current position as a position object. (From v2.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 is not specified, a source selection prompt is displayed and the file URI is returned. (From v2.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      
isConnected None Return logical true if connected, false otherwise. (From v2.0).      
isDevMode None Return logical true if on desktop (App Builder or App Center desktop client), 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).      
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. In the Web and Mobile Clients, the #id selectors #username and #password are used and should be defined before calling Lianja.login().      
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      
pauseHttpServer None Pause the internal http server. (From v3.0).      
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      
resumeHttpServer None Resume the internal http server. (From v3.0).      
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      
setupUI None Execute setupui.prg      
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 and Mobile Clients, 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 and Mobile Clients, 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. See Using the showdocument() function and Lianja.showDocument() method for details.      
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.      
showPagesMenu None Show the Pages Menu. This is the same as clicking or touching the "Hamburger" Pages Menu icon. It is most useful in conjunction with gestures in mobile Apps. The equivalent Lianja.showDocument("showpagesmenu") can also be used. (From v3.0).      
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 app as Character Run the specified App      
startHttpServer [port as Numeric] Start the internal http server, optionally specifying the port number. The default port is 8002 for the App Builder and 8003 for the App Center. (From v3.0).      
stopHttpServer None Stop the internal http server. (From v3.0).      
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).      
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