TabPanel Functions
Functions for working with Panels Tabs.
| TabActivePanelSide | Get an array of all currently selected files in the source panel. |
| TabActiveTab | Get an array with full paths of all currently selected files in the source panel. |
| TabCount | Get an array with the names of selected items in the source panel. |
| TabGetPath | Get an array with the names of selected items in the target panel. |
| TabClose | Get an array with the full paths of the selected items in the source panel. |
| TabLoadTabSession | Get an array with the full paths of the selected items in the target panel. |
TabActivePanelSide
Get or Set what panel side in active
<int> TabActivePanelSide(); <int> TabActivePanelSide( <int> panel ); <int> TabActivePanelSide( <string> panel );
When specifying tab any of the following values are valid
1 = Left, 2 = Right , "right", "left", "top", "bottom", "target", "source" , "active" "inactive"
Return value
If no parameter is specified then it return 1 or 2 for left or right panel. else it return 1 for success or 0 for failure to set active panel
Example
@var $panel= TabActivePanelSide();
TabActivePanelSide(1);
TabActivePanelSide(2);
TabActivePanelSide("left");
TabActivePanelSide("top");
TabActiveTab
Get or Set what tab in a panel is active
<int> TabActiveTab( <int> panel ); <int> TabActiveTab( <string> panel ); <int> TabActiveTab( <string> panel , <int> tabIndex ); <int> TabActiveTab( <int> panel , <int> tabIndex );
When specifying tab any of the following values are valid
1 = Left, 2 = Right , "right", "left", "top", "bottom", "target", "source" , "active" "inactive"
Return value
Return the tab index of the active tab in the specified tab panel. (first tab is 0, second 1, and so on)
If the SET alternatives are used it return 1 for success or 0 for failure to set active tab
Example
@var $activeTabInPanel= TabActiveTab(1);
@var $activeTabInPanel= TabActiveTab("active");
@var $activeTabInPanel= TabActiveTab("source");
TabActiveTab(1, 0);
TabActiveTab(1, 3);
TabActiveTab("left", 3);
TabActiveTab("source", 2);
TabActiveTab("target", 2);
TabActiveTab("bottom", 2);
TabCount
Return how many tabs a panel side has
<int> TabCount( <int> panel ); <int> TabCount( <string> panel );
When specifying tab any of the following values are valid
1 = Left, 2 = Right , "right", "left", "top", "bottom", "target", "source" , "active" "inactive"
Return value
Return the number of tabs that exists in a panel side
Example
@var $numTabs = TabCount(1);
@var $numTabs = TabCount("active");
@var $numTabs = TabCount("source");
TabGetPath
Return the path of a tab. If the view inside that tab support that.
<int> TabGetPath( <int> panel , <int> tabIndex); <int> TabGetPath( <string> panel , <int> tabIndex);
When specifying tab any of the following values are valid
1 = Left, 2 = Right , "right", "left", "top", "bottom", "target", "source" , "active" "inactive"
Return value
Return the path for the path in the specified panel. If the view in that tab does not support the concept of a 'tabpath' empty path is returned (Eg Checksum view)
Example
@var $path = TabGetPath(1, 2);
@var $path = TabGetPath("active", 3);
@var $path = TabGetPath("source", 3);
TabClose
Close a specified tab
<int> TabClose( <int> panel , <int> tabIndex); <int> TabClose( <string> panel , <int> tabIndex);
When specifying tab any of the following values are valid
1 = Left, 2 = Right , "right", "left", "top", "bottom", "target", "source" , "active" "inactive"
Return value
Return 1 for success or 0 for failure
Example
TabClose(1, 2);
TabClose("active", 3);
TabClose("source", 3);