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