Form Methods (inherits FormBlock)

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

Open a named form

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). The parameters can also include the key __showAs which can be set to ShowAsDesign to show the form in design mode (set to ShowAsData gives the default behaviour). 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.

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

Open a named report

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). The parameters can also include the key __showAs which can be set to ShowAsDesign to show the report in design mode, or ShowAsData to show in data view (set to ShowAsPrint gives the default behaviour). If the report is modal the control does not return until the report is closed.

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

void close ( number rc )

Close the form

Closes the form.

void closeAll ( number rc )

Close the form

This is identical to close.

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.

dict parameterDict ( )

Get paramater dictionary

Returns the entire set of parameters as a dictionary; the dictionary keys are the parameter names.

object getGlobalCtrl ( string name )

Locate control globally by name

This method searches for the named control in the form, recursing down as needed (except that it does not recurse into linked components). Note that if there is more than one control with the name name, then the result is not defined (any such named control might be returned), and the getNamedCtrl method should be used.

object getOpener ( )

Get opening form

If the form was opened by another form (ie., by a call to openForm or one of the related method), then this method returns the form-level object in that form. If opened directly from the list of forms, or from a macro, then the result is None.

string getSkinFGColor ( string name, bool hash )

Get foreground color for skin element

Returns the foreground colour for the specified element in the skin being used by the form. Returns None if there is no skin, no such skin element, or the color is not set in the skin element. By default, colours are returned like 0x00ff00; if hash is set then like #ff0000.

string getSkinBGColor ( string name, bool hash )

Get background color for skin element

Returns the background colour for the specified element in the skin being used by the form. Returns None if there is no skin, no such skin element, or the color is not set in the skin element. By default, colours are returned like 0x00ff00; if hash is set then like #ff0000.

string getSkinFont ( )

Get font for skin element

Returns the font for the specified element in the skin being used by the form. Returns None if there is no skin, no such skin element, or the font is not set in the skin element.