Tab Object

From SecureCRT

A data path or circuit between two computers over a phone line, network cable, or other means.

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.


Description

The Tab object provides access to the tab functions that exist for the current connection or session.

Syntax

objTab.Property [ = expression ]

objTab.Method([arglist])

Tab Object Properties and Methods

Properties

Methods

    Caption

    Activate

    Index

    Clone

    Screen

    Close

    Session

    ConnectSftp

Properties

Caption

Description

Returns or sets the caption of the specified tab object.

Syntax

[ varname = ] tab.Caption

tab.Caption = newCaption

Remarks

Setting this property sets the caption of the tab and sets the caption of the window, if the tab is visible to the user.

Index

Description

Returns the index for the tab object referenced by object.

Syntax

object.Index

Remarks

None.

Screen

Description

Returns a reference to the Screen object associated with the tab object.

Syntax

Set object = tab.Screen

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.

 

Session

Description

Returns a reference to the Session object associated with the tab object..

Syntax

Set object = tab.Session

Remarks

See the Session object documentation for a description of its properties and methods.

Methods

Activate

Description

Brings the tab referenced by object to the foreground.

Syntax

object.Activate

Remarks

A tab can receive and send text whether active or not. This method simulates a user clicking on a tab to activate.

Clone

Description

Returns a reference to a tab object cloned from the specified object tab reference.

Syntax

Set cloneTab = object.Clone

Remarks

Cloned tabs benefit from their parent tab already having been authenticated to the server. Therefore, cloned tabs require no additional authentication.

Close

Description

Closes the tab referenced by object.

Syntax

object.Close

Remarks

Any active connection associated with the tab referenced by object is terminated when the tab is closed. The tab running the script cannot be closed.

ConnectSftp

Description

Creates an SFTP tab based on this tab.

Syntax

Set sftpTab = object.ConnectSftp

Remarks

SFTP tabs benefit from their parent tab already having been authenticated to the server. Therefore, SFTP tabs require no additional authentication.