Javascript Functions

See Also

CallFunction(functioncall);

For information on calling functions, see the Database Function Calls section.

CallProcedure(precedurecall);

For information on calling procedures, see the Database Function Calls section.

Delete();

Delete the current record on a form.

DeleteThisRow();

Delete the current record on a list or editable list.

DisableSaveForBlock();

Set the update flag on the current row to N, which prevents them from being saved to the database.  This function only affects the current row, which makes it ideal for use on editable lists with new rows.  

DisableUpdateFlags();

Set all update flags on the block to N which will prevent them from being saved to the database.  If the block has multiple rows, the update flags for all rows will be set to N.

DoListUpdate('form');)

For internal use only.

DoLogin();

Log into Xephr® applications.  This function is used in the On Mouse Click property for the login entity.

DoLogout(action);

Logs the user out of the runtime, destroying the session and authentication state.  Any cookies written to the client are explicitly destroyed.  If no action defined, the login screen is displayed.  Actions can be other Xephr entities or links to URLs, i.e. DoLogout('LOGIN'); or DoLogout('http://www.ndsapps.com/');

DoRecordToXML();

For internal use only.

EditThisRow('entity');

On an editable list, open the entity in Edit mode for the current record.   The entity is optional, and does not need to be entered if you are going to edit mode for the current screen.

EnableSaveForBlock();

Set the update flag on the current row to Y, which will mark them to be saved to the database.  This function only affects the current row, which makes it ideal for use on editable lists with new rows.  

EnableUpdateFlags();

Set the update flags for this block to Y, which will mark all fields on this block to be saved to the database.  If the block has multiple rows, the update flags for all rows will be set to Y.

EnforceLov();

For internal use only.

ExecuteQbe();

Query the database for rows that match the query information entered on this entity.  The entity will be displayed in list mode with the matching rows.

ExecuteReport();

Query the database for rows that match the query information entered on this parameter form.  A report will be generated with the matching rows.

ExecuteShow();

For internal use only.

ExecuteShowInParent();

For internal use only.

FieldIsLowerCase();

For internal use only.

FieldIsUpperCase();

For internal use only.

GetColumnValue('field');

On an editable list, get the value in the defined field.

GetFunctionMessage();

For internal use only.

GetGlobalValue('name');

Get the value stored in the global variable defined here.

GetQualifiedName();

For internal use only.

GetRealColumn('field');

For internal use only.

HasColumnChanged('field');

Determine if the value in the field defined here has been changed.  This function returns true or false.

HasRowChanged();

Determine if any values in the current row have been changed.  This function returns true or false.

Insert();

Insert the data entered on the screen into the database as a new record.  Insert is generally used on New screens.

IsConfirmation();

For internal use only.

IsError();

For internal use only.

IsIteration();

For internal use only.

IsJavaException();

For internal use only.

IsRowNew();

Determine if the current row is a new row.  This function returns true or false.

OldCallFunction();

For internal use only.

Refresh();

Refresh the screen.

RefreshParent();

Used on pop-up screens, this will refresh the entity from which this entity was generated.

RemoveGlobalValue('name');

Remove the value stored in the defined global variable.

ResetLov();

For internal use only.

ReturnValueToParent('value');

Return the defined value to the parent.  This function is used when values are obtained from other entities.

RowExists();

Determine if the current row exists in the database.  Used on editable list entities when there are new rows defined.

Save();

Save the changes to the database.  Update existing database rows and insert any new rows.

Save('NO_SUCCESS_DIALOG');

Save the changes to the database.  Update existing database rows and insert any new rows.  Do not display the 'Update Successful' pop-up message if the save has no errors.

SequenceInsert('block.field','sequence');

Obtain the next value from the defined sequence, enter that value into the defined field, and then insert the data entered on the screen into the database as a new record.

SetAllValues( 'block', 'field', 'value');

