Difference between revisions of "Lianja"

From Lianjapedia
Jump to: navigation, search
Line 134: Line 134:
 
|valign="top"|workspace as Character
 
|valign="top"|workspace as Character
 
|valign="top"|Select the specified Workspace
 
|valign="top"|Select the specified Workspace
|-
 
|valign="top"|ShowDocument
 
|valign="top"|filename as Character
 
|valign="top"|Open filename using its file association on the client or perform a Lianja UI action.  For examples, please see the [[SHOWDOCUMENT()]] function.
 
 
|-
 
|-
 
|valign="top"|ShowDialog
 
|valign="top"|ShowDialog
Line 146: Line 142:
 
|valign="top"|title as Character, page as Character[, width as Numeric[, action as Character[, text as Character]]]
 
|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 embeds the specified page from the page library into it
 
|valign="top"|Slide a "DialogPanel" in from the right of the main window and embeds the specified page from the page library into it
 +
|-
 +
|valign="top"|ShowDocument
 +
|valign="top"|filename as Character
 +
|valign="top"|Open filename using its file association on the client or perform a Lianja UI action.  For examples, please see the [[SHOWDOCUMENT()]] function.
 
|-
 
|-
 
|valign="top"|ShowHelp
 
|valign="top"|ShowHelp
 
|valign="top"|title as Character, tablename as Character[, topic as Character[, showbuttons as Boolean]]
 
|valign="top"|title as Character, tablename as Character[, topic as Character[, showbuttons as Boolean]]
 
|valign="top"|Display help information. The tablename is the name of a table with the structure of:<br>helptopic char(60)<br>helptext memo<br>The table should be indexed on helptopic. For examples, please see the [[SHOWHELP()]] function.  
 
|valign="top"|Display help information. The tablename is the name of a table with the structure of:<br>helptopic char(60)<br>helptext memo<br>The table should be indexed on helptopic. For examples, please see the [[SHOWHELP()]] function.  
|-
 
|valign="top"|ShowProgressBar
 
|valign="top"|value as Numeric, maxvalue as Numeric
 
|valign="top"|Shows the ProgressBar at position value with a maximum of maxvalue
 
 
|-
 
|-
 
|valign="top"|ShowMessage
 
|valign="top"|ShowMessage
Line 162: Line 158:
 
|valign="top"|message as Character, wait as Boolean[, count as Numeric]
 
|valign="top"|message as Character, wait as Boolean[, count as Numeric]
 
|valign="top"|Show the specified notification message, waiting for the user to dismiss if wait is True.  Optionally specify the remaining number of notifications
 
|valign="top"|Show the specified notification message, waiting for the user to dismiss if wait is True.  Optionally specify the remaining number of notifications
 +
|-
 +
|valign="top"|ShowProgressBar
 +
|valign="top"|value as Numeric, maxvalue as Numeric
 +
|valign="top"|Shows the ProgressBar at position value with a maximum of maxvalue
 
|-
 
|-
 
|valign="top"|WriteLog
 
|valign="top"|WriteLog

Revision as of 10:33, 30 April 2013

Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.

Properties

This class supports the Common Properties plus the following:

Property Access (R/RW) Value Description
ActivePage RW Object Return an object reference to the currently active Page
Appdir R Character Full path of the current App directory
Application R Character Currently active App
Database R Character Currently active database
Datadir R Character Full path of the current database directory
Editor R Object Return an object reference to the Editor
Libdir R Character Full path of the current library directory
Table R Character Currently active table
Version R Character Software version

Methods

This class supports the Common Methods plus the following:

Method Args Description
AddObject existing as Object | newobject as Character, class as Character [, caption as Character] Add an existing object or a new object, in which case the object's class must also be specified and optionally its caption
AddPage id as Character, caption as Character Add a new Page with the specified id and caption
AddTool class as Character, caption as Character Add a tool
CloseApp None Close the currently open App
Console output as Character Write the output string to the Console Output Window
CreateApp app as Character Create the specified App
FindElementById id as Character Return a reference to the object with the specified id
GetElementById id as Character Return a reference to the object with the specified id
HideDialogPanel None Hide the current DialogPanel if one is visible
HideProgressBar None Hide the ProgressBar if one is visible
Home None Return to the App Center
OpenApp app as Character Open the specified App
OpenDatabase database as Character Open the specified database and return a Database object reference
RemoveObject existing as Object Remove the specified object
RemovePage id as Character Remove the specified Page
RemoveTool existing as Object Remove the specified tool
SelectWorkspace workspace as Character Select the specified Workspace
ShowDialog title as Character, page as Character[, width as Numeric[, height as Numeric[, buttons as Numeric[, ontop as Numeric[, modal as Numeric[, action as Character[, text as Character[, resizable as Numeric]]]]]]]] Pop up a standard dialog and embeds the specified page from the page library into it
ShowDialogPanel title as Character, page as Character[, width as Numeric[, action as Character[, text as Character]]] Slide a "DialogPanel" in from the right of the main window and embeds the specified page from the page library into it
ShowDocument filename as Character Open filename using its file association on the client or perform a Lianja UI action. For examples, please see the SHOWDOCUMENT() function.
ShowHelp title as Character, tablename as Character[, topic as Character[, showbuttons as Boolean]] Display help information. The tablename is the name of a table with the structure of:
helptopic char(60)
helptext memo
The table should be indexed on helptopic. For examples, please see the SHOWHELP() function.
ShowMessage message as Character Show the specified message
ShowNotification message as Character, wait as Boolean[, count as Numeric] Show the specified notification message, waiting for the user to dismiss if wait is True. Optionally specify the remaining number of notifications
ShowProgressBar value as Numeric, maxvalue as Numeric Shows the ProgressBar at position value with a maximum of maxvalue
WriteLog logtext as Character Write the logtext string to the log
WriteOutput output as Character Write the output string to the Output Window

Events

This class supports the Common Events plus the following:

Event Args Description