|
|
| (97 intermediate revisions by 2 users not shown) |
| Line 31: |
Line 31: |
| | |Currently active App | | |Currently active App |
| | |style="background: green"| | | |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"| |
| | |style="background: red"| | | |style="background: red"| |
| Line 47: |
Line 71: |
| | |valign="top"|Currently active database | | |valign="top"|Currently active database |
| | |style="background: green"| | | |style="background: green"| |
| − | |style="background: red"| | + | |style="background: green"| |
| − | |style="background: red"| | + | |style="background: green"| |
| | |- | | |- |
| | |valign="top"|Datadir | | |valign="top"|Datadir |
| Line 71: |
Line 95: |
| | |valign="top"|Set / unset main window to fullscreen | | |valign="top"|Set / unset main window to fullscreen |
| | |style="text-align: center;background: lightgreen"| | | |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"| |
| | |style="background: red"| | | |style="background: red"| |
| Line 143: |
Line 175: |
| | |valign="top"|Set progress bar to the specified value | | |valign="top"|Set progress bar to the specified value |
| | |style="text-align: center;background: lightgreen"| | | |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"| |
| | |style="background: red"| | | |style="background: red"| |
| Line 154: |
Line 194: |
| | |style="background: green"| | | |style="background: green"| |
| | |- | | |- |
| − | |valign="top"|sidebarvisible | + | |valign="top"|standalone |
| − | |valign="top"|W | + | |valign="top"|R |
| − | |valign="top"|Boolean (Int) | + | |valign="top"|Boolean |
| − | |valign="top"|Set / unset SideBar visibility | + | |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: green"| |
| | |style="background: red"| | | |style="background: red"| |
| Line 178: |
Line 226: |
| | |style="background: red"| | | |style="background: red"| |
| | |- | | |- |
| − | |valign="top"|version | + | |valign="top"|UIState |
| | |valign="top"|R | | |valign="top"|R |
| | |valign="top"|Character | | |valign="top"|Character |
| − | |valign="top"|Software version | + | |valign="top"|The last [[UI States|UI State]] applied. |
| | |style="background: green"| | | |style="background: green"| |
| | |style="background: red"| | | |style="background: red"| |
| | |style="background: red"| | | |style="background: red"| |
| | |- | | |- |
| − | |} | + | |valign="top"|version |
| − | | + | |valign="top"|R |
| − | ====Methods====
| + | |valign="top"|Character |
| − | | + | |valign="top"|Software version |
| − | This class supports the [[:Category:Common_Methods|Common Methods]] plus the following:
| + | |
| − | | + | |
| − | {| class="wikitable" width=100%
| + | |
| − | !width="15%"|Method
| + | |
| − | !width="20%"|Args
| + | |
| − | !width="50%"|Description
| + | |
| − | !Desktop|| Web ||Mobile
| + | |
| − | |-
| + | |
| − | |valign="top"|addObject | + | |
| − | |valign="top"|existing as Object | newobject as Character, class as Character [, caption as Character] | + | |
| − | |valign="top"|Add an existing object or a new object, in which case the object's class must also be specified and optionally its caption | + | |
| | |style="background: green"| | | |style="background: green"| |
| | |style="background: red"| | | |style="background: red"| |
| | |style="background: red"| | | |style="background: red"| |
| − | |-
| |
| − | |valign="top"|AddPage
| |
| − | |valign="top"|id as Character, caption as Character
| |
| − | |valign="top"|Add a new [[PageBuilder|Page]] with the specified id and caption
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|addProperty
| |
| − | |valign="top"|property as Character, value as Expression
| |
| − | |valign="top"|Add a property and set its value
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|AddTool
| |
| − | |valign="top"|class as Character, caption as Character
| |
| − | |valign="top"|Add a tool
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|alert
| |
| − | |valign="top"|message as Character
| |
| − | |valign="top"|Show the specified message. (From v2.0).
| |
| − | |style="background: red"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|applyMetaData
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Apply MetaData to all [[PageBuilder|pages]] in the current App. (From v3.4).
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|beep
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Sounds a 'beep'
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|clipBoard
| |
| − | |valign="top"|[clipping as Character]
| |
| − | |valign="top"|Read from or write to the system clipboard. (From v4.1).
| |
| − | |style="background: white"|
| |
| − | |style="background: white"|
| |
| − | |style="background: white"|
| |
| − | |-
| |
| − | |valign="top"|CloseApp
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Close the currently open App
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|confirm
| |
| − | |valign="top"|message as Character, callback as Function
| |
| − | |valign="top"|Show the specified message and pass the result (true|false) to the callback function. (From v2.0).
| |
| − | |style="background: red"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|Console
| |
| − | |valign="top"|output as Character
| |
| − | |valign="top"|Write the output string to the Console Output Window
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|CreateApp
| |
| − | |valign="top"|app as Character
| |
| − | |valign="top"|Create the specified App
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|createCursor
| |
| − | |valign="top"|database as Character, table as Character
| |
| − | |valign="top"|Return a reference to a [[Cursor]] object for the specified table from the specified database.
| |
| − | |style="background: red"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|DeployAppIcon
| |
| − | |valign="top"|app as Character, filename as Character [, pagecenter as Logical]
| |
| − | |valign="top"|Deploy image file for App or Page Center.
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|evaluate
| |
| − | |valign="top"|expression as Character
| |
| − | |valign="top"|Evaluate expression. In the LianjaWebFramework, business procedures in custom libraries on the server can also be called. (From v2.0). <br>To call a procedure in a library, prefix the procedure name with the library name and '::'<br> var result = Lianja.evaluate("mylib::myproc()");
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|evaluateJavaScript
| |
| − | |valign="top"|functioncall as Character
| |
| − | |valign="top"|Call server-side JavaScript function and return any result. (From v2.0).
| |
| − | |style="background: red"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|execute
| |
| − | |valign="top"|command as Character
| |
| − | |valign="top"|Execute command
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|FindElementByID
| |
| − | |valign="top"|id as Character
| |
| − | |valign="top"|Return a reference to the object with the specified id
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|get
| |
| − | |valign="top"|id as Character
| |
| − | |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"|None
| |
| − | |valign="top"|Returns a JSON string of App Categories and the Apps in those Categories
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|GetAppInfo
| |
| − | |valign="top"|app as Character
| |
| − | |valign="top"|Returns a JSON string of information about the specified App
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|getConnection
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Return the connection type, e.g. 'WiFi connection'. (From v2.0).
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|getCursor
| |
| − | |valign="top"|alias as Character
| |
| − | |valign="top"|Return a reference to a [[Cursor]] object for the specified table alias
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|getCurrentAcceleration
| |
| − | |valign="top"|onSuccess as Function, onError as Function
| |
| − | |valign="top"|Return the current acceleration along the x, y, and z axes as an object. (From v2.0).
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|GetCurrentLocation
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Currently unused; returns .F.
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|getCurrentPosition
| |
| − | |valign="top"|onSuccess as Function, onError as Function
| |
| − | |valign="top"|Return the current position as a position object. (From v2.0).
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|getElementByID
| |
| − | |valign="top"|id as Character
| |
| − | |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"|onSuccess as Function, onError as Function<br>[, cameraOptions as Object]
| |
| − | |valign="top"|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).
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|hideDialog
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Hide the current modal Dialog if one is visible
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|hideDialogPanel
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Hide the current DialogPanel if one is visible
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|hideMessage
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Hide the current Message if one is visible
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|HideProgressBar
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Hide the ProgressBar if one is visible
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|home
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Return to the App Center
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|isConnected
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Return logical true if connected, false otherwise. (From v2.0).
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|isDevMode
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Return logical true if on desktop (App Builder or App Center desktop client), false otherwise
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|IsLoadingApp
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Return logical true if loading App, false otherwise
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|IsKioskMode
| |
| − | |valign="top"|None
| |
| − | |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"|None
| |
| − | |valign="top"|Return logical true if client is mobile device, false otherwise. (From v2.0).
| |
| − | |style="background: red"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|isRuntimeMode
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Return logical true if in runtime mode, false otherwise
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|Item
| |
| − | |valign="top"|position as Numeric
| |
| − | |valign="top"|Return a reference to the [[PageBuilder|Page]] object at the specified position
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|Log
| |
| − | |valign="top"|logtext as Character
| |
| − | |valign="top"|Write the logtext string to the log
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|login
| |
| − | |valign="top"|username as Character, password as Character
| |
| − | |valign="top"|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().
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|logout
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Log out and return to the login screen
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|openApp
| |
| − | |valign="top"|app as Character
| |
| − | |valign="top"|Open the specified App
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|openDatabase
| |
| − | |valign="top"|database as Character
| |
| − | |valign="top"|Open the specified database and return a Database object reference
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|pauseHttpServer
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Pause the internal http server. (From v3.0).
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|RemoveObject
| |
| − | |valign="top"|existing as Object
| |
| − | |valign="top"|Remove the specified object
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|RemovePage
| |
| − | |valign="top"|id as Character
| |
| − | |valign="top"|Remove the specified [[PageBuilder|Page]]
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|RemoveProperty
| |
| − | |valign="top"|property as Character
| |
| − | |valign="top"|Remove the specified property
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|RemoveTool
| |
| − | |valign="top"|existing as Object
| |
| − | |valign="top"|Remove the specified tool
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|resumeHttpServer
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Resume the internal http server. (From v3.0).
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|Run
| |
| − | |valign="top"|executable as Character [, args as Character]
| |
| − | |valign="top"|Run the specified executable passing the optionally specified comma-separated list of arguments
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|RuntimeCaption
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Return the runtime caption
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|SelectWorkspace
| |
| − | |valign="top"|workspace as Character
| |
| − | |valign="top"|Select the specified Workspace
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|SetFocusInSearchBox
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Set the focus to the Instant Search Box
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|setupUI
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Execute setupui.prg
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|showDialog
| |
| − | |valign="top"|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]]]]]]]]
| |
| − | |valign="top"|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.
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|showDialogPanel
| |
| − | |valign="top"|title as Character, page as Character[, width as Numeric[, action as Character[, text as Character]]]
| |
| − | |valign="top"|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).
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|showDocument
| |
| − | |valign="top"|action as Character | filename as Character
| |
| − | |valign="top"|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.
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|showErrorMessage
| |
| − | |valign="top"|message as Character[, minimumwidth as Numeric | webtitle as Character]
| |
| − | |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"|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.
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|showMessage
| |
| − | |valign="top"|message as Character[, minimumwidth as Numeric | webtitle as Character]
| |
| − | |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"|message as Character, wait as Boolean[, count as Numeric] | [webtitle as Character]
| |
| − | |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"|showPagesMenu
| |
| − | |valign="top"|None
| |
| − | |valign="top"|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 [[SHOWDOCUMENT()|Lianja.showDocument("showpagesmenu")]] can also be used. (From v3.0).
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|ShowProgressBar
| |
| − | |valign="top"|value as Numeric, maxvalue as Numeric
| |
| − | |valign="top"|Shows the ProgressBar at position value with a maximum of maxvalue
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|showSuccessMessage
| |
| − | |valign="top"|message as Character[, minimumwidth as Numeric | webtitle as Character]
| |
| − | |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"|executable as Character [, args as Character]
| |
| − | |valign="top"|Run the specified executable passing the optionally specified comma-separated list of arguments
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|SpawnApp
| |
| − | |valign="top"|app as Character
| |
| − | |valign="top"|Run the specified App
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|startHttpServer
| |
| − | |valign="top"|[port as Numeric]
| |
| − | |valign="top"|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).
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|stopHttpServer
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Stop the internal http server. (From v3.0).
| |
| − | |style="background: green"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|UserDomain
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Return the domain/tenancy for the current user
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|UserName
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Return the username for the current user
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|UserRoles
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Return the roles for the current user
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|Version
| |
| − | |valign="top"|None
| |
| − | |valign="top"|Return the current Lianja version (HTML formatted)
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|vibrate
| |
| − | |valign="top"|seconds as Numeric
| |
| − | |valign="top"|On mobile devices, vibrates for the specified number of seconds. On Web Client, sounds a 'beep'. (From v2.0).
| |
| − | |style="background: red"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|WriteDebug
| |
| − | |valign="top"|debugtext as Character
| |
| − | |valign="top"|Write the debugtext string to the debug file
| |
| − | |style="text-align: center;background: lightgreen"|
| |
| − | |style="background: red"|
| |
| − | |style="background: red"|
| |
| − | |-
| |
| − | |valign="top"|writeError
| |
| − | |valign="top"|errortext as Character
| |
| − | |valign="top"|Write the errortext string to the Console.
| |
| − | |style="background: red"|
| |
| − | |style="background: green"|
| |
| − | |style="background: green"|
| |
| − | |-
| |
| − | |valign="top"|writeLog
| |
| − | |valign="top"|logtext as Character
| |
| − | |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"|output as Character
| |
| − | |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"|
| |
| | |- | | |- |
| | |} | | |} |
| | | | |
| − | ====Events==== | + | ====Methods==== |
| − | | + | [[Lianja Methods|Click here for Lianja Methods]] |
| − | This class supports the [[:Category:Common_Events|Common Events]] plus the following:
| + | |
| − | | + | |
| − | {| class="wikitable" width=100%
| + | |
| − | !width="20%"|Event
| + | |
| − | !Args
| + | |
| − | !width="50%"|Description
| + | |
| − | | + | |
| − | |}
| + | |
| | | | |
| | ====Key==== | | ====Key==== |
| | {| class="wikitable" width=100% | | {| class="wikitable" width=100% |
| | |style="background: green"| | | |style="background: green"| |
| − | | Supported on this client | + | | 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. |
| | |- | | |- |
| | |style="text-align: center;background: lightgreen"| | | |style="text-align: center;background: lightgreen"| |
| − | | Supported in Lianja/VFP scripting only on this client | + | | Supported in Lianja/VFP scripting only on this client.<br> |
| | |- | | |- |
| | |style="background: red"| | | |style="background: red"| |
| − | | Not currently supported on this client | + | | Not currently supported on this client.<br> |
| | |- | | |- |
| | |} | | |} |
