Tab Object
Description
The Tab object provides access to the tab functions that exist for the current connection A data path or circuit between two computers over a phone line, network cable, or other means. or session A session is a set of options that are assigned to a connection to a remote machine. These settings and options are saved under a session name and allow the user to have different preferences for different hosts.. The Tab object can also be used to work with tiled session windows.
Syntax
Tab Object Properties and Methods
Description
Returns or sets the caption of the specified tab object.
Remarks
Setting this property sets the caption of the tab or tiled session window and sets the caption of the main application window if the tab or tiled session window is active.
VBScript
Syntax
[ varname = ] tab.Caption
tab.Caption = newCaption
Python
Syntax
[ varname = ] tab.Caption
tab.Caption = newCaption
Description
Returns the index for the tab object referenced by object.
Remarks
When sessions are tabbed, the index for each tab object matches its position in the tab bar. When sessions are tiled, the indexes of the tab objects may not match the indexes when tabbed, but will remain consistent while the sessions are tiled.
VBScript
Syntax
object.Index
Python
Syntax
object.Index
Description
Returns a reference to the Screen object associated with the tab object.
Remarks
Object variables assigned from the screen property require the "Set" syntax. See the Screen object documentation for a description of its properties and methods.
VBScript
Syntax
Set object = tab.Screen
Python
Syntax
object = tab.Screen
Description
Returns a reference to the Session object associated with the tab object..
Remarks
See the Session object documentation for a description of its properties and methods.
VBScript
Syntax
Set object = tab.Session
Python
Syntax
object = tab.Session
Description
Brings the tab or tiled session window referenced by object to the foreground.
Remarks
A tab can receive and send text whether active or not. This method simulates a user clicking on a tab or tiled session window to activate.
VBScript
Syntax
object.Activate
Python
Syntax
object.Activate()
Description
Returns a reference to a tab object cloned from the specified object tab reference.
Remarks
Cloned sessions benefit from their parent session already having been authenticated to the server. Therefore, cloned sessions require no additional authentication.
VBScript
Syntax
Set cloneTab = object.Clone
Python
Syntax
cloneTab = object.Clone()
Description
Closes the tab or tiled session window referenced by object.
Remarks
Any active connection associated with the tab (or tiled session window) referenced by object is terminated when the tab (or tiled session window) is closed. The tab or tiled session window running the script cannot be closed.
VBScript
Syntax
object.Close
Python
Syntax
object.Close()
Description
Creates an SFTP tab based on this tab. When in tiled mode, creates an SFTP session window based on this tiled session.
Remarks
SFTP sessions benefit from their parent session already having been authenticated to the server. Therefore, SFTP sessions require no additional authentication.
VBScript
Syntax
Set sftpTab = object.ConnectSftp
Python
Syntax
sftpTab = object.ConnectSftp()