Skip to main content

GetTab

Description

Gets the tab with the specified tab id.

Syntax

// shellPaneContainer points to instance of IShellPaneContainer
const result = await shellPaneContainer.GetTab(tabId);

Parameters

NameOptionalityTypeDescription
tabIdRequiredstringThe id of the tab to get. Can refer to built-in tab or another custom-created tab.
See Using Tabs in Shell Frame Side Pane Tabs for a list of built-in tab identifiers.

Return type

TypeDescription
Promise < IShellPaneTab >Returns the tab with the specified tab id.

Exceptions

ArgumentError - When tabId is null or undefined.

NotFoundError - When a tab with the specified tabId is not found.