Difference between revisions of "Lianja"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
Line 4: | Line 4: | ||
{| class="wikitable" width=100% | {| class="wikitable" width=100% | ||
− | !width=" | + | !width="15%"|Property |
− | !Access (R/RW) | + | !width="5%"!Access (R/RW) |
− | !Value | + | !width="15%"|Value |
!width="50%"|Description | !width="50%"|Description | ||
+ | !Desktop||Web||Mobile | ||
|- | |- | ||
− | |valign="top"| | + | |valign="top"|activepage |
|valign="top"|RW | |valign="top"|RW | ||
|valign="top"|Object | |valign="top"|Object | ||
− | |valign="top"|Return an object reference to the currently active [[PageBuilder|Page]] | + | |valign="top"|Return an object reference to the currently active [[PageBuilder|Page]] |
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
− | |Appdir | + | |valign="top"|Appdir |
− | |R | + | |valign="top"|R |
− | |Character | + | |valign="top"|Character |
− | |Full path of the current App directory | + | |valign="top"|Full path of the current App directory |
+ | |style="text-align: center;background: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
− | | | + | |valign="top"|application |
− | |R | + | |valign="top"|R |
− | |Character | + | |valign="top"|Character |
|Currently active App | |Currently active App | ||
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
− | |Count | + | |valign="top"|Count |
− | |R | + | |valign="top"|R |
− | |Numeric | + | |valign="top"|Numeric |
− | |Number of [[PageBuilder|Pages]] in the current App | + | |valign="top"|Number of [[PageBuilder|Pages]] in the current App |
+ | |style="text-align: center;background: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
− | | | + | |valign="top"|database |
− | |R | + | |valign="top"|R |
− | |Character | + | |valign="top"|Character |
− | |Currently active database | + | |valign="top"|Currently active database |
+ | |valign="top"|style="background: green"| | ||
+ | |valign="top"|style="background: red"| | ||
+ | |valign="top"|style="background: red"| | ||
|- | |- | ||
− | |Datadir | + | |valign="top"|Datadir |
− | |R | + | |valign="top"|R |
− | |Character | + | |valign="top"|Character |
− | |Full path of the current database directory | + | |valign="top"|Full path of the current database directory |
+ | |style="text-align: center;background: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
− | |valign="top"| | + | |valign="top"|editor |
|valign="top"|R | |valign="top"|R | ||
|valign="top"|Object | |valign="top"|Object | ||
|valign="top"|Return an object reference to the Editor | |valign="top"|Return an object reference to the Editor | ||
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|Fullscreen | |valign="top"|Fullscreen | ||
Line 48: | 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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
− | |Libdir | + | |valign="top"|Libdir |
− | |R | + | |valign="top"|R |
− | |Character | + | |valign="top"|Character |
− | |Full path of the current library directory | + | |valign="top"|Full path of the current library directory |
+ | |style="text-align: center;background: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|LockScreen | |valign="top"|LockScreen | ||
Line 58: | 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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|localStorage | |valign="top"|localStorage | ||
|valign="top"|R | |valign="top"|R | ||
|valign="top"|Object | |valign="top"|Object | ||
− | |valign="top"|Return an object reference to the currently active [[LocalStorage]] | + | |valign="top"|Return an object reference to the currently active [[LocalStorage]] |
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|Maximized | |valign="top"|Maximized | ||
Line 68: | 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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|ProgressLabel | |valign="top"|ProgressLabel | ||
Line 73: | Line 110: | ||
|valign="top"|Character | |valign="top"|Character | ||
|valign="top"|Progress bar text label | |valign="top"|Progress bar text label | ||
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|ProgressMaximum | |valign="top"|ProgressMaximum | ||
Line 78: | Line 118: | ||
|valign="top"|Int | |valign="top"|Int | ||
|valign="top"|Progress bar maximum value | |valign="top"|Progress bar maximum value | ||
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|ProgressMinimum | |valign="top"|ProgressMinimum | ||
Line 83: | Line 126: | ||
|valign="top"|Int | |valign="top"|Int | ||
|valign="top"|Progress bar minimum value | |valign="top"|Progress bar minimum value | ||
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|ProgressValue | |valign="top"|ProgressValue | ||
Line 88: | 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="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|sessionStorage | |valign="top"|sessionStorage | ||
|valign="top"|R | |valign="top"|R | ||
|valign="top"|Object | |valign="top"|Object | ||
− | |valign="top"|Return an object reference to the currently active [[SessionStorage]] | + | |valign="top"|Return an object reference to the currently active [[SessionStorage]] |
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
− | |valign="top"| | + | |valign="top"|sidebarvisible |
|valign="top"|W | |valign="top"|W | ||
|valign="top"|Boolean (Int) | |valign="top"|Boolean (Int) | ||
|valign="top"|Set / unset SideBar visibility | |valign="top"|Set / unset SideBar visibility | ||
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
− | | | + | |valign="top"|table |
− | |R | + | |valign="top"|R |
− | |Character | + | |valign="top"|Character |
|Currently active table | |Currently active table | ||
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
− | |Theme | + | |valign="top"|Theme |
− | |RW | + | |valign="top"|RW |
− | |Character | + | |valign="top"|Character |
− | |Set/Get the current App theme | + | |valign="top"|Set/Get the current App theme |
+ | |style="text-align: center;background: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
− | | | + | |valign="top"|version |
− | |R | + | |valign="top"|R |
− | |Character | + | |valign="top"|Character |
− | |Software version | + | |valign="top"|Software version |
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|} | |} | ||
Line 121: | Line 185: | ||
{| class="wikitable" width=100% | {| class="wikitable" width=100% | ||
− | !width=" | + | !width="15%"|Method |
− | !Args | + | !width="20%"|Args |
!width="50%"|Description | !width="50%"|Description | ||
+ | !Desktop||Web||Mobile | ||
|- | |- | ||
|valign="top"|addObject | |valign="top"|addObject | ||
Line 132: | Line 197: | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
− | |valign="top"| | + | |valign="top"|addProperty |
|valign="top"|property as Character, value as Expression | |valign="top"|property as Character, value as Expression | ||
|valign="top"|Add a property and set is value | |valign="top"|Add a property and set is value | ||
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|AddTool | |valign="top"|AddTool | ||
|valign="top"|class as Character, caption as Character | |valign="top"|class as Character, caption as Character | ||
|valign="top"|Add a tool | |valign="top"|Add a tool | ||
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|alert | |valign="top"|alert | ||
|valign="top"|message as Character | |valign="top"|message as Character | ||
− | |valign="top"|Show the specified message. ( | + | |valign="top"|Show the specified message. (From v2.0.0). |
+ | |style="background: red"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|beep | |valign="top"|beep | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Sounds a 'beep' | |valign="top"|Sounds a 'beep' | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|CloseApp | |valign="top"|CloseApp | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|confirm | |valign="top"|confirm | ||
Line 160: | Line 243: | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|CreateApp | |valign="top"|CreateApp | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|createCursor | |valign="top"|createCursor | ||
Line 192: | Line 281: | ||
|valign="top"|id as Character | |valign="top"|id as Character | ||
|valign="top"|Return a reference to the object with the specified id | |valign="top"|Return a reference to the object with the specified id | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|GetAppCategories | |valign="top"|GetAppCategories | ||
Line 216: | Line 308: | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Currently unused; returns .F. | |valign="top"|Currently unused; returns .F. | ||
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|getCurrentPosition | |valign="top"|getCurrentPosition | ||
Line 224: | Line 319: | ||
|valign="top"|id as Character | |valign="top"|id as Character | ||
|valign="top"|Return a reference to the object with the specified id | |valign="top"|Return a reference to the object with the specified id | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|getPicture | |valign="top"|getPicture | ||
Line 248: | Line 346: | ||
|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: orange"|* | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|isDevMode | |valign="top"|isDevMode | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Return logical true if in development mode, false otherwise | |valign="top"|Return logical true if in development mode, false otherwise | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|IsLoadingApp | |valign="top"|IsLoadingApp | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Return logical true if loading App, false otherwise | |valign="top"|Return logical true if loading App, false otherwise | ||
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|IsKioskMode | |valign="top"|IsKioskMode | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Return logical true if in kiosk mode, false otherwise | |valign="top"|Return logical true if in kiosk mode, false otherwise | ||
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|isPhoneGap | |valign="top"|isPhoneGap | ||
Line 272: | Line 382: | ||
|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="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|Log | |valign="top"|Log | ||
|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="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|login | |valign="top"|login | ||
Line 296: | Line 412: | ||
|valign="top"|existing as Object | |valign="top"|existing as Object | ||
|valign="top"|Remove the specified object | |valign="top"|Remove the specified object | ||
+ | |style="background: green"| | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|RemovePage | |valign="top"|RemovePage | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|RemoveProperty | |valign="top"|RemoveProperty | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|RemoveTool | |valign="top"|RemoveTool | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|Run | |valign="top"|Run | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|RuntimeCaption | |valign="top"|RuntimeCaption | ||
|valign="top"|None | |valign="top"|None | ||
|valign="top"|Return the runtime caption | |valign="top"|Return the runtime caption | ||
+ | |style="text-align: center;background: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|SelectWorkspace | |valign="top"|SelectWorkspace | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|SetFocusInSearchBox | |valign="top"|SetFocusInSearchBox | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|showDialog | |valign="top"|showDialog | ||
Line 334: | Line 474: | ||
|- | |- | ||
|valign="top"|showDocument | |valign="top"|showDocument | ||
− | |valign="top"|filename as Character | + | |valign="top"|action as Character | filename as Character |
− | |valign="top"| | + | |valign="top"|Perform a Lianja UI action. On the desktop, it can also open filename using its file association. For examples, see the [[SHOWDOCUMENT()]] function. |
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|showErrorMessage | |valign="top"|showErrorMessage | ||
− | |valign="top"|message as Character[, minimumwidth as Numeric] | + | |valign="top"|message as Character[, minimumwidth as Numeric | webtitle as Character] |
− | |valign="top"|Show the specified message. | + | |valign="top"|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. |
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|ShowHelp | |valign="top"|ShowHelp | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|showMessage | |valign="top"|showMessage | ||
− | |valign="top"|message as Character[, minimumwidth as Numeric] | + | |valign="top"|message as Character[, minimumwidth as Numeric | webtitle as Character] |
− | |valign="top"|Show the specified message. | + | |valign="top"|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. |
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|showNotification | |valign="top"|showNotification | ||
− | |valign="top"|message as Character, wait as Boolean[, count as Numeric] | + | |valign="top"|message as Character, wait as Boolean[, count as Numeric] | [webtitle as Character] |
− | |valign="top"|Show the specified notification message, | + | |valign="top"|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. |
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|ShowProgressBar | |valign="top"|ShowProgressBar | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|showSuccessMessage | |valign="top"|showSuccessMessage | ||
− | |valign="top"|message as Character[, minimumwidth as Numeric] | + | |valign="top"|message as Character[, minimumwidth as Numeric | webtitle as Character] |
− | |valign="top"|Show the specified message. | + | |valign="top"|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. |
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|Spawn | |valign="top"|Spawn | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|SpawnApp | |valign="top"|SpawnApp | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|UserDomain | |valign="top"|UserDomain | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|UserName | |valign="top"|UserName | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|UserRoles | |valign="top"|UserRoles | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|Version | |valign="top"|Version | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|vibrate | |valign="top"|vibrate | ||
|valign="top"|seconds as Numeric | |valign="top"|seconds as Numeric | ||
− | |valign="top"|On mobile devices, vibrates for the specified number of seconds. On Web Client, sounds a 'beep'. ( | + | |valign="top"|On mobile devices, vibrates for the specified number of seconds. On Web Client, sounds a 'beep'. (From v2.0.0). |
+ | |style="background: red"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|WriteDebug | |valign="top"|WriteDebug | ||
|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: orange"|* | ||
+ | |style="background: red"| | ||
+ | |style="background: red"| | ||
|- | |- | ||
|valign="top"|writeError | |valign="top"|writeError | ||
|valign="top"|errortext as Character | |valign="top"|errortext as Character | ||
− | |valign="top"|Write the errortext string to the Console. | + | |valign="top"|Write the errortext string to the Console. |
+ | |style="background: red"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|writeLog | |valign="top"|writeLog | ||
|valign="top"|logtext as Character | |valign="top"|logtext as Character | ||
− | |valign="top"|Write the logtext string to the log (desktop) or Console (web/mobile). | + | |valign="top"|Write the logtext string to the log (desktop) or JavaScript Console (web/mobile). |
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|valign="top"|writeOutput | |valign="top"|writeOutput | ||
|valign="top"|output as Character | |valign="top"|output as Character | ||
− | |valign="top"|Write the output string to the Output Window (desktop) or Console (web/mobile). | + | |valign="top"|Write the output string to the Output Window (desktop) or JavaScript Console (web/mobile). |
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
+ | |style="background: green"| | ||
|- | |- | ||
|} | |} | ||
Line 417: | Line 611: | ||
|} | |} | ||
+ | |||
+ | <nowiki>* Lianja/VFP only.</nowiki> | ||
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Framework Classes]] | [[Category:Framework Classes]] |
Revision as of 10:09, 3 September 2015
Properties
This class supports the Common Properties plus the following:
Property | width="5%"!Access (R/RW) | 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 | style="background: green"| | style="background: red"| | style="background: red"| |
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 is 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. (LianjaWebFramework 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. (LianjaWebFramework). | |||
DeployAppIcon | app as Character, filename as Character [, pagecenter as Logical] |
||||
evaluate | expression as Character | Evaluate expression | |||
evaluateJavaScript | functioncall as Character | Call server-side JavaScript function and return any result. (LianjaWebFramework 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'. (LianjaWebFramework from v2.0.0. Mobile devices only, alert message displayed otherwise). | |||
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. (LianjaWebFramework from v2.0.0. Mobile devices only, alert message displayed otherwise). | |||
GetCurrentLocation | None | Currently unused; returns .F. | |||
getCurrentPosition | onSuccess as Function, onError as Function | Return the current position as a position object. (LianjaWebFramework from v2.0.0. Mobile devices only, alert message displayed otherwise). | |||
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. (LianjaWebFramework from v2.0.0. Mobile devices only, alert message displayed otherwise). | |||
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. (LianjaWebFramework 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 | |||
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 | 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 |
---|
* Lianja/VFP only.