Difference between revisions of "SHOWDOCUMENT()"

From Lianjapedia
Jump to: navigation, search
Line 88: Line 88:
 
|valign="top"|resetstate||Causes all UI components to revert back to their default attributes (no UI state set)
 
|valign="top"|resetstate||Causes all UI components to revert back to their default attributes (no UI state set)
 
|-
 
|-
|valign="top"|back||Navigates to the previous Page in the history
+
|valign="top"|back:||Navigates to the previous Page in the history.  Note the trailing colon.
 
|-
 
|-
|valign="top"|forward||Navigates to the next Page in the history
+
|valign="top"|forward:||Navigates to the next Page in the history Note the trailing colon.
 
|-
 
|-
 
|}
 
|}

Revision as of 07:25, 19 April 2016

Purpose

Function to perform a Lianja UI action or display a document in its associated plugin/application

Syntax

SHOWDOCUMENT(<expC>)

See Also

GETFILE(), SHOWHELP()

Description

The SHOWDOCUMENT() function displays a document in its associated plugin/application or performs a Lianja UI action. The <expC> is a URL, a file name or a Lianja UI Action.

Action Description
app:<appid> Switch to the specified App <appid>
applyrules Applies UI presentation rules for all pages, their sections and the fields/gadgets/columns in the sections.
page:<pageid> Select the specified Page <pageid>
page:<pageid>?action=<actionid> Perform the specified Action <actionid> on the specified Page <pageid>

?action=hide
?action=redraw
?action=show
?action=print
?action=hidenavigationpanel
?action=shownavigationpanel
?action=hideleftsidebar
?action=showleftsidebar
?action=toggleleftsidebar
?action=hiderightsidebar
?action=showrightsidebar
?action=togglerightsidebar

Actions apply to the primary section where applicable:
?action=add
?action=delete
?action=edit
?action=editmode
?action=first
?action=last
?action=next
?action=previous
?action=save
?action=cancel
?action=refresh
?action=search&text=value
?action=filter&text=expression
?action=collapse
?action=expand
?action=hidesearchpanel
?action=showsearchpanel
?action=togglesearchpanel

page:<pageid>.<sectionid>?action=<actionid>

  or, for current Page:

section:<sectionid>?action=<actionid>
Perform the specified Action <actionid> on the specified Section <sectionid>

?action=add
?action=delete
?action=edit
?action=editmode
?action=first
?action=last
?action=next
?action=previous
?action=recalc
?action=redraw
?action=requery&text=queryexpression
?action=sql&text=sqlstatement
?action=refresh
?action=hide
?action=show
?action=print
?action=search&text=<expression>
?action=filter&text=<expression>
?action=collapse
?action=expand
?action=select
?action=select&text=<tabcaption>
?action=showsearchpanel
?action=hidesearchpanel
?action=togglesearchpanel
?action=showsearchpanel
?action=hidesearchpanel
?action=togglesearchpanel

changestate:<state> Sets the specified UI state <state>
resetstate Causes all UI components to revert back to their default attributes (no UI state set)
back: Navigates to the previous Page in the history. Note the trailing colon.
forward: Navigates to the next Page in the history Note the trailing colon.

The SHOWDOCUMENT() functionality is also provided in the Lianja system object showDocument() method.

Example

// Lianja UI Actions
showdocument("app:myapp")
showdocument("page:page1")
showdocument("page:page1?action=hide")
showdocument("page:page1?action=show")
showdocument("section:section1?action=select&text=Order Details")
showdocument("section:section5?action=print")
showdocument("section:section6?action=last")
 
// Accessing local files using '.pdf' and '.docx' file associations
showdocument("file:///C:\Users\Myuser\Documents\Documentation for HR\Attachments\Resume.pdf")
showdocument("file:///C:\Users\Myuser\Documents\Documentation for HR\Attachments\Resume.docx")
 
// Remote ftp URL
showdocument("ftp://ftp.mycompany.com/latest.txt")
 
// Example to create an HTML file display in the default browser
fp = fcreate("htmlfile&(getpid()).htm")
fwrite(fp, "<html>")
fwrite(fp, "<body>")
fwrite(fp, "<table>")
fwrite(fp, "<tr>")
fwrite(fp, "<td>Field1</td>")
fwrite(fp, "<td>Field2</td>")
fwrite(fp, "</tr>")
fwrite(fp, "</table>")
fwrite(fp, "</body>")
fwrite(fp, "</html>")
fclose(fp)
showdocument("htmlfile&(getpid()).htm")