Excel Drop

Owned by Charles Evans
Jul 03, 2020
2 min read

The control is FAB specific to allow drag and drop of excel files and set the data to a table control

Properties of Excel Drop

  1. Id - unique identifier of the control
  2. Title - Text displayed in the control before an excel file has been dropped. The default text is "Drop a spreadsheet file here".
  3. Button Text - When Button Visible is set to true, this property sets the text for the Browse button.
  4. Button Visible - Boolean value determining whether the button to browse the local file system is visible.
  5. From Sheet - this is the Excel Worksheet name where the control will look for the data.
    1. Take note that the Excel Worksheet should have the first row as a heading/column names and these should exactly correspond to the Bound Field names of the Table cells.
    2. If you need to import data from more than one sheet from the Excel Worksheet file, list the sheets you would like to use and separate them with a semicolon.
  6. To Table Bound Field - The Table Control Bound Field where the data will be assigned.
    1. If you are importing data from multiple sheets (see above), each sheet should be bound to the bound field of a table. List the table fields separated by a semicolon.
         
      Sheet1 → header
      Sheet2 → items
  7. OnDrop - optional Javascript Function that will be called on the event of dropping an Excel File into the control. The way the OnDrop is designed(currently), is that it over-rides the standard method allowing (an expert) to parse and set the data.  This would require one to do all the data conversion to load the data into the front-end.
    1. Function format: theFunctionName(oContents)
    2. oContents will contain an array with the sheets from the Excel spreadsheet file (oContents.Sheet1, oContents.Sheet2, etc)
  8. Width - set the width of the control (e.g 50px)
  9. Height - set the height of the control (e.g 100px).
  10. Visible - set a boolean value or a variable with type boolean from the Model to control the visibility property
  11. AfterDrop - optional Javascript Function that will be called after the event of dropping an Excel File into the control. This can be used to validate the data after its entered via excel.
    1. Function format: theFunctionName(oContents)
    2. oContents will contain an array with the sheets from the Excel spreadsheet file (oContents.Sheet1, oContents.Sheet2, etc)


Step-by-step guide

How to add an Excel File Drop:

  1. Right-click on a Page, Form Element or from any elements under Add Layout and select Add Excel Drop

  2. An Excel Drop control has been added
  3. Maintain the Properties of the Excel Drop according to your requirements.