Javascript: Difference between revisions
Line 254: | Line 254: | ||
</span>|parameters=<!-- PARAMETERS --><pre> | </span>|parameters=<!-- PARAMETERS --><pre> | ||
number1 : breadcrumb number | number1 : breadcrumb number | ||
number2 : tab | number2 : tab index (optional) | ||
</pre>|return=<!-- RETURN --><pre> | </pre>|return=<!-- RETURN --><pre> | ||
</pre>|description=<!-- DESCRIPTION --> | </pre>|description=<!-- DESCRIPTION --> |
Revision as of 13:00, 7 August 2017
Each Form can contain custom Javascript code.
Each of the yellow diamonds containing JS is added before it's Form is displayed and can do 2 things.
- Run Javascript when the Form is loaded.
- Create functions that can be used while the Form is open.
eg.
<source lang="javascript">
if(nuGetProperty('record_id') != ){ //-- no record_id means it is a Browse Form
nuAddActionButton('nuRunPHPHidden', 'Run', 'nuRunPHP("UDSTK")'); //-- run as the Form is loaded
}
function copyToDelivery(){ //-- custom function that will be run on an Object Javascript event
var s = $('#inv_street_address').val(); $('#inv_delivery_address').val(s);
}
</source>
nuAddAction
nuAddAction()
Parameters
Return Value
Description
If placed on an Object's click event, it will take the user to the Edit Form of a new record.
Example
Also See : nuAddActionButton
nuAddActionButton
nuAddActionButton(string1, string2, string3);
Parameters
string 1 : Action Button id string 2 : title string 3 : function to run.
Return Value
Description
Add an Action Button.
Example
nuAddActionButton('nuRunPHPHidden', 'Build Fast Form', 'nuRunPHPHidden("RUNFF")');
Also See :
nuBeforeSave
nuBeforeSave()
Parameters
Return Value
Description
Before a record is saved, nuBuilder checks for the existance of a function called nuBeforeSave().
If this exists it will use it's return value to decide whether to continue saving the record.
Example
function nuBeforeSave(){ if($("[data-nu-field='ff_browse']:checked").length == 0){ nuMessage(['At least 1 Browse needs to be checked..']); return false; } if($('#fastform_table').val() == ''){ nuMessage(['Table Name cannot be left blank..']); return false; } return true; }
Also See :
nuCloneAction
nuCloneAction()
Parameters
Return Value
Description
If placed on an Object's click event, it will make a copy of the current record ready to save.
Example
Also See : nuAddActionButton
nuCurrentProperties
object = nuCurrentProperties()
Parameters
Return Value
object : all properties for the current Form
Description
Returns all properties for the current Form as an object.
Example
var p = nuCurrentProperties(); console.log(p.record_id);
-1
Also See : nuGetProperty, nuSetProperty
nuDeleteAction
nuDeleteAction()
Parameters
Return Value
Description
If placed on an Object's click event, it will will delete the current record.
Example
Also See : nuAddActionButton
nuDisable
nuDisable(string1)
Parameters
string1 : Object id.
Return Value
Description
This will disable all parts of a nuBuilder Forte Object.
Example
nuDisable('cus_phone2');
Also See : nuEnable
nuEmailReportAction
nuEmailReportAction()
Parameters
Return Value
Description
If placed on an Object's click event, it will send areport as an email.
Example
Also See : nuAddActionButton
nuEnable
nuEnable(string1)
Parameters
string1 : Object id.
Return Value
Description
This will enable all parts of a nuBuilder Forte Object.
Example
nuEnable('cus_phone2');
Also See : nuDisable
nuGetBreadcrumb
nuGetBreadcrumb(number1, number2)
Parameters
number1 : breadcrumb number number2 : tab index (optional)
Return Value
Description
Go to a prevoius Breadcrumb and a certain Tab.
Example
nuGetBreadcrumb(0,2);
Also See :
nuGetProperty
value = nuGetProperty(string1)
Parameters
string1 : Form property
Return Value
value : value of Form property
Description
Get a Form's property.
Example
if(nuGetProperty('record_id') == ''){ nuAddActionButton('nuRunPHP', 'Run', 'nuRunPHP("INV")') }
Also See : nuCurrentProperties, nuSetProperty
nuHasBeenEdited
nuHasBeenEdited()
Parameters
Return Value
Description
This will set the staus of an Edit Form to Edited and do 2 things
- The Save Action Button will change to red.
- The web browser will alert the user if leaving the current record before it is saved.
Example
Also See : nuHasNotBeenEdited
nuHasNotBeenEdited
nuHasNotBeenEdited();
Parameters
Return Value
Description
This will set the staus of an Edit Form to not Edited and do 2 things
- The Save Action Button will return to its normal color.
- The web browser will not alert the user when leaving the current record.
Example
Also See : nuHasBeenEdited
nuHide
nuHide(string1)
Parameters
string1 : Object id.
Return Value
Description
This will hide all parts of a nuBuilder Forte Object.
Example
nuHide('cus_phone2');
Also See : nuShow
nuID
nuID()
Parameters
Return Value
Description
Creates a unique string.
Example
nuID();
"c14999473122991924"
Also See : nuID
nuMessage
nuMessage(array1)
Parameters
array1 : an array of strings
Return Value
Description
Displays a message.
Example
nuMessage(['Hello','World']);
Also See :
nuOpenTab
nuOpenTab(number)
Parameters
number : tab index
Return Value
Description
Opens a certain Tab on an Edit Form.
Example
nuOpenTab(0);
Also See : nuRemoveTab
nuPopup
nuPopup(string1, string2, string3)
Parameters
string1 : form id string2 : record id string3 : filter (only if there is no record id eg. a Browse Form)
Return Value
Description
Open a Form in an iFrame.
Example
nuPopup('nudebug', '', 'line 48');
Also See :
nuPrintAction
nuPrintAction()
Parameters
Return Value
Description
If placed on an Object's click event, it will create a HTML form containing the current list in the Browse Form.
Example
Also See : nuAddActionButton
nuRemoveTab
nuRemoveTab(number)
Parameters
number : tab index
Return Value
Description
Removes a certain Tab on an Edit Form.
Example
nuRemoveTab(0);
Also See : nuOpenTab
nuRunPHP
nuRunPHP(string1)
Parameters
string1 : Procedure code
Return Value
Description
If placed on an Object's click event, it will run a Procedure in a new window.
Example
Also See : nuAddActionButton
nuRunPHPHidden
nuRunPHPHidden(string1)
Parameters
string1 : Procedure code
Return Value
Description
If placed on an Object's click event, it will run a Procedure without seeing anything in the browser.
Example
Also See : nuAddActionButton
nuRunReport
nuRunReport(string1)
Parameters
string1 : a Report code
Return Value
Description
If placed on an Object's click event, it will run a Report in a new browser window.
Example
Also See : nuAddActionButton
nuSaveAction
nuSaveAction()
Parameters
Return Value
Description
If placed on an Object's click event, it will save the current record.
Example
Also See : nuAddActionButton
nuSelectTab
nuSelectTab(object1)
Parameters
object1 : HTML element
Return Value
Description
Displays a certain Tab on an Edit Form.
Example
var e = document.getElementById('nuTab1'); nuSelectTab(e);
Also See :
nuSetProperty
nuSetProperty(string1, string2)
Parameters
string1 : Form property string2 : new value
Return Value
Description
Set a Form's property.
Example
nuSetProperty('record_id', -1);
Also See : nuCurrentProperties, nuGetProperty
nuSetTitle
nuSetTitle(string1)
Parameters
string1 : phrase
Return Value
Description
Changes the last breadcrumb to a certain value.
Example
nuSetTitle($('#cus_name').val());
Also See :
nuShow
nuShow(string1)
Parameters
string1 : Object id.
Return Value
Description
This will display all parts of a nuBuilder Forte Object.
Example
nuShow('cus_phone2');
Also See : nuHide
nuSubformObject
object = nuSubformObject(string1)
Parameters
string1 : Subform Object id **Passing an empty string will return the main Edit Form as a Subform object.
Return Value
object : Subform object.
Description
Returns a Javscript object that can be looped through.
All Subform values in this object will have any formatting removed. eg $ 1,234.50 will be 1234.5
Example
JSON.stringify(nuSubformObject('zzzzsys_tab_sf'));
{ "id": "zzzzsys_tab_sf", "foreign_key": "syt_zzzzsys_form_id", "primary_key": "zzzzsys_tab_id", "object_id": "570b3915874d635", "table": "zzzzsys_tab", "action": "save", "rows": [ [ "56777715b87666e", "Main", "10", 0 ], [ "s14986964108605", "Test", "20", 0 ], [ "-1", "", "", 1 ] ], "edited": [ [ 0, 0, 0, 0 ], [ 0, 0, 0, 0 ], [ 0, 0, 0, 0 ] ], "deleted": [ 0, 0, 1 ], "fields": [ "ID", "syt_title", "syt_order", "nuDelete" ] }
Also See : nuSubformObject
nuTotal
nuTotal(string1)
Parameters
string1 : Object id
Return Value
Description
Returns the nuformatted value of a number Object.
The parameter required is either..
- Object id
- Subform id + . + Object id
If a Subform id is included, the total will be of all Objects in that Subform.
Example
nuTotal('invoice_item.ite_total');
54
Also See :
nuTranslate
nuTranslate(string1)
Parameters
string1 : phrase
Return Value
Description
Swaps a nuBuilder phrase with a phrase in Translations.
Example
nuTranslate('Home');
Racine
Also See :