1 of 37

Events

onAppStart

The event occurs when an app is started but before a record is loaded and the OnAppInitialized event is fired. Default Values are set at this point.

onAppInitialized

The event occurs when an app is initialized. The OnAppStarted event is processed at this point. If a record id was given as a start parameter, the record is loaded and displayed at this time.

onAttachmentDeleted

The event occurs when a user deletes an attachment from the right sidebar. The delete attachment function does not trigger the event.

onAttachmentsShow

This event is called just before the attachments panel open. Can be used to set the config and id of the attachments you want to show. This is an App wide event!

Example Usages

   app.attachmentRecordId = app.getFieldValue("addressId");
   app.attachmentAppName = "address";

onAttachmentsHide

The event occurs when the right sidebar for attachments gets closed

onChange

The event occurs when a control content is changed. You can use app.isLoadingRecord if you need to know if a record is loading and that is the reason for the change event.

onCellClick

The event occurs when a grid cell is clicked. You can get more information where exactly the user has clicked.

    let rowElement = app.getFieldValue("myGrid.clickedRow"); //The html Row element (a tr)
    let cellElement = app.getFieldValue("myGrid.clickedCell"); //The html Cell element (a td)
    let cellId = app.getFieldValue("myGrid.clickedCellId"); //column id of the clicked cell (e.g. "adrFirstName")

onCellEdit

The event is triggered when a grid cell value is changed thru the funtionality of the grid CellEdit settings.

For more details check GridCellEdit

onClick

The event occurs when a control is clicked.

onChildAppClosed

This event is called when a child app of you current app is closed. The closed app object is available under eventArgs.details in the even source code- But be aware, that this app is closed. You can access properties liek appName but you might not use saveConfigRecord or such methods on the closed app.

Example Usages

   app.refreshDatasource("orderQuantity");

   console.log("The app: ${eventArgs.details.appName} was closed");

onDataTransform

The event can be used to transform a datasource line.

This function is often used to transform a event object. Called once pre received record. Must return a calender event.

Example 1

Modifiy an existing record, to keep all the information but add new properties for the event

Example 2

Create a new record.

onEventClick

The event occurs the user clicks on one of the events. getFieldValue('controlId.changedEvent') or eventArgs.details can be used to determin the clicked event

app.startBrixxbox({
      appName: "appointmentDetails",
      id: eventArgs.details.id, //eventArgs.details provides the clicked event object
      startMode: "modal"
   });

Google Calendar

Here are some usecases for event clicks you might find helpful. In Case you are using a google calendar, you could open the calendar event in a new window.

    window.open(eventArgs.details.url, '_blank', 'width=700,height=600'); //this is our custom operation. we will open the event in a new window.

Or you can return false at the end of the event source code, which means, that you did not handle the event by yourself and there for to execute the default behavior.

onEventChange

The event occurs the user moves or modifies an event. getFieldValue('controlId.changedEvent') or eventArgs.details can be used to determin the changed event

You can get mor information about the effects:

the event before the change: getFieldValue('myCalendarControl.oldEvent')
other events that got affected: getFieldValue('myCalendarControl.relatedEvents')

You can call cancelCalendarChanges to cancel all the changes

let eventObj = app.getFieldValue("myCal.changedEvent");
let record = app.loadConfigRecordById("appointment", eventObj.id);
record.data.aStart = eventObj.start;
record.data.aEnd = eventObj.end;
app.saveConfigRecord("appointment", record);

onFileImport

The event occurs when an file was selected on a fileImport control. The import function will detect if the file is using a comma or a semicolon as separator. Brixxbox will therefore count the occurrences of commas and semicolons in the first line (Header) and will use the higher counted char as separator.

You can access eventArgs.details inside this event to get the file content and meta data:

eventArgs.details.csvLines - Array of all lines splitted by csv rules
eventArgs.details.lines - Array of all lines splitted by csv rules
eventArgs.details.fileExtension - extension of the import file ("csv" for example)
eventArgs.details.fileExtensionLower - extension of the import file in lowercase
eventArgs.details.fileInfo - a javascript file info object
eventArgs.details.fileName - the file name
eventArgs.details.fileNameLower - the file name in lowercase
eventArgs.details.fileNameFull - the file name with extension
eventArgs.details.fileNameFullLower - the file name with extension in lowercase
eventArgs.details.rawData - the whole file content as a single text
eventArgs.details.rawLines - an array of all the lines. Use this if you want to split the lines following your own rules

