Added February 2018

LoadOptions=<option>

These two options are similar in concept to the like-named ExportOptions except that they apply to the operation of loading data into the tree. Typically the column is defined as a one character number, but could also be a checkbox.

The intended usage would be for a situation where you are repeatedly displaying items from a large array, but with varying filtering such that each iteration of the display may show different items from the set. Rather than have to maintain two separate arrays (one with all of the items and one with just those to display), you can just add a column to the array to indicate (with 0 or 1) whether to display the item.

Notes

•   Only supported with Array Mode, not file or CSV mode.

•   Only applies to opcodes XTROP_CREATE and XTROP_REPLACE.

•   Purely a client-side feature; no special support or version requirements   on the server side.

•   Removing items from a tree, by resetting the value of the LoadOptions column and then doing an XTROP_REPLACE, is similar to using XTROP_DELSEL, but the LoadOptions approach is somewhat more flexible (particularly in its reversibility), and probably easier to use.

•   In the ATE environment, using the LoadOptions technique to add or remove a small number of rows is particularly efficient due to optimization of the XTROP_REPLACE operation when only a few rows are changed.

•   See the sample program TSTXFLTR2.BP in EXLIB:[908,76] for an example.

History

2018 Feburary, A-Shell 6.5.1627:  Function added to A-Shell