Difference between revisions of "Lianja"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
| Line 14: | Line 14: | ||
|valign="top"|RW | |valign="top"|RW | ||
|valign="top"|Object | |valign="top"|Object | ||
| − | |valign="top"|Return an object reference to the currently active Page | + | |valign="top"|Return an object reference to the currently active [[PageBuilder|Page]] |
|- | |- | ||
|Appdir | |Appdir | ||
| Line 29: | Line 29: | ||
|R | |R | ||
|Numeric | |Numeric | ||
| − | |Number of Pages in the current App | + | |Number of [[PageBuilder|Pages]] in the current App |
|- | |- | ||
|Database | |Database | ||
| Line 78: | Line 78: | ||
|valign="top"|AddPage | |valign="top"|AddPage | ||
|valign="top"|id as Character, caption as Character | |valign="top"|id as Character, caption as Character | ||
| − | |valign="top"|Add a new Page with the specified id and caption | + | |valign="top"|Add a new [[PageBuilder|Page]] with the specified id and caption |
|- | |- | ||
|valign="top"|AddTool | |valign="top"|AddTool | ||
| Line 130: | Line 130: | ||
|valign="top"|Item | |valign="top"|Item | ||
|valign="top"|position as Numeric | |valign="top"|position as Numeric | ||
| − | |valign="top"|Return a reference to the Page object at the specified position | + | |valign="top"|Return a reference to the [[PageBuilder|Page]] object at the specified position |
|- | |- | ||
|valign="top"|OpenApp | |valign="top"|OpenApp | ||
| Line 146: | Line 146: | ||
|valign="top"|RemovePage | |valign="top"|RemovePage | ||
|valign="top"|id as Character | |valign="top"|id as Character | ||
| − | |valign="top"|Remove the specified Page | + | |valign="top"|Remove the specified [[PageBuilder|Page]] |
|- | |- | ||
|valign="top"|RemoveTool | |valign="top"|RemoveTool | ||
Revision as of 10:18, 23 August 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 |
| Count | R | Numeric | Number of Pages in the current App |
| Database | R | Character | Currently active database |
| Datadir | R | Character | Full path of the current database directory |
| Editor | R | Object | Return an object reference to the Editor |
| 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 |
| Get | 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 |
| GetObject | id as Character | Return a reference to the object with the specified id |
| HideDialogPanel | None | Hide the current DialogPanel if one is visible |
| HideMessage | None | Hide the current Message if one is visible |
| HideProgressBar | None | Hide the ProgressBar if one is visible |
| Home | None | Return to the App Center |
| Item | position as Numeric | Return a reference to the Page object at the specified position |
| 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[, minimumwidth as Numeric] | Show the specified message. If minimumwidth is 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. |
| 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 |
|---|