for(let i = 0; i < eventArgs.details.lines.length; i++){
    console.log(`This is line ${i} with name: ${eventArgs.details.lines[i].myNameField}`);
}

onKeyDown

Further information about key events

   console.log(event);
/*
event.type 
event.target 
event.which 
event.altKey 
event.keyCode 
event.shiftKey 
event.ctrlKey 
*/

onKeyPress

The event occurs when a key is pressed. You can access the event information, using the event parameter.

onModalClose

The event occurs when an app closes from a modal state.

onMailHistoryShow

This event is called just before the mail history panel open.

Example Usages

   console.log("mail history panel opened");

onRowClick

The event occurs when a grid row is clicked. You can get more information where exactly the user has clicked.

onRecordLoad

The event occurs right before a record is loaded. By returning false, the following load operation is canceled

onRecordLoaded

The event occurs after a record is loaded and displayed. You could do some updates or refreshes at this point.

onRecordSave

The event occurs right before a record is saved. By returning false, the following save operation is canceled

onRecordSaved

The event occurs when a record is saved. You might want to do some additional tasks in that case.

onRowSelectionChanged

Scope: grid The event is triggered when the selection of grid lines change. When a line is selected or deselected.

onRowCreated

The event occurs when a grid control displays a row. RowCreated does not mean that a database record is created.

The are a couple of special objects you coul use in this event type:

eventArgs.details.row - this is the new row as a html element.
eventArgs.details.data- this is the record used for this row
eventArgs.details.index- this is the index of the row in the entire grid

onRecordNew

The event occurs on app level as well as on a grid control.

App Level

On app level, this event is mostly used to initialize certain fields.

Grid Control

eventArgs.details gives you the startBrixxbox parameters befor the brixxbox for the new record is started. You could add additional values to the start object or change the app to use.

onRecordDelete

The event occurs right before a record is deleted. By returning false, the following delete operation is canceled

   console.log("deleting a record");
   if(a != b){
       return false; //cancel the delete
   }

onRecordDeleted

Scope: grid, app wide The event occurs when a record is deleted. The ids of the deleted records are passed as an array in eventArgs.details for example: ["1", "5", "10007"]

   console.log('Deleted records: ' + eventArgs.details);

Another example to iterate over the deleted record ids:

   for(let i = 0; i < eventArgs.details.length; i++){
       console.log("Deleted id: " + eventArgs.details[i]);
   }

onKeyUp

The event occurs when a key is released. You can access the event information, using the event parameter.

Further information about key events

   console.log(event);
/*
event.type 
event.target 
event.which 
event.altKey 
event.keyCode 
event.shiftKey 
event.ctrlKey 
*/

onScan

The scan events gets triggered when a barcode (or 2D code) is scanned, e.g. by using the wedgeScanner control. You can then ask the control for the scanned code.

Simple Example

    console.log("The scanned code is: " app.getFieldValue("myScannerControlId"));

Example using the GS1 Splitter business function

let result = await brixxApi.businessBrixx({
     functionName:"Gs1Splitter",
     methodName: "Split",
     gs1Code: brixxApi.getFieldValue("myScannerControlId")
 });
 console.log(result)

onReturnFromModal

The event occurs when a modal child app is closed. This is a good opportunity to refresh some data because the child app might have modified it. Remember: Grids are refreshed automatically if you return from a modal app. The closed app object is available under eventArgs.details in the even source code- But be aware, that this app is closed. You can access properties liek appName but you might not use saveConfigRecord or such methods on the closed app.

   app.refreshDatasource("orderQuantity");

   console.log("The app: ${eventArgs.details.appName} was closed");

onSubDataRequest

This event is called when a subDataSource is requested. You can return the data here instead of fetching it from the server automatically

Example Usages

Example Usages 2

Example Usages 3

onTabShown

The event occurs when a tab page comes to the visible state. You might want to refresh some data here.

onTimeSelected

The event is triggered when a empty time period is selected by the user. You can use this to create a new calendar event

onPictureTaken

Event that gets fired, when a camera control has taken a new picture

Example usage for onPictureTaken

Print picture

Add picture to image control

Add picture to attachements

OnCheckPermissions

The event occurs once after OnAppInitialized, when a possible record, that came as a parameter is loaded. You can put your code, where you check all your permission changes here, and trigger this event in OnChange events manually if you need to.