Events that are raised and can be handled by VB.Net script.
Events that are raised and can be handled by VB.Net script.
Browser_BeforeNavigate | Before a browser tab navigates, can be cancelled by returning True
Web DOMView
e RequestArgs Request Arguments
Boolean True to cancel the navigation
|
Browser_ContentLoaded | After main document content is loaded, resources may still be loading
sender DOMView
|
Browser_DocumentComplete | After main document content has fully loaded
Sender DOMView
|
Browser_DocumentLoading | Main document content has started loading
Web DOMView
|
Browser_DocumentUpdated | After main document content has changed
sender DOMView
|
Carrier_AddAccount | Account list for selected carrier
Name String Carrier name
String()
|
Carrier_AddCarrier | Additional carrier names
Amazon Boolean Only return carriers accepted by Amazon
String()
|
Carrier_AddClass | Class list for selected carrier
Name String Carrier name
String()
|
Carrier_AddCode | Code list for selected carrier
Name String Carrier name
String()
|
Carrier_AddExport | List of custom carrier names
String()
|
Carrier_AddFormat | Format list for selected carrier
Name String Carrier name
String()
|
Carrier_AddLabels | Label list for selected carrier
Name String Carrier name
String()
|
Carrier_AddMethod | Method list for selected carrier
Name String Carrier name
String()
|
Carrier_AddService | Service list for selected carrier
Name String Carrier name
String()
|
Carrier_AfterConfirmLabel | After demand shipping label has been created and confirmed
Records RecordStruct() Records with labels that have been confirmed
|
Carrier_BeforeCreateDemand | Before a record is queued to create an on demand label, allows carrier details to be modified
Record RecordStruct Record that shipping label will be created for
|
Carrier_BeforeQueryDemand | Before create label confirm dialog is shown
Records RecordStruct() Records that will be shown in the confirm dialog
|
Carrier_CreateLabel | Create and return a label in scripting.
Record RecordStruct Record that needs the label created
RecordStruct Record with Carrier containing label details
|
Carrier_Export | Allow scripting to output carrier files
Export CarrierExportCls
|
Carrier_ExtractPDF | Extract and return a carrier label from a PDF.
PDF PDFWrapper PDF that contains the carrier labels
Index Int32 Page index of the label to extract
PDFExtractStruct Structure containg the extracted label detlails
|
Carrier_ImportTracking | Allow scripting to import tracking numbers in Mark Shipped
Track InsertTrackingCls Populated with tracking numbers and record identifiers
Boolean True if script has imported tracking numbers
|
Carrier_InitLabel | Initialise call for shipping labels created in script
IsSingle Boolean True if creating a single packing station label
|
Carrier_LabelMatched | After shipping label has been matched to a record
Record RecordStruct Record that has been matched
Image Image Label Image
|
Carrier_MatchRecord | Allows scripting to match a record to an imported PDF label
Record RecordStruct Record to be matched
Match String Match to find in record
|
Carrier_Saving | Before carrier data is exported to file
|
Carrier_TrackUrl | Allows scripting to return a tracking URL for a custom carrier
Carrier CarrierStruct
|
Collect_Complete | Before new records are added to archive or processed
All the details of the collect or transfer are passed into this method, allowing data to be retrieved or records altered.
Channel ChannelCls
|
Collect_Done | After new records have been processed and added to current
|
Collect_End | After new records have been processed but not added to current
Channel ChannelCls
|
Collect_MapItems | Call to allow item codes to be changed
Called after SKU, Code and location have ben mapped, allowing the fields to be changed in script
Item ItemStruct Item to be mapped
RecordStruct Item, even if it hasn't been modified
|
Collect_NewRecord | Before a new record is added to the archive, allows new records to be modified
Record RecordStruct New record that being added to the archive
|
Collect_PageCollected | After the record has been populated but not error checked
Allows access to the web page that been scraped, or make additional API calls for getting extra data.
Web CollecterCls Class used to do the collecting
Sub Collect_PageCollected(Web As CollecterCls) 'Get additional custom data from the sales record page Web.Record.CustomStr = Web.document.getElementById("additional_data").innerText End Sub
|
Collect_PrepareRecord | After formatting of the record, but before error checking
This call can be used to modify records after the contact details have been formatted, and the record has been given a GUID. RecordStruct must return the record, even if it hasn't been modified
|
Collect_RecordChecked | After record has been formatted and error checked
This call can be used to modify records after they have been formatted and error checked
RecordStruct must return the record, even if it hasn't been modified
|
Collect_RecordCollected | After record has been populated and error checked
Allows making changes to the record after it has been error checked.
Web CollecterCls Class used to do the collecting
Sub Collect_RecordCollected(Web As CollecterCls) 'Update record with additional data Web.Record.CustomStr = "My Extra Data" End Sub
|
Collect_Start | Before collecting from the browser begins
Collect CollectCls Contains records and details for collecting
Channel CVChannel Details of the channel being collected from
Boolean Return true to continue collecting, false to cancel
|
Dashboard_AmendJSON | Before JSON data is displayed on the dashboard, allows the JSON string to be modified
JSON String JSON String to be displayed
|
Dashboard_CreateJSON | Create Json data for use in dashboard HTML
|
Export_ReplaceItem | Before item is replaced in the CSV export
Map String Mapping used to create the export
Record ItemStruct Item that can be modified
ItemStruct Modified record
|
Export_ReplaceRecord | Before record is replaced in the CSV export
Map String Mapping used to create the export
Record RecordStruct Record that can be modified
RecordStruct Modified record
|
Express_DownloadComplete | After the download of records into express is complete.
All processing and error checking has been done, before this call. If this call is present, the records array must be returned, even if it hasn't been modified
Records RecordStruct[] All records currently in Express
RecordStruct[] must return the array, even if it hasn't been modified
|
Express_ImportActive | Import Express records from script is active
Boolean True if import records is active
|
Express_ImportComplete | After the import of records into express is complete.
All processing and error checking has been done, before this call. If this call is present, the records array must be returned, even if it hasn't been modified
Records RecordStruct[] All records currently in Express
RecordStruct[] must return the array, even if it hasn't been modified
|
Express_ImportName | Name to show on menu for import records
String Name (default is "Local Import")
|
Express_QueueDespatched | Before records are queued for despatching on the Express server
Records are submitted to the server as JSON, in maximum batches of 500
Records Records that are to be queued for despatching
|
Express_RecordExtracted | After a record is extracted from the JSON data from the Express Server
Allows records to be modified before being added to the Express tab records.
Record RecordStruct Record that has been extracted
|
Print_AfterPrint | Called after any printing action (not called for preview)
Records RecordStruct() Records that have been printed
PrintType PrintTypeEnum Type of print
|
Print_AmendPickingRow | Amend picking row after it has been populated
Item ItemStruct Item that populated the row
Row StringBuilder Row that has been populated
|
Print_AmendPostalRow | Amend the postal record row after it has been populated
Record RecordStruct Record that populated the row
Row StringBuilder Row that has been populated
|
Print_AppendPickingRow | Allows additional text to be appended to the picking list as a footer
|
Print_BeforeReplace | Before fields are replaced in the layout
Record RecordStruct Record being replaced
Fields StringBuilder HTML fields in the layout
|
Print_BeginPrint | Called before any printing action
Records RecordStruct() Records to be printed
PrintType PrintTypeEnum Type of print
|
Print_GroupPickingItem | Return true if the Item should be added to the GroupItem
GroupItem ItemStruct The item to check against
Item ItemStruct The item to add to the GroupItem
True is the item is to be added to the group
|
Print_ReplaceBarcode | Return true if script is replacing the barcode in the frame
Frame IHTMLElement Frame that contains the barcode
|
Print_ReplaceCell | Before a cell HTML content is replaced with record fields
Item ItemStruct Item that is being printed
Html StringBuilder Html text that is being replaced
|
Print_ReplaceFrame | Before a frame content is replaced with record fields
Record RecordStruct Record that is being printed
Frame IHTMLElement Frame element that is being filled
|
Print_ReplaceRule | Return text to be used to match a replaceable frame rule
Record RecordStruct Record that is being queued
|
Print_SortPickingRow | Allows the items in a picking list to be sorted
Item ItemStructItem to be sorted
|
Records_AddSortMenu | Customise sort menu entries in records tab
MenuItems List`1 default sort menu items
String()
|
Records_AddViewMenu | Add items to view filter menu
Dropdown ToolStripDropDown Dropdown menu to merge
Mode ViewModeEnum Viewmode now showing
|
Records_AfterMarkPrinted | After records are marked printed
Records RecordStruct() Records that have been marked printed
|
Records_AfterMarkShipped | After records have been marked shippedFilteredRecords Records RecordStruct[] Records that have been marked shipped
|
Records_AfterOrderItems | After items have been ordered in FilteredRecords Record RecordStruct Record whose items have been sorted
|
Records_AfterOrderRecords | After records have been ordered in FilteredRecords Records RecordStruct[] Records that have been ordered
|
Records_AfterShipping | After shipping rules are applied to each record
Record RecordStruct Record that has had shipping rules applied
RecordStruct Record, even if it hasn't been modified in script
|
Records_AmendRecord | Make changes to each record after calling RecorTab.AmendCurrentRecords() Records are amended and updated in the archive, but changes are not synced to other PCs.
Record RecordStruct Record whose details need changing
|
Records_AmendShipping | After shipping details have changed by rules or by user
Record RecordStruct Record whose shipping details have been changed
|
Records_BeforeMarkPrinted | Before records are marked printed
Records RecordStruct() Records will be marked printed
|
Records_BeforeMarkShipped | Before records are marked shipped
Records RecordStruct() Records will be marked shipped
|
Records_BeforeShipping | Before shipping rules are applied to each record
Record RecordStruct Record that will have shipping rules applied
|
Records_Filter | Return true if the named filter matches the record
Record RecordStruct Record that is being queued
Name String User defined filter name
|
Records_FilterView | Return true if the named filter matches the record
Record RecordStruct Record that is being queued
Name String User defined filter name
Mode ViewModeEnum active ViewMode
|
Records_ItemSort | Order for named item sort
Item ItemStruct Item that needs sorting
Name String Name to sort item by
Invert Boolean True if the sort is inverted
|
Records_LookupFound | After lookup item has been found, allows item details to be modified
Lookup LookupStruct Lookup item that was found
Item ItemStruct Item that mactched the lookup item
|
Records_ProductImage | Product image from script, e.g when source url is not public
Src String Source url for the image resource
|
Records_RecordSort | Order for named record sort
Record RecordStruct Record that needs sorting
Name String Name of custom sort, defined in Records_AddSortMenu
Invert Boolean True if the sort is inverted
|
Records_RowCreated | Each table row that is created for the current view
Row IHTMLTableRow HTML Row element that can be modified
Record RecordStruct Record that the row was created from
|
Records_ShipExtra | Modify ship extra fields from script
Records RecordStruct() Records that have been marked printed
Outcode String() Outcode part of postcode e.g BS1
Extra String() Extra codes that have alrerady been added
String the modified ShipExtra field
|
Records_ShipRule | Return text to be used to match a shipping rule
Record RecordStruct Record to be evaluated
|
Reports_AddReports | Items to add to report drop down on reports toolbar
String()
|
Script_Load | When the script is first loaded at program launch
Any one time initialising code should be in here, e.g. copying or deleting files |
Script_Start | Every time script is started
Any initialising code should be in here, e.g. adding menu items and event handlers |
Script_Stop | Every time script is stopped
Any finalising code should be in here, e.g. removing menu items and event handlers |
Update_QueueRecord | Before despatch details are added to a channel update queue
Record RecordStruct Record that is being queued
RecordStruct. The record must be returned, even if not ameneded
|
Update_Start | Before channel despatching starts
All the details for despatching are passed into this method, allowing update details to be altered
Despatch DespatchCls
Boolean True if the despatching can continue
|