Form Methods (inherits FormBlock)

dict openForm ( string formName, dictionary parameters, any key )

Open a named form

<para> Opens the named form. The optional second argument is passed as the parameter dictionary to the form; if present, the optional third argument is used as the parent value to provide master-child linking (in the same manner as for form-subform linkage). </para> <para> The parameters can also include the key <emphasis>__showAs</emphasis> which can be set to <emphasis>ShowAsDesign</emphasis> to show the form in design mode (set to <emphasis>ShowAsData</emphasis> gives the default behaviour). </para> <para> If the form is modal, then control does not return until the form closes. In this case the result is a dictionary, where the keys are the (path) names of the controls in the form and the values are the values in those controls. This allows modal forms to be used as dialog boxes. </para>

bool openReport ( string reportName, dictionary parameters, any key )

Open a named report

<para> Opens the named report. The optional second argument is passed as the parameter dictionary to the report; if present, the optional third argument is used as the parent value to provide master-child linking (in the same manner as for form-subform linkage). </para> <para> The parameters can also include the key <emphasis>__showAs</emphasis> which can be set to <emphasis>ShowAsDesign</emphasis> to show the report in design mode, or <emphasis>ShowAsData</emphasis> to show in data view (set to <emphasis>ShowAsPrint</emphasis> gives the default behaviour). </para> <para> If the report is modal the control does not return until the report is closed. </para>

bool openTextForm ( string xmlDefn, dictionary parameters )

Open an XML form definition

bool openTextReport ( string xmlDefn, dictionary parameters )

Open an XML report definition

bool openTable ( string formName, dictionary parameters )

Open a named table

bool openQuery ( string formName, dictionary parameters )

Open a named query

pydbi openServer ( string serverName )

Get low-level connection to server database

number executeCopier ( string copierName, dictionary parameters )

Execute a copier

list getServerList ( )

Get list of servers

list getObjectList ( string serverName, string objectType )

Get list of objects on server

string getObjecttext ( string serverName, string objectName )

Get XML definition of object

void close ( number rc )

Close the form

form findOpenForm ( string formName )

Locate an open form

dict opener ( )

Get opening form

Returns the form that opened this form, if that form is still open. Note that the result should not be cached, lest the opening form be subsequently closed.

string getParameter ( string paramater )

Get paramater value

Returns the value of the named parameter, as passed to the form or set in the form paramater dialog.