Folder

«Folder»  – is a forms component that has several purposes.

First of all, it has to be used to organize and arrange the form structure by including other components (that have same category or purpose etc.) to the folder.

Secondly, folder disseminates common properties for all subsequent components included in it. This will be discussed further.


Properties tab: 



Item «Binding with context»

The item is for binding the folder with any component of context. As a result, for all sub components (included in the folder), the search-help of context components will only display a subtree of the chosen context node:


 

Item «Appearance at runtime»


By default, all sub-components of the «Folder» are always appearing in the Printing form at runtime. But it is possible to dynamically define a of the «Folder» subtree in the Printing form.

The item is for associating the component appearance (in Printing form at runtime) with value of any context field (the «Folder» subtree will be output in the Printing form only if the specified context field is not initial).
You have to press a button and then in the popup search-help You have to choose required context field (so-called Appearance indicator):





If an Appearance indicator has character data type, You are able to set for analyzing just a part of string (substring) instead of entire string. To do that You have to press a button , and then on a popup window specify a start position and number of characters that should be analized:


 


Item «Output direction at runtime»

The item defines a place of the folder (its sub components) relative to previous component in runtime (at resultant XLSX-file creation). To change an output direction You have to press a button  or  .

Border of the folder is defined by borders of all nested «Patterns» (Ie, folder's Border are covering the all «Patterns» are included in folder):


By default, the output direction  is predefined – it means that the folder (nested subcomponents) will be placed BELOW the previous component in runtime (at resultant XLSX-file creation)The upper-left corner of the border of the current folder (marked by green color) will be placed beside to the lower-left corner of the previous component (marked by yellow color): 


If the output direction  is predefined – it means that the folder (nested subcomponents) will be placed TO RIGHT OF the previous component in runtime (at resultant XLSX-file creation)The upper-left corner of the border of the current folder (marked by green color) will be placed beside to the right-upper corner of the previous component (marked by yellow color): 


If the previous components are enclosed in a folder, then the above principles are applied to the borders of the previous folder.

Example 1: Current folder (marked by green color) is placed below the previous folder (marked by blue color).


Example 2: Current folder (marked by green color) is placed to right of the previous folder (marked by blue color).



 

Item «Name of Cell range»

The option allows You to assign name to cell range, which will be covered by the Folder. Here You can specify context field, which will contain name for the cell range. The process is same with item «Appearance at runtime» .


 

Item «Group»

The option allows You to make collapsible columns/rows  Ie outline (group) columns/rows inside the borders of the folder.

Thus, You able to create a collapsible hierarchy on the worksheet via multilevel nested folders (in the form structure) with the switched on «Group» option:


·         In the example, to group rows of months January/February/March, You have to place a corresponding «Pattern» (or several «Patterns») into a folder and switch-on the option «Group rows»:

      


·         If You want to place a summary rows higher than datail rows, You have to follow to Excel menu: Data > Outline and uncheck a corresponding checkbox in the popup-window:

      

      Moreover it will be different sequence of «Patterns» in the form structure:

      


·         An option  /  defines if the grouped rows will be in expanded or collapsed state in the resultant XLSX-file.


Note 1: This option runs OLE/VBScript post-processing procedure to forcibly move the automatic page breaks beyond specified area.


Note 2: I strongly recommend you to use post-processing only when it is really needed, because it has a few negative factors:
  • It won't be performed in background mode of printing program run 
  • It won't be performing if MS Excel application is not installed on frontend computer
  • It reduce performance 


Item «Insert manual page break (at the beginning)»

The option allows You to insert manual Pagebreak (vertical or/and horizontal) directly at the begining of the «Folder» content.


 

Item «Preventing automatic page breaks (inside)»

The option allows You to protect the area inside the folder against automatic page breaks (both vertical and horizontal). For example, it is usually required to make signature section unbreakable.


NoteUnfortunately, is only possible to control an AUTOMATIC pagebreaks while the Excel application is running. Therefore, the protection of a page break perform via OLE. If a resultant XLSX-file is creating in off-line (background) mode, the option will not work.


Preventing of the horizontal page break.

·         If the option  is switched on, it means following. If in runtime (at resultant XLSX-file creation), the horizontal automatic pagebreak occurs inside an area (concluded with the folder), this pagebreak will be moved to the upper border of the area (folder):

Possible applications of this option is implementation of requirement to make unbreakable signatures section on the last page of the print form.


·         If on popup-window You define any number – for example 2 rows – it means the pagebreak will be raised by two rows higher than the top border of the area (folder):

      


Possible applications of this option is implementation of requirement to display a signature section on a same page with last row of the tabular section:



Preventing of the vertical page break.

If the option is switched on, it means following. If in runtime (at resultant XLSX-file creation), the vertical automatic pagebreak occurs inside an area (concluded with the folder), this pagebreak will be moved to the left border of the area (folder).

The rest of this option is similar to an option to prevent the horizontal pagebreak.


 


Item «Draft»

If the checkbox is checked on, it means that all the components in this folder will not be involved in the creation of the resultant XLSX-file.
This option could be useful, for example, if the developer, for any reason, does not want to completely delete a component or subtree of components from the tree of the form structure. Instead of deleting, he can place the subtree to the folder with the checked-on option "Draft"  and, as a result, these components will not processed while resultant XLSX-file creating.