Difference between revisions of "Lianja"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
Line 213: | Line 213: | ||
|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 | ||
+ | |- | ||
+ | |valign="top"|RuntimeCaption | ||
+ | |valign="top"|None | ||
+ | |valign="top"|Return the runtime caption | ||
|- | |- | ||
|valign="top"|SelectWorkspace | |valign="top"|SelectWorkspace |
Revision as of 08:18, 8 January 2015
Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.
Properties
This class supports the Common Properties plus the following:
Property | Access (R/RW) | Value | Description |
---|---|---|---|
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 |
Libdir | R | Character | Full path of the current library directory |
LockScreen | W | Boolean | Lock screen, disabling screen updates |
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 |
---|---|---|
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 is value |
AddTool | class as Character, caption as Character | Add a tool |
CloseApp | None | Close the currently open App |
Console | output as Character | Write the output string to the Console Output Window |
CreateApp | app as Character | Create the specified App |
Evaluate | expression as Character | Evaluate expression |
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 |
GetElementById | id as Character | Return a reference to the object with the specified id |
GetObject | id as Character | Return a reference to the object with the specified id |
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 |
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 |
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. 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 | filename as Character | Open filename using its file association on the client or perform a Lianja UI action. For examples, please see the SHOWDOCUMENT() function. |
ShowErrorMessage | message as Character[, minimumwidth as Numeric] | Show the specified message. If minimumwidth is 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. |
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] | Show the specified message. If minimumwidth is 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. |
ShowNotification | message as Character, wait as Boolean[, count as Numeric] | Show the specified notification message, waiting for the user to dismiss if wait is True. Optionally specify the remaining number of notifications |
ShowProgressBar | value as Numeric, maxvalue as Numeric | Shows the ProgressBar at position value with a maximum of maxvalue |
ShowErrorMessage | message as Character[, minimumwidth as Numeric] | Show the specified message. If minimumwidth is 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. |
Spawn | executable as Character [, args as Character] | Run the specified executable passing the optionally specified comma-separated list of arguments |
SpawnApp | app as Character [, username as Character [, password as Character [, args as Character]]] | Run the specified app passing the optionally specified username, password and comma-separated list of arguments |
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) |
WriteDebug | debugtext as Character | Write the debugtext string to the debug file |
WriteLog | logtext as Character | Write the logtext string to the log |
WriteOutput | output as Character | Write the output string to the Output Window |
Events
This class supports the Common Events plus the following:
Event | Args | Description |
---|