Canvas provides the following APIs for rendering form containers:
- getWindow
- getWindowByFormId
- getWindowByFormObj
getWindow() API
Use the getWindow API to open a blank form using the container id without any data being displayed on the form.
The syntax for this API is:
CBXFORMCONTAINER.getWindow("CONTAINER_ID", config)
/*
* In this API,
* 'CONTAINER_ID' is a mandatory parameter. This should be the container, which has the Form ID configured to it.
* 'config' is an optional parameter. This parameter should contain the configuration of the container.
*/
A sample code is as follows:
CBXFORMCONTAINER.getWindow("CONTAINER_EVE_TYPE_MASTER");
getWindowByFormId() API
Use the getWindowByFormId API to open a form using the container ID and form ID with data, when the same form has multiple containers.
The syntax for this API is:
CBXFORMCONTAINER.getWindowByFormId("FORM_ID","CONTAINER_ID",modelData, configObj)
/*
* In this API,
* 'FORM_ID' is a mandatory parameter. This should be the form ID, which has the containers configured for it.
* 'CONTAINER_ID' is a mandatory parameter. This should be the container, which has the same Form ID configured to it.
* 'modelData' is an optional parameter. This should be the array of data values to set on the Form Items.
* 'config' is an optional parameter. This parameter contains the configuration of the container; in addition to it,
* this object also contains the isTxnHdrReqd * flag and the Transaction Header form to handle the transaction data flow.
*/
- CBXFORMCONTAINER.getWindowByFormId("FORM_ID","CONTAINER_ID",modelData, configObj)
In this API,
FORM_ID – This is a mandatory parameter. This should be the form id, which has thecontainers configured for it.
CONTAINER_ID – This is also mandatory parameter. This should be the container, whichhas the same Form Id configured to it.
ModelData – This is an optional parameter. This should be the array of data values to seton the Form Items.
config – This is an optional parameter. This parameter contains the configuration of thecontainer; in addition to it, this object also contains the isTxnHdrReqd flag and the Transaction Header form to handle the transaction data flow.
A sample code for reference is shown below:
CBXFORMCONTAINER.getWindowByFormId("UPDATE_PREF_FORM", "UPDATE_PREF_FORM_CONTAINER", null,null)
- CBXFORMCONTAINER.getWindowByFormObj(formObj, "CONTAINER_ID", configObj)
Use this API to open a form using the container id (regardless of form id configuration to it) and the form manager object.In this API,
formObject – This is a mandatory parameter. This should be the form manager object thatcontains the form id, which has the containers configured for it.
CONTAINER_ID – This is also mandatory parameter. This should be the container, whichhas the same Form Id configured to it.
config – This is an optional parameter. This parameter contains the configuration of thecontainer; in addition to it, this object also contains the isTxnHdrReqd flag and the Transaction Header form to handle the transaction data flow.
A sample code for reference is shown below:
var eventForm = new cbx.form.FormManager(
{
formId : "ALERT_HANDLER_FORM", mode : 'edit',
modelData:\
{
'EVENT_ID': eventid, 'CHECK_DUPLICATION': count_alert,
});
CBXFORMCONTAINER.getWindowByFormObj(eventForm, "CONTAINER_ALERT_HANDLER", null);