If a script add-in implements the OnBeforeFolderChange event, the method receives a BeforeFolderChangeData object before the new folder is read.
Property Name |
Return Type |
Description |
---|---|---|
action |
string |
Returns a string indicating the action that triggered the folder read.
The string will be one of the following: normal,
refresh, refreshsub, parent, root,
back, forward, dblclk. The refreshsub actions means the folder (and sub-folders) are being refreshed while Flat View is on. The other action names should be self-explanatory. |
initial |
bool |
Returns True if this is the first path to be read into this tab (i.e. previously the tab was empty). |
path |
object:Path |
Returns a Path object representing the new path that is to be read. |
qualifiers |
string |
Returns a string indicating any qualifier keys that were held down by the user when the event was triggered. The string can contain any or all of the following: shift ctrl, alt, lwin, rwin If no qualifiers were down, the string will be: none |
tab |
object:Tab |
Returns a Tab object representing the tab that is changing folder. |