# Functions

- [addCalendarEventSource](/brixxbox-documentation/client-api-reference/functions/addcalendareventsource.md): (Beta) Adds an event source object to the calendar
- [addClassToGridRowCell](/brixxbox-documentation/client-api-reference/functions/addclasstogridrowcell.md): This function is used to color a single cell in a grid, or highlight it.
- [addEventListener](/brixxbox-documentation/client-api-reference/functions/addeventlistener.md): Adds an Event Listener to the brixxbox or one of its controls
- [addToolbarButton](/brixxbox-documentation/client-api-reference/functions/addtoolbarbutton.md): Add Toolbar Buttons with different functionalities.
- [brixxGPT](/brixxbox-documentation/client-api-reference/functions/brixxgpt.md): Calls the OpenAI integration in brixxbox
- [businessBrixx](/brixxbox-documentation/client-api-reference/functions/businessbrixx.md): Business Brixxes provides special features for business usecases. Each Brixx has an individual set of parameters plus some parameters that are valid for all businessfunctions.
- [DHL Shiping](/brixxbox-documentation/client-api-reference/functions/businessbrixx/dhl-shiping.md)
- [CreateShipment](/brixxbox-documentation/client-api-reference/functions/businessbrixx/dhl-shiping/createshipment.md): Creates a DHL Shipping Label.
- [GetLabel](/brixxbox-documentation/client-api-reference/functions/businessbrixx/dhl-shiping/getlabel.md): Shows the shipment Label again.
- [DPD Shiping](/brixxbox-documentation/client-api-reference/functions/businessbrixx/dpd-shiping.md)
- [CreateShipment](/brixxbox-documentation/client-api-reference/functions/businessbrixx/dpd-shiping/createshipment.md): Creates a DPD Shipping Label
- [UPS Shiping](/brixxbox-documentation/client-api-reference/functions/businessbrixx/ups-shiping.md)
- [Inventory Movement](/brixxbox-documentation/client-api-reference/functions/businessbrixx/inventory-movement.md): Stores an inventory movement in a table with a certain structure. The Function handles database transactions and generates movement ids.
- [Currency Conveter](/brixxbox-documentation/client-api-reference/functions/businessbrixx/currency-conveter.md): Converts a currency to another currency
- [Datev Export](/brixxbox-documentation/client-api-reference/functions/businessbrixx/datev-export.md): This function exports a Datev CSV file for a given timeframe. The fuction needs 3 customized SQL scripts to process the data.
- [Datev Export SqlDataRead Example](/brixxbox-documentation/client-api-reference/functions/businessbrixx/datev-export/datev-export-sqldataread-example.md): Example for a getDatevData script
- [Datev Export sqlMainData Example](/brixxbox-documentation/client-api-reference/functions/businessbrixx/datev-export/datev-export-sqlmaindata-example.md): This is the script, which is responsible for collection all the address data, which needs to be exported.
- [Datev Export sqlGetCounter  Example](/brixxbox-documentation/client-api-reference/functions/businessbrixx/datev-export/datev-export-sqlgetcounter-example.md): This is the main script, which is responsible for collection all the data, which needs to be exported.
- [GS1 Code Splitter](/brixxbox-documentation/client-api-reference/functions/businessbrixx/gs1-code-splitter.md): Splits a GS1 code into its AIs and values
- [SEPA Export](/brixxbox-documentation/client-api-reference/functions/businessbrixx/sepa-export.md): This module creates a SEPA file in XML format.
- [Diamant Connector](/brixxbox-documentation/client-api-reference/functions/businessbrixx/diamant-connector.md): This brixxbox module allows to retrieve data from the Diamant Accounting Software and post data to it
- [Diamant OpenStack](/brixxbox-documentation/client-api-reference/functions/businessbrixx/diamant-connector/diamant-openstack.md): Opens a booking stack and returns the number to the client
- [Diamant Transaction](/brixxbox-documentation/client-api-reference/functions/businessbrixx/diamant-connector/diamant-transaction.md): Creates a transaction in diamant
- [Diamant CloseStack](/brixxbox-documentation/client-api-reference/functions/businessbrixx/diamant-connector/diamant-closestack.md): Closes a booking stack that qas previously open by OpenStack
- [cancelCalendarChanges](/brixxbox-documentation/client-api-reference/functions/cancelcalendarchanges.md): (Beta) Cancels the drag or edit operation that triggered the OnEventChange event and moves all events back to their origin position. Must be used inside the OnEventChange event.
- [callWebHook](/brixxbox-documentation/client-api-reference/functions/callwebhook.md): Calls a webhook to trigger a system to do anything like posting a message to a teams channel.
- [changeHelpText](/brixxbox-documentation/client-api-reference/functions/changehelptext.md): Changes an existing help text for a control at runtime.
- [clearGridSelection](/brixxbox-documentation/client-api-reference/functions/cleargridselection.md): Unselects all rows of a data grid.
- [cloudPrint](/brixxbox-documentation/client-api-reference/functions/cloudprint.md)
- [cloudQuery](/brixxbox-documentation/client-api-reference/functions/cloudquery.md)
- [closeModal](/brixxbox-documentation/client-api-reference/functions/closemodal.md): If the current brixxbox app is startet in a modal window, that window will be closed.
- [composeEmail](/brixxbox-documentation/client-api-reference/functions/composeemail.md): Shows the email compose Dialog, or sends an email without an interface popup.
- [createPublicAppUrl](/brixxbox-documentation/client-api-reference/functions/createpublicappurl.md): Creates an url, that leads to a standalone app for pulic use. There is still a valid user logged in. The public user has to be configured in the settings as a "valid external user" for security reason
- [copyConfigRecordById](/brixxbox-documentation/client-api-reference/functions/copyconfigrecordbyid.md)
- [createReport](/brixxbox-documentation/client-api-reference/functions/createreport.md): Creates a report on the Server and retrieves it to the client. The only format, currently supported is pdf.
- [ZUGFeRD](/brixxbox-documentation/client-api-reference/functions/createreport/zugferd.md)
- [deleteAttachment](/brixxbox-documentation/client-api-reference/functions/deleteattachment.md): Deletes an attachment and its link to a record.
- [deleteConfigRecordById](/brixxbox-documentation/client-api-reference/functions/deleteconfigrecordbyid.md): Deletes a record of a given config
- [deleteRecord](/brixxbox-documentation/client-api-reference/functions/deleterecord.md): Deletes a record from the database.
- [displayRecord](/brixxbox-documentation/client-api-reference/functions/displayrecord.md)
- [downloadAttachments](/brixxbox-documentation/client-api-reference/functions/downloadattachments.md): Downloads a list of attachment ids as a zip file.
- [disableGridHyperLinks](/brixxbox-documentation/client-api-reference/functions/disablegridhyperlinks.md): Disables (or enables) the hyperlinks in grid cells, automatically generated for combo box controls. This function also refreshes the grid.
- [enableNotifications](/brixxbox-documentation/client-api-reference/functions/enablenotifications.md): This function is used to disable or enable app messages, that are displayed automatically, like the "record Saved" message, after a successful save operation.
- [enableValidator](/brixxbox-documentation/client-api-reference/functions/enablevalidator.md): Enables or disables field validator.
- [excludeFromReadonly](/brixxbox-documentation/client-api-reference/functions/excludefromreadonly.md): It provides the functionality of excluding controls from being affected by the readOnlyMode.
- [executeStoredProcedure](/brixxbox-documentation/client-api-reference/functions/executestoredprocedure.md): Executes a stored procedure.
- [getAttachmentId](/brixxbox-documentation/client-api-reference/functions/getattachmentid.md): Returns the id of an attachment of the current record by looking for the given file name.
- [getAttachmentById](/brixxbox-documentation/client-api-reference/functions/getattachmentbyid.md): Gets and attachment by its unique id.
- [getAttachmentByFileName](/brixxbox-documentation/client-api-reference/functions/getattachmentbyfilename.md): Retrieves the blob of an attachment from the attachments of the current record
- [getAttachmentsForCurrentRecord](/brixxbox-documentation/client-api-reference/functions/getattachmentsforcurrentrecord.md): Returns a list of all the attachments of the current record. The list is ordereb by id desc. so the newest documents will be the first you will find while iterating over the array.
- [getLastAttachmentByRecordId](/brixxbox-documentation/client-api-reference/functions/getlastattachmentbyrecordid.md): Retrieves the most recent attachment for a given record ID as a blob.
- [getBrowserToken](/brixxbox-documentation/client-api-reference/functions/getbrowsertoken.md)
- [getControlUnmodifiedValue](/brixxbox-documentation/client-api-reference/functions/getcontrolunmodifiedvalue.md): Gets the unmodified value of the control.
- [getCustomMessage](/brixxbox-documentation/client-api-reference/functions/getcustommessage.md): Returns a custom message from the message manager. It replaces possibly passed parameters in the message. The target language can also be set.
- [getCustomSetting](/brixxbox-documentation/client-api-reference/functions/getcustomsetting.md): Retrieve a value for a specific custom setting.
- [getCalcDateTime](/brixxbox-documentation/client-api-reference/functions/getcalcdatetime.md): Gets a DateTime as a compareable number with a given accuracy.
- [getHtmlElement](/brixxbox-documentation/client-api-reference/functions/gethtmlelement.md): Gets the html element for this brixxbox control.
- [getDate](/brixxbox-documentation/client-api-reference/functions/getdate.md): As the name suggests, this functions is to get date. This function when used without any arguments returns a date in this format 'yyyy-mm-dd'.
- [getCalcDate](/brixxbox-documentation/client-api-reference/functions/getcalcdate.md): Converts a date to the total days since 1.1.1970 to make it easy comparable. You can use Date, or DateTime as input and even if two datetime values do have different times.
- [getFieldValue](/brixxbox-documentation/client-api-reference/functions/getfieldvalue.md): Gets a value to a specific field
- [getSessionToken](/brixxbox-documentation/client-api-reference/functions/getsessiontoken.md)
- [getUserClaim](/brixxbox-documentation/client-api-reference/functions/getuserclaim.md)
- [getConfigRecordAttachmentIdByFileName](/brixxbox-documentation/client-api-reference/functions/getconfigrecordattachmentidbyfilename.md): Returns an id of an attachment of a record in a config.
- [getSignatureImageBlob](/brixxbox-documentation/client-api-reference/functions/getsignatureimageblob.md): Returns the signature of a signature control as a png (default) or svg image blob.
- [getGeoLocation](/brixxbox-documentation/client-api-reference/functions/getgeolocation.md): Returns the geo location and additional information like speed and altitude if available. Be aware, that this is an asynchronous function and you have to use await.
- [getLabelText](/brixxbox-documentation/client-api-reference/functions/getlabeltext.md): Gets the current or original lable text for a control.
- [globalSearch](/brixxbox-documentation/client-api-reference/functions/globalsearch.md)
- [initAllControls](/brixxbox-documentation/client-api-reference/functions/initallcontrols.md): Initializes all controls within a brixxbox App to their empty states.
- [initControl](/brixxbox-documentation/client-api-reference/functions/initcontrol.md): Initializes a control to its empty state
- [isModal](/brixxbox-documentation/client-api-reference/functions/ismodal.md): Determens if the current brixxbox app is started in a modal window.
- [isUserInRole](/brixxbox-documentation/client-api-reference/functions/isuserinrole.md): All users in any Brixxbox workspace shoyuld have been assigned a specific user role. isUserInRole takes a string argument role. On the basis of this role parameter, it determines whether a logged user
- [isRowSelected](/brixxbox-documentation/client-api-reference/functions/isrowselected.md): Checks if a row in a grid is selected or not.
- [inviteUser](/brixxbox-documentation/client-api-reference/functions/inviteuser.md)
- [localValue](/brixxbox-documentation/client-api-reference/functions/localvalue.md)
- [loadAndDisplayRecord](/brixxbox-documentation/client-api-reference/functions/loadanddisplayrecord.md)
- [loadAndDisplayRecordById](/brixxbox-documentation/client-api-reference/functions/loadanddisplayrecordbyid.md)
- [loadConfigRecordByValue](/brixxbox-documentation/client-api-reference/functions/loadconfigrecordbyvalue.md): Loads a record of a specific app config from brixxbox server by a specified field and returns a promise. This is a async function. You have to await the result, if you want to use it.
- [loadConfigRecordById](/brixxbox-documentation/client-api-reference/functions/loadconfigrecordbyid.md): Loads a record of a specific app config from brixxbox server and returns a promise. This is a async function. You have to await the result, if you want to use it.
- [loadRecord](/brixxbox-documentation/client-api-reference/functions/loadrecord.md)
- [loadRecordById](/brixxbox-documentation/client-api-reference/functions/loadrecordbyid.md)
- [logAdd](/brixxbox-documentation/client-api-reference/functions/logadd.md)
- [logout](/brixxbox-documentation/client-api-reference/functions/logout.md): Logs the user out. The user has to go to the login screen again to get access.
- [markAllControlsAsUnModified](/brixxbox-documentation/client-api-reference/functions/markallcontrolsasunmodified.md): Removes all modification flags from the controls. After this call, the user will not get a "discard changes" message until another control is modified.
- [messageBox](/brixxbox-documentation/client-api-reference/functions/messagebox.md): Displays a modal messagebox with buttons. The function will return when a button is clicked and return the value, if set, otherwise the title of the clicked button
- [newGridEntry](/brixxbox-documentation/client-api-reference/functions/newgridentry.md): Creates a new grid line for a data grid.
- [newRecord](/brixxbox-documentation/client-api-reference/functions/newrecord.md): Initializes the app, so that you can enter a new record
- [printBlob](/brixxbox-documentation/client-api-reference/functions/printblob.md): Prints a document that is a blob. You might get a blob by requesting an attachmen
- [print](/brixxbox-documentation/client-api-reference/functions/print.md): Prints a report
- [readOnlyMode](/brixxbox-documentation/client-api-reference/functions/readonlymode.md): It can set the whole brixxbox app or some controls depending upon the use case which is required, in a readonly mode. All Input fields, save- new- and delete toolbar buttons are disabled.
- [refresh](/brixxbox-documentation/client-api-reference/functions/refresh.md): Reloads the content of a single control (like combobox or grid) or of all such controls in an brixxbox application.
- [refreshAttachments](/brixxbox-documentation/client-api-reference/functions/refreshattachments.md): Refreshes the attachment grid in the sidebar if it is visible
- [refreshDataSource](/brixxbox-documentation/client-api-reference/functions/refreshdatasource.md): Refreshes the content of a single control based on its DataSource (not the SubDataSource!). If outside parameters have changed, you can force the brixxbox to reload the content of that control.
- [refreshBadges](/brixxbox-documentation/client-api-reference/functions/refreshbadges.md): Refreshes all Badges of an app at once.
- [reInitValidation](/brixxbox-documentation/client-api-reference/functions/reinitvalidation.md): Resets all validators of an app to their default state. So you don't have to bother with enableValidator to reset them or what the default state is.
- [replaceText](/brixxbox-documentation/client-api-reference/functions/replacetext.md): Replaces a text with the current values of the app.
- [serverFunction](/brixxbox-documentation/client-api-reference/functions/serverfunction.md): Calls a server function and returns the result
- [setControlUnmodifiedValue](/brixxbox-documentation/client-api-reference/functions/setcontrolunmodifiedvalue.md): Sets the value, that is used to compare to the actual control value. If both are not equal, the field will be marked as changed.
- [setFieldValue](/brixxbox-documentation/client-api-reference/functions/setfieldvalue.md): brixxApi function to set a value to a field
- [setLabelText](/brixxbox-documentation/client-api-reference/functions/setlabeltext.md): Sets the label text for a control at runtime.
- [setTooltipText](/brixxbox-documentation/client-api-reference/functions/settooltiptext.md): Sets the  tooltip text for a control at runtime.
- [setToolbarButtonMode](/brixxbox-documentation/client-api-reference/functions/settoolbarbuttonmode.md): A toolbar is a set of tools. These tools are assigned to each app present in a workspace in Brixxbox. A general toolbar for an app looks like this.
- [setEnable](/brixxbox-documentation/client-api-reference/functions/setenable.md): Enables or disables a specific control.
- [setVisibility](/brixxbox-documentation/client-api-reference/functions/setvisibility.md): Sets the visibility for a specific control.
- [startBrixxbox](/brixxbox-documentation/client-api-reference/functions/startbrixxbox.md): Starts a brixxbox app.
- [startMode](/brixxbox-documentation/client-api-reference/functions/startmode.md): Shows the start mode of the brixxApi - if any.
- [startScanner](/brixxbox-documentation/client-api-reference/functions/startscanner.md)
- [showBlob](/brixxbox-documentation/client-api-reference/functions/showblob.md): Shows a blob document in a docViewer control.
- [showMessage](/brixxbox-documentation/client-api-reference/functions/showmessage.md): Displays a message to the user.
- [showAttachments](/brixxbox-documentation/client-api-reference/functions/showattachments.md): opens the attachment sidebar with the attachment for the current record.
- [showDiscussion](/brixxbox-documentation/client-api-reference/functions/showdiscussion.md): Opens the discussion sidebar with the chat/discussion for the current record.
- [showWikiPage](/brixxbox-documentation/client-api-reference/functions/showwikipage.md): Displays a wiki page in the right sidebar.
- [sqlReadValue](/brixxbox-documentation/client-api-reference/functions/sqlreadvalue.md): Reads a single value from a standard sql statement. See SQL Statements for how to create statements.
- [sqlWrite](/brixxbox-documentation/client-api-reference/functions/sqlwrite.md): This method executes an SQL statement that can modify data (INSERT, UPDATE, DELETE) or return data (when the statement includes SELECT, OUTPUT INSERTED, or RETURNING clauses).
- [sqlRead](/brixxbox-documentation/client-api-reference/functions/sqlread.md): Reads data from a Standard Sql Statement. See SQL Statements for how to create statements.
- [saveCurrentRecordWithoutEvents](/brixxbox-documentation/client-api-reference/functions/savecurrentrecordwithoutevents.md)
- [saveCurrentRecord](/brixxbox-documentation/client-api-reference/functions/savecurrentrecord.md): Saves the changes to the current record in the database.
- [saveConfigRecord](/brixxbox-documentation/client-api-reference/functions/saveconfigrecord.md): Saves a record for a config
- [saveStructure](/brixxbox-documentation/client-api-reference/functions/savestructure.md)
- [setBackgroundColor](/brixxbox-documentation/client-api-reference/functions/setbackgroundcolor.md): Sets the background color of a control.
- [setFontStyle](/brixxbox-documentation/client-api-reference/functions/setfontstyle.md): Sets the font style of a control.
- [setFontWeight](/brixxbox-documentation/client-api-reference/functions/setfontweight.md): Sets the font weight of a control.
- [setGridDefaults](/brixxbox-documentation/client-api-reference/functions/setgriddefaults.md)
- [setTextColor](/brixxbox-documentation/client-api-reference/functions/settextcolor.md): Sets the text color for a control to one of the predefined colors
- [setFocus](/brixxbox-documentation/client-api-reference/functions/setfocus.md): Sets the cursor focus to a specific control and optionally selects the existing text.
- [setDecimalDigits](/brixxbox-documentation/client-api-reference/functions/setdecimaldigits.md): Change the decimal digits of a numeric field.
- [switchTagControl](/brixxbox-documentation/client-api-reference/functions/switchtagcontrol.md): Changes the tag control to edit mode and vice versa.
- [selectGridRows](/brixxbox-documentation/client-api-reference/functions/selectgridrows.md): Selects all rows with a specific value in a data grid column.
- [showRowDetailPanel](/brixxbox-documentation/client-api-reference/functions/showrowdetailpanel.md): This function is used to toggle the row detail panel of a grid row.
- [showRowDetailButton](/brixxbox-documentation/client-api-reference/functions/showrowdetailbutton.md): This function is used to toggle the row detail button, that opens the child app, based on the row data.
- [setGridAutoRefresh](/brixxbox-documentation/client-api-reference/functions/setgridautorefresh.md): Sets the auto refresh interval for grids. Only valid for grids with this setting enabled.
- [setGridGrouping](/brixxbox-documentation/client-api-reference/functions/setgridgrouping.md): Sets the grouping options for a grid control.
- [showMessageBox (deprecated)](/brixxbox-documentation/client-api-reference/functions/showmessagebox-deprecated.md)
- [showTabPage](/brixxbox-documentation/client-api-reference/functions/showtabpage.md): Selects a Tab Page.
- [setFieldUnit](/brixxbox-documentation/client-api-reference/functions/setfieldunit.md): Add or set a unit in front of a numeric or text field.
- [takePicture](/brixxbox-documentation/client-api-reference/functions/takepicture.md)
- [triggerEvent](/brixxbox-documentation/client-api-reference/functions/triggerevent.md): Triggers an events for a control, or the brixxbox app itself. Some events are on brixxbox App level (like e.g. onRecordSaved ). Other events are on control level (like e.g. onClick)
- [toggleGridSelection](/brixxbox-documentation/client-api-reference/functions/togglegridselection.md): Toggles the grid selection for a whole grid.
- [unselectGridRows](/brixxbox-documentation/client-api-reference/functions/unselectgridrows.md): Deselects all rows with a specific value in a column.
- [uploadAttachment](/brixxbox-documentation/client-api-reference/functions/uploadattachment.md): Uploads an attachement
- [updateTitle](/brixxbox-documentation/client-api-reference/functions/updatetitle.md)
- [validateInput](/brixxbox-documentation/client-api-reference/functions/validateinput.md): Checks the field Validation for all controls.
- [queryStoredProcedure](/brixxbox-documentation/client-api-reference/functions/querystoredprocedure.md): Executes a stored procedure and returns the query result.
- [setValidatorValue](/brixxbox-documentation/client-api-reference/functions/setvalidatorvalue.md): Updating a validator with a new target value