Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Canvas provides the following APIs for rendering form containers:

  1. getWindow
  2. getWindowByFormId
  3. 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 for reference is as follows:

CBXFORMCONTAINER.getWindow("CONTAINER_EVE_TYPE_MASTER");


  • CBXFORMCONTAINER.getWindowByFormId("FORM_ID","CONTAINER_ID",modelData, configObj)

Use this API to open a form using the container id and form id with data, when a same form has multiple containers.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);



  • No labels