Difference between revisions of "Lianja"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
| Line 66: | Line 66: | ||
!Args | !Args | ||
!width="50%"|Description | !width="50%"|Description | ||
| + | |- | ||
| + | |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 | ||
| + | |- | ||
| + | |valign="top"|AddPage | ||
| + | |valign="top"|id as Character, caption as Character | ||
| + | |valign="top"|Add a new Page with the specified id and caption | ||
|- | |- | ||
|valign="top"|AddTool | |valign="top"|AddTool | ||
| Line 71: | Line 79: | ||
|valign="top"|Add a tool | |valign="top"|Add a tool | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|CloseApp |
| − | |valign="top"| | + | |valign="top"|None |
| − | |valign="top"| | + | |valign="top"|Close the currently open App |
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|Console |
| − | |valign="top"| | + | |valign="top"|output as Character |
| − | |valign="top"| | + | |valign="top"|Write the output string to the Console Output Window |
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|CreateApp |
| − | |valign="top"| | + | |valign="top"|app as Character |
| − | |valign="top"| | + | |valign="top"|Create the specified App |
|- | |- | ||
|valign="top"|FindElementById | |valign="top"|FindElementById | ||
| Line 91: | Line 99: | ||
|valign="top"|Return a reference to the object with the specified id | |valign="top"|Return a reference to the object with the specified id | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|HideDialogPanel |
| − | |valign="top"| | + | |valign="top"|None |
| − | |valign="top"| | + | |valign="top"|Hides the current DialogPanel if one is visible |
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|HideProgressBar |
| − | |valign="top"| | + | |valign="top"|None |
| − | |valign="top"| | + | |valign="top"|Hides the ProgressBar if one is visible |
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|Home |
|valign="top"|None | |valign="top"|None | ||
| − | |valign="top"| | + | |valign="top"|Return to the App Center |
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|OpenApp |
| − | |valign="top"| | + | |valign="top"|app as Character |
| − | |valign="top"| | + | |valign="top"|Open the specified App |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|- | |- | ||
|valign="top"|OpenDatabase | |valign="top"|OpenDatabase | ||
| Line 119: | Line 119: | ||
|valign="top"|Open the specified database and return a Database object reference | |valign="top"|Open the specified database and return a Database object reference | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|RemoveObject |
| − | |valign="top"| | + | |valign="top"|existing as Object |
| − | |valign="top"| | + | |valign="top"|Remove the specified object |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|- | |- | ||
|valign="top"|RemovePage | |valign="top"|RemovePage | ||
| Line 131: | Line 127: | ||
|valign="top"|Remove the specified Page | |valign="top"|Remove the specified Page | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|RemoveTool |
| − | |valign="top"| | + | |valign="top"|existing as Object |
| − | |valign="top"| | + | |valign="top"|Remove the specified tool |
|- | |- | ||
|valign="top"|SelectWorkspace | |valign="top"|SelectWorkspace | ||
|valign="top"|workspace as Character | |valign="top"|workspace as Character | ||
|valign="top"|Select the specified Workspace | |valign="top"|Select the specified Workspace | ||
| + | |- | ||
| + | |valign="top"|ShowDocument | ||
| + | |valign="top"|filename as Character | ||
| + | |valign="top"|Open filename using its file association on the client | ||
| + | |- | ||
| + | |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"|Pops up a standard dialog and embeds the specified page from the page library into it | ||
| + | |- | ||
| + | |valign="top"|ShowDialogPanel | ||
| + | |valign="top"|title as Character, page as Character, width as Numeric, action as Character, text as Character | ||
| + | |valign="top"|Slides a "DialogPanel" in from the right of the main window and embeds the specified page from the page library into it | ||
| + | |- | ||
| + | |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 146: | 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"|WriteLog | ||
| + | |valign="top"|logtext as Character | ||
| + | |valign="top"|Write the logtext string to the log | ||
| + | |- | ||
| + | |valign="top"|WriteOutput | ||
| + | |valign="top"|output as Character | ||
| + | |valign="top"|Write the output string to the Output Window | ||
|- | |- | ||
|} | |} | ||
Revision as of 10:36, 4 March 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 | Hides the current DialogPanel if one is visible |
| HideProgressBar | None | Hides 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 |
| ShowDocument | filename as Character | Open filename using its file association on the client |
| 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 | Pops 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 | Slides a "DialogPanel" in from the right of the main window and embeds the specified page from the page library into it |
| ShowProgressBar | value as Numeric, maxvalue as Numeric | Shows the ProgressBar at position value with a maximum of maxvalue |
| 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 |
| 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 |
|---|
