Here's the complete list of fire events for your pleasure!
QSBridge FireEvent Commands
CancelTransaction
Description
Cancel the current transaction and start a new one. If there are items on the screen, then the user is asked whether or not to cancel the transaction.
Parameters
None
Return Value
True if the transaction was canceled False if not.
ClearCustomer
Description
Clear the current customer
Parameters
None
Return Value
True if the command was successful False if the command failed
ClearStatus
Description
Clear the error status of QSRules.
Parameters
None
Return Value
True if the command was successful False if the command failed
ConcludeTransaction
Description
Tender (and post) the current transaction. It also enables you to perform other functions based on the activity at hand (i.e. sales quotes, work orders, and layaways.) For example, assume you just recalled a work order. You can use this function to save changes, pick up the entire work order, or pick up a partial order.
Parameters
None
Return Value
True if the command was successful False if the command failed
CreateBackOrder
Description
Convert the current transaction into a backorder transaction
Parameters
None
Return Value
True if the command was successful False if the command failed
CreateHold
Description
Convert the current transaction into a hold transaction
Parameters
None
Return Value
True if the command was successful False if the command failed
CreateLayaway
Description
Convert the current transaction into a layaway transaction
Parameters
None
Return Value
True if the command was successful False if the command failed
CreatePostVoid
Description
Convert the current transaction into a post-void transaction
Parameters
None
Return Value
True if the command was successful False if the command failed
CreateQuote
Description
Convert the current transaction into a quote transaction
Parameters
None
Return Value
True if the command was successful False if the command failed
CreateSale
Description
Convert the current transaction into a sale (normal) transaction
Parameters
None
Return Value
True if the command was successful False if the command failed
CreateWorkOrder
Description
Convert the current transaction into a work order transaction
Parameters
None
Return Value
True if the command was successful False if the command failed
GetStatusText
Description
Returns the English text of the current QSRules error status.
Parameters
None
Return Value
A string indicating the current error status.
ExecuteProgram
Description
Launch an external Windows program
Parameters
Description A string describing the application Filename A string indicating the file to launch CommandLine A string containing the additional parameters.
Return Value
True if the command was successful False if the command failed
ExecuteProgramAndWait
Description
Launch an external Windows program and wait until it completes
Parameters
Description A string describing the application Filename A string indicating the file to launch CommandLine A string containing the additional parameters.
Return Value
The return value of the executable
HideCustom
Description
Hide the custom POS buttons.
Parameters
None
Return Value
True if the command was successful False if the command failed
HideFunction
Description
Hide the function buttons at the bottom of the POS screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
HideStatus
Description
Hide the status line at the top of the POS.
Parameters
None
Return Value
True if the command was successful False if the command failed
HideTotals
Description
Hide the total panels at the bottom of the POS screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
HideWebStatus
Description
Hide the HTML status window near the top of the POS screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
HideMe
Description
Hide the HTML browser window in the POS transaction screen.
Parameters
None
Return Value
None
InitializeTransaction
Description
Reset the transaction and prompt for any startup properties including customer, salesrep, etc. These options are set in the Manager configuration.
Parameters
None
Return Value
True if the command was successful False if the command failed
Login
Description
Invoke the Login operation. It will not return until the login is successful.
Parameters
None
Return Value
True if the command was successful False if the command failed
Logout
Description
Logout of the current QSRules session.
Parameters
None
Return Value
True if the command was successful False if the command failed
MsgBox
Description
Display a Windows message box on the screen and return the results.
Parameters
Text A string to display Options A long value indicating the buttons and options to use in the message. Caption A string to display in the caption box.
Return Value
The return value of the message box
PerformAddItem
Description
Add an item to the POS screen and gather any required data (e.g. serial number, matrix info, error messages, etc.) Parameters
ItemID A long value that is the ID of the Item to add (0 if not specified) ItemLookupCode A string that is the Item Lookup Code of the item to add Quantity A double value that is the quantity to add OverridePrice A boolean value indicating whether to override the item's price Price A currency value that is the price of the item OverrideDesc A boolean value indicating whether to override the item's description Description A string to override the description of the new item
Return Value
True if the command was successful False if the command failed
PerformRecall
Description
Display the recall menu (F11)
Parameters
None
Return Value
True if the command was successful False if the command failed
PerformTransactionCalculate
Description
Display the calculator (F3 button)
Parameters
None
Return Value
True if the command was successful False if the command failed
PerformTransactionLookup
Description
Display the lookup screen (F2). Note that this is column-dependent.
Parameters
None
Return Value
True if the command was successful False if the command failed
PostDrawerFunction
Description
Invoke the drawer menu and post the transaction.
Parameters
None
Return Value
True if the command was successful False if the command failed
PostDrop
Description
Post a Drop transaction
Parameters
None
Return Value
True if the command was successful False if the command failed
PostNoSale
Description
Post a No Sale transaction
Parameters
None
Return Value
True if the command was successful False if the command failed
PostOpenClose
Description
Display the Open / Close menu and post the transaction.
Parameters
None
Return Value
True if the command was successful False if the command failed
PostPayment
Description
Display the customer payment screen and post the transaction.
Parameters
None
Return Value
True if the command was successful False if the command failed
PostPayout
Description
Display the pay out screen and post the transaction.
Parameters
None
Return Value
True if the command was successful False if the command failed
PostTransaction
Description
Post the current transaction. It will display the posting status screen.
Parameters
Initialize Boolean: True to initialize the transaction after posting.
Return Value
True if the command was successful False if the command failed
PostTransactionUnattended
Description
Post the transaction screen. It will not display the posting status screen.
Parameters
Initialize Boolean: True to initialize the transaction after posting.
Return Value
True if the command was successful False if the command failed
PrintLastReceipt
Description
Print the last receipt
Parameters
None
Return Value
True if the command was successful False if the command failed
PrintXReport
Description
Print and post the X Report
Parameters
None
Return Value
True if the command was successful False if the command failed
PrintZReport
Description
Print and post the Z report.
Parameters
None
Return Value
True if the command was successful False if the command failed
PrintZZReport
Description
Print and post the ZZ report
Parameters
None
Return Value
True if the command was successful False if the command failed
Quit
Description
Invoke the process to close the POS.
Parameters
None
Return Value
True if the command was successful False if the command failed
RecallBackOrder
Description
Display the recall backorder screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
RecallHold
Description
Display the Recall Hold transaction screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
RecallLayaway
Description
Display the recall Layaway screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
RecallQuote
Description
Display the recall Quote screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
RecallWorkOrder
Description
Display the recall Work Order screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
RefreshDisplay
Description
Refresh the POS Display. This is used when an item has been directly added to the current QSRules transaction.
Parameters
None
Return Value
True if the command was successful False if the command failed
Secure
Description
Display the Cashier login screen. This locks the register until a valid cashier has logged in.
Parameters
None
Return Value
True if the command was successful False if the command failed
SelectBackOrder
Description
Displays a list of the open Back Orders and returns the ID of the selected order.
Parameters
None
Return Value
A long value that is the ID number of the selected order. A value of zero (0) is returned if the cashier has canceled the operation.
SelectCustomer
Description
Displays a list of the customers and returns the ID of the selected customer.
Parameters
None
Return Value
A long value that is the ID number of the selected customer. A value of zero (0) is returned if the cashier has canceled the operation.
SelectHoldTransaction
Description
Displays a list of the transactions on hold and returns the ID of the selected order.
Parameters
None
Return Value
A long value that is the ID number of the selected transaction. A value of zero (0) is returned if the cashier has canceled the operation.
SelectItem
Description
Displays a list of the items and returns the ID of the selected item.
Parameters
None
Return Value
A long value that is the ID number of the selected item. A value of zero (0) is returned if the cashier has canceled the operation.
SelectLayaway
Description
Displays a list of the open Layaways and returns the ID of the selected order.
Parameters
None
Return Value
A long value that is the ID number of the selected order. A value of zero (0) is returned if the cashier has canceled the operation.
SelectProcess
Description
Displays a list of the open processes (external programs launched from QuickSell POS) and returns the ID of the selected process.
Parameters
None
Return Value
A long value that is the ID number of the selected process. A value of zero (0) is returned if the cashier has canceled the operation.
SelectQuote
Description
Displays a list of the open Quotes and returns the ID of the selected order.
Parameters
None
Return Value
A long value that is the ID number of the selected order. A value of zero (0) is returned if the cashier has canceled the operation.
SelectSalesRep
Description
Displays a list of the open Sales Reps and returns the ID of the selected rep.
Parameters
None
Return Value
A long value that is the ID number of the selected rep. A value of zero (0) is returned if the cashier has canceled the operation.
SelectShippingEdit
Description
Displays a list of pending shipping records and returns the ID of the selected shipping record.
Parameters
None
Return Value
A long value that is the ID number of the selected record. A value of zero (0) is returned if the cashier has canceled the operation.
SelectSubstituteItem
Description
Displays a list of the substitute items for a given item and returns the ID of the selected substitute item.
Parameters
ID A long value that is the ID of the given item.
Return Value
A long value that is the ID number of the selected substitute item. A value of zero (0) is returned if the cashier has canceled the operation.
SelectTransaction
Description
Displays a list of the transactions and returns the ID of the selected transaction.
Parameters
None
Return Value
A long value that is the ID number of the selected transaction. A value of zero (0) is returned if the cashier has canceled the operation.
SelectWorkorder
Description
Displays a list of the open Work Orders and returns the ID of the selected order.
Parameters
None
Return Value
A long value that is the ID number of the selected order. A value of zero (0) is returned if the cashier has canceled the operation.
SetSubstituteItem
Description
Replaces the current transaction item (the item that is currently highlighted on the transaction POS screen).
Parameters
ID A long value that is the ID of the new item.
Return Value
True if the command was successful False if the command failed
SetCustomer
Description
Sets the transaction customer to the given customer.
Parameters
ID A long value that is the ID number of the customer to be used.
Return Value
True if the command was successful False if the command failed
SetStatus
Description
Sets the text to be displayed in the status window in the lower left corner of the POS screen.
Parameters
Text A string to be displayed.
Return Value
True if the command was successful False if the command failed
SetTransactionSalesRep
Description
Sets the sales rep for the entire transaction.
Parameters
ID A long value that is the ID number of the Sales Rep to be used.
Return Value
True if the command was successful False if the command failed
ShowAbout
Description
Displays the About screen for the POS.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowAutoGenerate
Description
Displays the Auto-Generate Sales window. Note that this is the only way to invoke this hidden feature.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowCalendar
Description
Displays the Calendar window.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowCalendarEventReminder
Description
Displays the calendar event reminder window.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowClosingAmounts
Description
Displays the closing amounts window and allows the cashier to enter the closing amounts.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowCustom
Description
Displays the custom POS buttons on the right side of the POS screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowDiscount
Description
Displays the transaction discount screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowDisplayProperties
Description
Displays the POS Display Properties screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowFunction
Description
Displays the POS Function keys at the bottom of the screen
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowGasPumpDesposits
Description
Displays the Gas Pump deposits screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowGraphs
Description
Displays the sales graphs screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowHTML
Description
Displays the HTML window in place of the transaction grid
Parameters
URL A string value that is the URL to be loaded into the browser.
Return Value
True if the command was successful False if the command failed
ShowItemComment
Description
Displays the Item comment screen for the current item.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowJournalViewer
Description
Displays the receipt viewer screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowMessages
Description
Displays the cashier messages screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowNewMessage
Description
Displays a new message the cashier may have received.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowOpeningAmounts
Description
Displays the open amounts screen and allows the cashier to enter opening amounts.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowPickupOrder
Description
Invokes the pickup partial order process.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowPickupEntireOrder
Description
Invokes the pickup entire order process.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowSalesTaxSelector
Description
Displays the sales tax selector screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowSerialNumber
Description
Displays the serial number screen for the current item.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowStatus
Description
Displays the status bar at the POS screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowTimeClock
Description
Displays the time clock screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowTransaction
Description
Displays the transaction grid in place of the HTML browser.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowTotals
Description
Displays the Totals bar at the bottom of the POS screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowWebStatus
Description
Displays the Web status window at the top of the POS screen.
Parameters
None
Return Value
True if the command was successful False if the command failed
Tender
Description
Tenders (and posts) the current transaction.
Parameters
None
Return Value
True if the command was successful False if the command failed
ToggleReceiptPrintersOn
Description
Toggles the receipt printers on or off.
Parameters
None
Return Value
True if the command was successful False if the command failed
ToggleReturnMode
Description
Toggles the return mode of the POS.
Parameters
None
Return Value
True if the command was successful False if the command failed
ToggleTaxableItem
Description
Toggles the Taxable column of the current item
Parameters
None
Return Value
True if the command was successful False if the command failed
ToggleTaxableTransaction
Description
Toggles the taxable status of the entire transaction.
Parameters
None
Return Value
True if the command was successful False if the command failed
ShowMenu
Description
Displays a menu selection and returns the choice made by the cashier.
Parameters
Key1 A string that is the key of the menu option Caption1 A string that is the caption of the menu option Key2 A string that is the key of the menu option Caption2 A string that is the caption of the menu option : : Key-n A string that is the key of the menu option Caption-n A string that is the caption of the menu option
Return Value
A string that is the key of the selected option or empty string if the operation is cancelled.
------------------------------------------------------------- OTHER COMMANDS
-------------------------------------------------------------
Format
Description
Invoke the VB Format function and return the result as a string
Parameters
Value A variant value to be formatted Format A string that is the VB-format string to use in formatting value.
Return Value
A string that is the formatted value.
CurrencyToString
Description
Converts a currency value to a formatted string and returns the formatted string
Parameters
Value A currency value to be converted
Return Value
A string that is the formatted currency value.
DoubleToString
Description
Converts a double value to a formatted string and returns the formatted string
Parameters
Value A double value to be converted
Return Value
A string that is the formatted double value.
DateToString
Description
Converts a date value to a formatted string and returns the formatted string
Parameters
Value A date value to be converted
Return Value
A string that is the formatted date value.
TimeToString
Description
Converts a time value to a formatted string and returns the formatted string
Parameters
Value A time value to be converted
Return Value
A string that is the formatted time value.
DateTimeToString
Description
Converts a date and time value to a formatted string and returns the formatted string
Parameters
Value A date and time value to be converted
Return Value
A string that is the formatted date and time value.
SetGridDefaultsList
Description
Sets the given grid to the look and feel used by the lists in the POS and Manager program
Parameters
Grid A QSControls2.SuperGrid object.
Return Value
True if the command was successful False if the command failed
SetGridDefaultsEdit
Description
Sets the given grid to the look and feel used by the editable grids in the POS and Manager program
Parameters
Grid A QSControls2.SuperGrid object.
Return Value
True if the command was successful False if the command failed