Set the value in the defined field on the defined block to the specified value.  This is primarily useful for editable lists, as it will set ALL of the fields by that name for ALL of the rows returned to the same value.  For Checkbox fields, to set the checkbox, use Y, to reset it use N.  For other fields, just use the text you want to use.

SetColumnTo('field','value');

Set the value of the defined field in the current block to the defined value.

SetColumnValue( 'target block', 'target field', 'source field');

Set the values of the defined field to the value in the source field.

SetFocus('block.field');

Put the cursor in the defined field.

SetGlobalValue('name','value');

Set the value for the named global variable to the defined value.  See the Global Variables and Values section for more information.

SetParameters('target block.field','value');

Set the target field on the target block to the defined value.  For more information, see the Passing Value Between Entities section.

SetReturnedValue();

For internal use only.

Show('entity','block.field','value');

Open the defined entity in its default mode, carrying the defined values to the defined field on the defined block.  For more information, see the Passing Value Between Entities section.

ShowCalculator();

Display the calculator.

ShowCalendar();

Display the calendar.

ShowEdit('entity','block.field','value');

Open the defined entity in edit mode, carrying the defined values to the defined field on the defined block.  For more information, see the Passing Value Between Entities section.

ShowEditInParent('entity','block.field','value');

Used on pop-up screens, open the defined entity in edit mode in the window from which this screen was generated, carrying the defined values to the defined field on the defined block.  For more information, see the Passing Value Between Entities section.

ShowEditor();

Display the Editor.

ShowInParent('entity');

Used on pop-up screens, show the defined entity in the window from which this screen was generated.  For more information, see the Passing Value Between Entities section.

ShowInWindow('entity', 'mode', 'height', 'width', 'top', 'left');

Show the defined entity in the defined mode.  The height, width, top, and left values define the size of the new entity.  For more information, see the Passing Value Between Entities section.

ShowList('entity','block.field','value');

Open the defined entity in list mode, carrying the defined values to the defined field on the defined block.   For more information, see the Passing Value Between Entities section.

ShowListInParent('entity','block.field','value');

Used on pop-up screens, open the defined entity in list mode in the window from which this screen was generated, carrying the defined values to the defined field on the defined block.   For more information, see the Passing Value Between Entities section.

ShowLov();

Display the list of values.

ShowNew('entity','block.field','value');

Open the defined entity in new mode, carrying the defined values to the defined field on the defined block.   For more information, see the Passing Value Between Entities section.

ShowNewInParent('entity','block.field','value');

Used on pop-up screens, open the defined entity in new mode in the window from which this screen was generated, carrying the defined values to the defined field on the defined block.   For more information, see the Passing Value Between Entities section.

ShowParameterForm('report','block.field','value');

Run the defined report, opening the parameter form first, carrying the defined values to the defined field on the defined block.  For more information, see the Passing Value Between Entities section.  

ShowParameterFormInParent('report','block.field','value');

Used on pop-up screens, run the defined report, opening the parameter form first in the window from which this screen was generated, carrying the defined values to the defined field on the defined block.  For more information, see the Passing Value Between Entities section.  

ShowQBE('entity','block.field','value');

Open the defined entity in QBE mode, carrying the defined values to the defined field on the defined block.   For more information, see the Passing Value Between Entities section.

ShowQBEInParent('entity','block.field','value');

Used on pop-up screens, open the defined entity in QBE mode in the window from which this screen was generated, carrying the defined values to the defined field on the defined block.   For more information, see the Passing Value Between Entities section.

ShowReport('report', 'block.field','value');

Run the defined report without displaying the parameter form, carrying the defined values to the defined field on the defined block.  For more information, see the Passing Value Between Entities section.

ShowReportInParent('report', 'block.field','value');

Used on pop-up screens, run the defined report without displaying the parameter form in the window from which this screen was generated, carrying the defined values to the defined field on the defined block.  For more information, see the Passing Value Between Entities section.

Xephr is a registered trademark of NDS Systems, LC.