Microsoft Excel report generator editor

From RadiWiki
Revision as of 14:43, 29 October 2010 by Joro (talk | contribs) (→‎Overview)
Jump to navigation Jump to search

Overview

Microsoft Excel is one of the supported editors that can be used by report generator of RadiMation.

All the codes that are allowed by the report generator can also be included in a Microsoft Excel sheet. Some things that are possible:

  • Report generator codes can be include alone on it's own in a single cell
  • Report generator codes can be combined with other text in a cell
  • Multiple report generator codes (and also text) can be combined in a cell
  • (Multiple) Report generator codes can be included in a note attached to a cell
  • Multiple worksheets are allowed, all worksheets will be checked for report generator codes
  • Report generator codes can be used as part of a formula of a cell. But it maybe necessary to convert the contents from a text to numerical value. The simplest form of a formula is: "=VALUE("||START FREQUENCY||")".
  • Report generator codes that include texts into the final report are allowed.
  • Report generator codes that include tables into the final report are allowed.
  • Report generator codes that include pictures into the final report are allowed.

The Microsoft Excel report generator editor was already present in earlier version of RadiMation but most described functionality is included in RadiMation version 5.3 and newer

Tables

The report generator has several modes to include a table into the final report, if the Microsoft Excel report generator editor is used.

Row insert mode

This is the default mode that is used by the report generator.

If a report generator code is detected that will result in the inclusion of a table of for example 10 rows, then 9 (= 10 - 1) rows will be inserted below the row in which the report generator code is detected. Then the table will be inserted at the cell where the code is detected, overwriting the cells that are right and below the starting cell.

Because additional rows are inserted before the table is included, other codes directly below the report generator code for table will be shifted down.

This mode can be activated by including the following report generator code: "||RunMacro(CELL_PASTE_MODE_ROWS)||"

Overwrite mode

If a report generator code is detected that will result in the inclusion of a table of for example 10 rows, then the table will be inserted at the cell where the code is detected, overwriting the cells that are right and below the starting cell. This could result in overwriting the content of other cells if the inserted table is bigger than expected.

This mode can be activated by including the following report generator code: "||RunMacro(CELL_PASTE_MODE_OVERWRITE)||"

Cell insert mode

If a report generator code is detected that will result in the inclusion of a table of for example 10 rows and 5 columns, then a block of 9 (= 10 - 1) rows and 5 columns will be inserted below the row in which the report generator code is detected. Then the table will be inserted at the cell where the code is detected, overwriting the cells that are right and below the starting cell.

Because additional cells are inserted before the table is included, other codes directly below the report generator code for table will be shifted down. The difference between the 'Cell insert mode' and the 'Row insert mode', is that any content that is already included in the cells aside the inserted tables will still be present after the table is included. This can be useful if calculations should be performed on the data that is present in the inserted table.

This mode can be activated by including the following report generator code: "||RunMacro(CELL_PASTE_MODE_CELLS)||"

Sheet insert mode

If a report generator code is detected that will result in the inclusion of a table, then a new worksheet will be created after active worksheet. On the newly created worksheet, the table will be inserted at the 'A1' cell, overwriting the cells that are right and below of 'A1' cell.

This mode can be activated by including the following report generator code: "||RunMacro(CELL_PASTE_MODE_SHEET)||"

Inclusion of other files

When the test specific report generator templates or the '||InsertFile(<OTHER EXCEL WORKBOOK>)||' code is used data from another excel workbook or worksheet will be included. The size of the to be inserted data is determined, starting at the 'A1' cell until the last filled cell. This data is then inserted at the location of the keyword, using the mode that is selected as described by the the table-inclusion method.

After another file is included, a check is done to remove all completely empty worksheets, to prevent that a lot of worksheets will be included.

The filename of a Bitmap or JPEG file can also be specified as part of the '||InsertFile(<PICTURE FILENAME>)||' report generator code. The corresponding picture will then be included in the cell in which the code is specified. This function is similar to the 'Insert Picture, From File' action of Microsoft Excel.

Macros

With the report generator code "||RunMacro(<MACRO NAME>)||" it is possible to start a predefined macro function. The '<MACRO NAME>' may be:

  • a macro defined by Microsoft Excel
  • the name of a public function in a public macro module
  • a macro name predefined by the Microsoft excel report generator editor

It is not possible to call macro functions that require an argument, so only argument-less macro functions can be called.

The list of macro functions that are implemented by the Microsoft Excel report generator editor are:

  • CELL_PASTE_MODE_CELLS
  • CELL_PASTE_MODE_SHEET
  • CELL_PASTE_MODE_OVERWRITE
  • CELL_PASTE_MODE_ROWS
Information.png
This functionality is available in RadiMation® version 5.3 and newer.