Difference between revisions of "Lianja"

From Lianjapedia
Jump to: navigation, search
(Created page with '====Properties==== This class supports the '''Common properties''' plus the following: {| class="wikitable" !width="20%"|Property !Access (R/RW) !Value !width="50%"|Description…')
 
(→‎Properties)
 
(222 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
====Properties====
 
====Properties====
  
−
This class supports the '''Common properties''' plus the following:
+
This class supports the following properties:
  
−
{| class="wikitable"
+
{| class="wikitable" width=100%
−
!width="20%"|Property
+
!width="15%"|Property
−
!Access (R/RW)
+
!width="5%"|Access
−
!Value
+
!width="15%"|Value
 
!width="50%"|Description
 
!width="50%"|Description
 +
!Desktop||  Web  ||Mobile 
 +
|-
 +
|valign="top"|activepage
 +
|valign="top"|RW
 +
|valign="top"|Object
 +
|valign="top"|Return an object reference to the currently active [[PageBuilder|Page]]
 +
|style="background: green"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|Appdir
 +
|valign="top"|R
 +
|valign="top"|Character
 +
|valign="top"|Full path of the current App directory
 +
|style="text-align: center;background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|application
 +
|valign="top"|R
 +
|valign="top"|Character
 +
|Currently active App
 +
|style="background: green"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|args
 +
|valign="top"|RW
 +
|valign="top"|Character
 +
|Arguments passed to current App.  From v6.0.
 +
|style="background: green"| 
 +
|style="background: green"| 
 +
|style="background: green"| 
 +
|-
 +
|valign="top"|availablecameralist
 +
|valign="top"|R
 +
|valign="top"|Character
 +
|valign="top"|Comma separated list of available cameras.  From v7.0.
 +
|style="background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|availablecameras
 +
|valign="top"|R
 +
|valign="top"|Numeric
 +
|valign="top"|Number of available cameras.  From v7.0.
 +
|style="background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|Count
 +
|valign="top"|R
 +
|valign="top"|Numeric
 +
|valign="top"|Number of [[PageBuilder|Pages]] in the current App
 +
|style="text-align: center;background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|database
 +
|valign="top"|R
 +
|valign="top"|Character
 +
|valign="top"|Currently active database
 +
|style="background: green"| 
 +
|style="background: green"| 
 +
|style="background: green"| 
 +
|-
 +
|valign="top"|Datadir
 +
|valign="top"|R
 +
|valign="top"|Character
 +
|valign="top"|Full path of the current database directory
 +
|style="text-align: center;background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|editor
 +
|valign="top"|R
 +
|valign="top"|Object
 +
|valign="top"|Return an object reference to the Editor
 +
|style="background: green"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|Fullscreen
 +
|valign="top"|W
 +
|valign="top"|Boolean (Int)
 +
|valign="top"|Set / unset main window to fullscreen
 +
|style="text-align: center;background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|leftsidebarvisible
 +
|valign="top"|W
 +
|valign="top"|Boolean
 +
|valign="top"|Set / unset Left SideBar visibility
 +
|style="background: green"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|Libdir
 +
|valign="top"|R
 +
|valign="top"|Character
 +
|valign="top"|Full path of the current library directory
 +
|style="text-align: center;background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|LockScreen
 +
|valign="top"|W
 +
|valign="top"|Boolean
 +
|valign="top"|Lock screen, disabling screen updates
 +
|style="text-align: center;background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|localStorage
 +
|valign="top"|R
 +
|valign="top"|Object
 +
|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"|W
 +
|valign="top"|Boolean (Int)
 +
|valign="top"|Set / unset main window to maximized
 +
|style="text-align: center;background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|Minimized
 +
|valign="top"|W
 +
|valign="top"|Boolean (Int)
 +
|valign="top"|Set / unset main window to minimized
 +
|style="text-align: center;background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|ProgressLabel
 +
|valign="top"|W
 +
|valign="top"|Character
 +
|valign="top"|Progress bar text label
 +
|style="text-align: center;background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|ProgressMaximum
 +
|valign="top"|W
 +
|valign="top"|Int
 +
|valign="top"|Progress bar maximum value
 +
|style="text-align: center;background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|ProgressMinimum
 +
|valign="top"|W
 +
|valign="top"|Int
 +
|valign="top"|Progress bar minimum value
 +
|style="text-align: center;background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|ProgressValue
 +
|valign="top"|W
 +
|valign="top"|Int
 +
|valign="top"|Set progress bar to the specified value
 +
|style="text-align: center;background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|rightsidebarvisible
 +
|valign="top"|W
 +
|valign="top"|Boolean
 +
|valign="top"|Set / unset Right SideBar visibility
 +
|style="background: green"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|sessionStorage
 +
|valign="top"|R
 +
|valign="top"|Object
 +
|valign="top"|Return an object reference to the currently active [[SessionStorage]]
 +
|style="background: green"| 
 +
|style="background: green"| 
 +
|style="background: green"| 
 +
|-
 +
|valign="top"|standalone
 +
|valign="top"|R
 +
|valign="top"|Boolean
 +
|valign="top"|Whether the App is running as a [[Standalone Executables on Windows|standalone App]].  From v9.5.
 +
|style="background: green"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|standalonefilepath
 +
|valign="top"|R
 +
|valign="top"|Character
 +
|valign="top"|Returns the filepath when the App is running as a [[Standalone Executables on Windows|standalone App]].  From v9.5.
 +
|style="background: green"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|table
 +
|valign="top"|R
 +
|valign="top"|Character
 +
|Currently active table
 +
|style="background: green"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|Theme
 +
|valign="top"|RW
 +
|valign="top"|Character
 +
|valign="top"|Set/Get the current App theme
 +
|style="text-align: center;background: lightgreen"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|UIState
 +
|valign="top"|R
 +
|valign="top"|Character
 +
|valign="top"|The last [[UI States|UI State]] applied.
 +
|style="background: green"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 +
|-
 +
|valign="top"|version
 +
|valign="top"|R
 +
|valign="top"|Character
 +
|valign="top"|Software version
 +
|style="background: green"| 
 +
|style="background: red"| 
 +
|style="background: red"| 
 
|-
 
|-
−
 
 
|}
 
|}
  
 
====Methods====
 
====Methods====
 +
[[Lianja Methods|Click here for Lianja Methods]]
  
−
This class supports the '''Common methods''' plus the following:
+
====Key====
−
 
+
{| class="wikitable" width=100%
−
{| class="wikitable"
+
|style="background: green"| 
−
!width="20%"|Method
+
| Supported on this client.<br>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.
−
!Args
+
|-
−
!width="50%"|Description
+
|style="text-align: center;background: lightgreen"|&nbsp;
−
 
+
| Supported in Lianja/VFP scripting only on this client.<br>&nbsp;
 +
|-
 +
|style="background: red"|&nbsp;
 +
| Not currently supported on this client.<br>&nbsp;
 +
|-
 
|}
 
|}
  
−
====Events====
 
  
−
This class supports the '''Common events''' plus the following:
+
[[Category:Documentation]]
−
 
+
[[Category:Framework Classes]]
−
{| class="wikitable"
+
−
!width="20%"|Event
+
−
!Args
+
−
!width="50%"|Description
+
−
 
+
−
|}
+

Latest revision as of 06:43, 20 March 2024

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      
standalone R Boolean Whether the App is running as a standalone App. From v9.5.      
standalonefilepath R Character Returns the filepath when the App is running as a standalone App. From v9.5.      
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

Click here for Lianja Methods

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.
 
Retrieved from "https://www.lianja.com/doc/index.php?title=Lianja&oldid=26456"