Lianja

Properties

This class supports the following properties:

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
args	RW	Character	Arguments passed to current App. From v6.0.
availablecameralist	R	Character	Comma separated list of available cameras. From v7.0.
availablecameras	R	Numeric	Number of available cameras. From v7.0.
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
leftsidebarvisible	W	Boolean	Set / unset Left SideBar visibility
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
rightsidebarvisible	W	Boolean	Set / unset Right SideBar visibility
sessionStorage	R	Object	Return an object reference to the currently active SessionStorage
table	R	Character	Currently active table
Theme	RW	Character	Set/Get the current App theme
UIState	R	Character	The last UI State applied.
version	R	Character	Software version

Methods

This class supports the following methods:

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.
applyMetaData	None	Apply MetaData to all pages in the current App.
beep	None	Sounds a 'beep'.
clearNamedParameters	None	Clear all named parameters previously set using setNamedParameter(name,value). From v5.0.
clipBoard	[clipping as Character]	Read from or write to the system clipboard.
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.
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 [, onsuccess as Function [, onerror as Function]]	Evaluate expression. In the LianjaWebFramework, business procedures in custom libraries on the server can also be called. To call a procedure in a library, prefix the procedure name with the library name and '::' var result = Lianja.evaluate("mylib::myproc()"); The expression can include a scripting language prefix to indicate the target language, i.e. : 'javascript:', 'php:', 'python:'. If none is specified, Lianja/VFP scripting is used.
evaluateAsync	expression as Character [, onsuccess as Function [, onerror as Function]]	Evaluate expression asynchronously. In the LianjaWebFramework, business procedures in custom libraries on the server can also be called. To call a procedure in a library, prefix the procedure name with the library name and '::' var result = Lianja.evaluate("mylib::myproc()"); The expression can include a scripting language prefix to indicate the target language, i.e. : 'javascript:', 'php:', 'python:'. If none is specified, Lianja/VFP scripting is used. From v5.3.
evaluateJavaScript	functioncall as Character	Call server-side JavaScript function and return any result.
evaluatePython	functioncall as Character	Call server-side Python function and return any result.
execute	command as Character	Execute command.
FindElementByID	id as Character	Return a reference to the object with the specified id. See Working with the Lianja Object Model for more details.
fullPath	filename as Character	Returns the specified file's full path as a character string. The filename can be prefixed with known locations and will be translated i.e. app:/, lib:/, page lib:/, extensions:/, packages:/, data:/, themes:/, metatypes:/, cloudserver:/, wwwroot:/, images:/. From v5.0.
generateAppDoc	[filename as Character]	Generate App Doc for the current App. If the filename is specified, it will be used, otherwise the file will be created in the current directory as <app-name>.html. The default file extension is '.html'. From v5.5.
generateDbDoc	[filename as Character]	Generate Database Doc for the current App's currently open database. If the filename is specified, it will be used, otherwise the file will be created in the current directory as <database-name>.html. The default file extension is '.html'. From v5.5.
get	id as Character	Return a reference to the object with the specified id. See Working with the Lianja Object Model for more details.
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.
getAttr	name as Character	Returns the value of the named App setting. From v5.5. See also Custom Builders.
getAudio		See Developing PWA Apps.
getConnection	None	Return the connection type, e.g. 'WiFi connection'.
getControlsource	controlsource as Character	Return a reference to the formitem bound to the specified controlsource. See Working with the Lianja Object Model for more details.
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.
GetCurrentLocation	None	Currently unused; returns .F.
getCurrentPosition	onSuccess as Function, onError as Function	Return the current position as a position object.
getData	controlsource as Character	Return the current value of the specified data controlsource. From v8.0.
getDialogResult	None	Works in conjunction with the Lianja.setDialogResult() method to return the set value. It can also be used to return the result of the Lianja.showMoverDialog() method on the desktop.
getElementByControlsource	controlsource as Character	Return a reference to the formitem bound to the specified controlsource. See Working with the Lianja Object Model for more details.
getElementByID	id as Character	Return a reference to the object with the specified id. See Working with the Lianja Object Model for more details.
getFiles		See Developing PWA Apps.
getOrientation		See Developing PWA Apps.
getPhoto		See Developing PWA Apps.
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.
getURL	url as Character [, username as Character, password as Character [, filename as Character]]	Return a string or, if filename is specified, the file size. From v5.0.
getVideo		See Developing PWA Apps.
hideDialog	None	Hide the current modal Dialog if one is visible.
hideDialogPage	[zoomin as Boolean]	Hide the most recent Dialog Page (Lianja.showDialogPage()) if one is visible. From v6.2.1.
hideDialogPanel	None	Hide the current DialogPanel if one is visible.
hideLoadingMessage	None	Hide the current Loading Message if one is visible.
hideMessage	None	Hide the current Message if one is visible.
hideNavigationPanel	None	Hide the Navigation Panel if one is visible. From v5.4.
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.
isDesktop	None	Return logical true if on desktop (App Builder or App Center desktop client), false otherwise. From v8.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.
isPhone	None	Return logical true if client is phone mobile device, false otherwise. From v8.0.
isPhoneGap	None	Return logical true if client is mobile device, false otherwise.
isRuntimeMode	None	Return logical true if in runtime mode, false otherwise.
isTablet	None	Return logical true if client is tablet mobile device, false otherwise. From v8.0.
Item	position as Numeric	Return a reference to the Page object at the specified position.
loadAddIns	None	Searches the "Additional file path" and for each of the paths will load a library if a file of the same name as the directory exists. This supports all scripting languages i.e. prg/dbo, js, ts, py, php, esx. From v5.0.
loadLibrary	filename as Character	This loads a library and supports all scripting languages i.e. prg/dbo, js, ts, py, php, esx. The fllename can be prefixed with known locations and will be translated i.e. app:/, lib:/, page lib:/, extensions:/, packages:/, data:/, themes:/, metatypes:/, cloudserver:/, wwwroot:/, images:/. When using Lianja.loadLibrary() in development mode any changes to the library are detected and it is reloaded. Returns logical. From v5.0.
loadReport	section_fullname as Character, reportname as Character [, filter as Character]	This loads the specified existing report into the specified section. An optional filter can be specified. From v5.0.
Log	logtext as Character	Write the logtext string to the log
LogEvent	logtext as Character	Write the logtext string out to the Performance Metrics tab in the Troubleshooter. From v5.0.
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
makePayment		See Developing PWA Apps
openApp	app as Character [?args=<arguments>]	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.
popDataSession	None	Restore the current data session. Equivalent of the LianjaScript POP DATASESSION command, but available in all supported scripting languages in desktop Apps. Ignored in Web/Mobile Apps. Session can be saved using Lianja.pushDataSession(). From v8.0.
printHtml	id as character | html as Character, filename as Character [, options as Character]	Print the specified HTML. In the web/mobile client specify the id of a UI Element, the browser print dialog will be displayed. On the desktop, specify an expression to return an html string, a PDF filename and printing options. The filename can be an empty string, with a printer destination specified in the options, e.g. "papersize=custom,3.00,1.00,inch@@printer=\\127.0.0.1\HP DeskJet 2600 series". The options can include any of the properties handled by a report section as well as: printer=printername e.g. \\sharedname\printername orientation=landscape | portrait papersize=letter | a4 | etc.
printReport	reportname as Character [, options as Character]	Print the specified report. The options can include any of the properties handled by a report section as well as: printer=printername e.g. \\sharedname\printername orientation=landscape | portrait papersize=letter | a4 | etc. e.g. "papersize=custom,3.00,1.00,inch@@printer=\\127.0.0.1\HP DeskJet 2600 series".
pushDataSession	None	Save the current data session. Equivalent of the LianjaScript PUSH DATASESSION command, but available in all supported scripting languages in desktop Apps. Ignored in Web/Mobile Apps. Session can be restored using Lianja.popDataSession(). From v8.0.
refreshAppInspector	None	Refresh the attributes in the App Inspector and the Page Builder Assistant. Call this after setting attributes programatically. From v5.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.
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
saveApp	None	Saves the current App. From v5.5. See also Custom Builders.
SelectWorkspace	workspace as Character	Select the specified Workspace
setAttr	name as Character, value as expression	Sets the named App setting to the specified value. From v5.5. See also Custom Builders.
setData	controlsource as Character, value as expression	Sets the controlsource from the current cursor to the specified expression. From v8.0.
setDialogResult	result as Character	Set the result for a dialog or dialog panel, e.g. in a custom button. The Lianja.getDialogResult() method can be used to return the set value.
SetFocusInSearchBox	None	Set the focus to the Instant Search Box
setNamedParameter	name as Character, value as Character	Set the specified named parameter to the specified value. This can be used to set {parameter} or ?parameter macros in virtual table definitions. From v5.0.
setRelationship	page as character, parentSection as character, childSection as character, parentKey as character, childKey as character	Relate two sections. From v5.0.
setupUI	None	Execute setupui.prg
showAppWizard	None	Displays the App Wizard. From v5.5. See also Custom Builders.
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, .jssp or .pysp script or (from Lianja v5.3) a Visual Component. From v6.0, App UILib pages are supported in the Web and Mobile Clients. Note: the width and height must be specified in JavaScript desktop code.
showDialogForm	title as Character, formcontentproducer as Character	Pop up the specified form based on the formcontentproducer. The formcontentproducer is a Visual Component form saved as a LianjaScript (.prg/.dbo), Javascript (.js) or Python (.py) script. The formcontentproducer specification can include '?' followed by ';' separated name=value property pairs. If no extension is specified, '.dbo' is assumed. The "app:/appname" prefix can be used to access a form in the App referenced by "appname". From v7.2. Note: in the Web Client, Lianja.showDialogForm() is a synonym of Lianja.showDialogPage().
showDialogPage	title as Character, contentproducer as Character [, zoomout as Boolean]	Animate a dialog page over the Page viewport. The contentproducer can be a URL (e.g. "https://www.lianja.com"), a .rsp, .jssp or .pysp script, a Visual Component or a "funcname()" string that dynamically creates a container. By default, the title is centered in the titlebar, which includes a righthand x to close. The title can be specified as an empty string ("") to omit the titlebar or include the following special characters: "<" (lefthand < in titlebar) "<x" (lefthand x in titlebar) ">x" (righthand x in titlebar) "< Back" (lefthand click to go back in titlebar) Dialog pages are stacked. They can be removed from the stack with Lianja.hideDialogPage(). The dialog page 'zooms out' by default. In the web client, if zoomout is false, the dialog page 'fades in'. From v6.2.1.
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, .jssp or .pysp script or (from Lianja v5.3) a Visual Component. From v6.0, App UILib pages are supported in the Web and Mobile Clients. Prefix the page specification with '-' to disable the default 'Done' and 'Cancel' buttons, e.g. '-page5'. 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.
showErrorMessageWithIcon	message as Character [, notimeout as Boolean | timeoutinverval as Numeric]	Show the specified message. If notimeout is true, the user must click/touch to hide the message. If notimeout is false (default), the message will be hidden after 5000 milliseconds. Alternatively, timoutinterval can be specfied in milliseconds to hide the message after that interval. From v6.2, timoutinterval added in v6.2.1.
showForm	title as Character, form as Character	Activate form built with the Form Designer. From v8.0.
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.
showLoadingMessage	message as Character [, theme as Character]	Show the specified message. In the web client, the message can also be the name of a .rsp file. The theme is supported in the web client ("a", "b", "c" or "d"). On the desktop, Lianja.showLoadingMessage() is the same as Lianja.showMessage().
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.
showMessageWithIcon	message as Character [, notimeout as Boolean | timeoutinverval as Numeric]	Show the specified message. If notimeout is true, the user must click/touch to hide the message. If notimeout is false (default), the message will be hidden after 5000 milliseconds. Alternatively, timoutinterval can be specfied in milliseconds to hide the message after that interval. From v6.2, timoutinterval added in v6.2.1.
showMoverDialog	title as Character, caption as Character, items as Character, selecteditems as Character [, targetid as Character]	Pop up a standard dialog to display the StringList Editor. For the Web and Mobile Clients, the targetid arg is required. See the StringList Editor for additional information. From v5.3.
showNavigationPanel	None	Show the Navigation Panel if one is defined and not visible. From v5.4.
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.
showPickList	title as Character, onselect as Function, oncancel as Function, width as Numeric, width as height, database as Character, table as Character, filter as Character, columns as JSON	Show a pick list of rows from a table. From v6.3. In LianjaScript the picklist is modal and the onselect and oncancel functions are not required. See here for more details.
ShowProgressBar	value as Numeric, maxvalue as Numeric	Shows the ProgressBar at position value with a maximum of maxvalue
showQueryBuilder	sectionid as Character, database as Character, table as Character [, columns as Character [, filter as Character [, modal as Boolean [, minbuttons as Boolean]]]]	Pop up a standard dialog and embed the Query Builder in it. The sectionid should be fully qualified, e.g. "page1.section". The database and table define the database to use and the table to be queried in the Query Builder. Optionally specify the columns to be included (default is all), a filter expression (use OData Operators), whether the dialog should be modal (default is false, ignored on non-desktop clients) and whether only the 'Cancel' and 'Done' buttons should be displayed (default is false).
showQueryBuilderPanel	sectionid as Character, database as Character, table as Character [, columns as Character [, filter as Character [, position as Character]]]	Slide a dialogPanel in from the right of the main window and embed the Query Builder in it. The sectionid should be fully qualified, e.g. "page1.section". The database and table define the database to use and the table to be queried in the Query Builder. Optionally specify the columns to be included (default is all) and a filter expression (use OData Operators). On non-desktop clients, the position can be specified as 'left' to slide the dialogPanel in from the left.
showQueryPicker	title as Character, onselect as Character, database as Character, table as Character [, parameters as Character]	Slide a dialogPanel in from the right of the main window and embed the Query Picker. The database and table define the database to use and the table that will be displayed in the grid. For details of the parameters, see Query Picker Parameters.
showQueryPickerPanel	title as Character, onselect as Character, database as Character, table as Character [, parameters as Character [, width as Numeric]]	Pop up a standard dialog and embed the Query Picker. The database and table define the database to use and the table that will be displayed in the grid. For details of the parameters, see Query Picker Parameters. On non-desktop clients, width determines the width of the dialogPanel. If it 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. The default width is 900 pixels.
showReportViewer	reportname as Character [, options as Character]	Show the specified report in the viewer. The options can include any of the properties handled by a report section as well as: printer=printername e.g. \\sharedname\printername orientation=landscape | portrait papersize=letter | a4 | etc. e.g. "papersize=custom,3.00,1.00,inch@@printer=\\127.0.0.1\HP DeskJet 2600 series".
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.
showSuccessMessageWithIcon	message as Character [, notimeout as Boolean | timeoutinverval as Numeric]	Show the specified message. If notimeout is true, the user must click/touch to hide the message. If notimeout is false (default), the message will be hidden after 5000 milliseconds. Alternatively, timoutinterval can be specfied in milliseconds to hide the message after that interval. From v6.2, timoutinterval added in v6.2.1.
showWarningMessage	message as Character	Show the specified message.
showWarningMessageWithIcon	message as Character [, notimeout as Boolean | timeoutinverval as Numeric]	Show the specified message. If notimeout is true, the user must click/touch to hide the message. If notimeout is false (default), the message will be hidden after 5000 milliseconds. Alternatively, timoutinterval can be specfied in milliseconds to hide the message after that interval. From v6.2, timoutinterval added in v6.2.1.
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.
stopHttpServer	None	Stop the internal http server.
switchDatabase	name as Character	Switches to the specified database at runtime. This should contain tables with the same name and structure. From v5.0. Supported in JavaScript as well as Lianja/VFP in desktop Apps from v5.3.2 (previously only supported in Web/mobile Apps).
switchLanguage	code as Character	Switches to the language code specified. See Automatic Language Translation for more details. From v5.5.
toggleleftsidebarvisibility	None	Toggle left sidebar visibility
toggleNavigationPanel	None	Toggle Navigation Panel visiblity. From v5.4.
togglerightsidebarvisibility	None	Toggle right sidebar visibility
UnwatchFile	filename as Character | directory as Character	Stop watching the specified file or directory for changes. Use the WatchFile() method to watch a file/directory.
uploadImageFiles	controlsource as Character, [multiple as Boolean, [title as Character, [onsuccess as Function, [onerror as Function]]]]	Displays a file selection dialog popup where the user can select one or more image files. The files are automatically uploaded and a new record (per image file) inserted into the target table on the server in the (blob) column as specified by the controlsource (table.column). The table must be open in the current App. If the optional multiple is true, multiple files can be selected, if false, only one file can be selected. The optional onsuccess function is passed one argument: a string containing a comma separated list of the files uploaded. From v5.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'.
WatchFile	filename as Character | directory as Character	Watch the specified file or directory for changes. There is a corresponding App delegate called filesystemwatcher which is called with one argument, the file/directory that has changed. Use the UnwatchFile() method to stop watching the file/directory.
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).

Key

	Supported on this client. Note that for the web/mobile client, this applies to client-side code. The Lianja system object is not available in server-side functions and procedures.
	Supported in Lianja/VFP scripting only on this client.
	Not currently supported on this client.