IShellPaneTab

Tabs can be accessed using IShellPaneContainer methods like AddTab or GetTab. Usually Tab is used to open a Dashboard

Properties

Name	Type	Description
Events	IEvents
IsBuiltIn	boolean
Selected	boolean
TabId	string
Title	string
Visible	boolean

Methods

Name	Description
Remove	Removes the tab.
Select	Requests the tab to be selected.
SetVisible	Set the tab visibility
ShowDashboard	Shows the specified dashboard in the tab.
ShowEmptyContent	Clears the tab content area.
Unselect	Requests the tab to be unselected.

Events

Started

Sent when the object turns to started state.

MFiles.Event.Started

Event has no arguments

Example Code

const eventHandle = await shellPaneTab.Events.Register(
  MFiles.Event.Started,
  () => {
    // Handle event
  },
);

// Later unregister the event
shellPaneTab.Events.Unregister(eventHandle);

Stop

Sent before the object is stopped.

MFiles.Event.Stop

Event has no arguments

Example Code

const eventHandle = await shellPaneTab.Events.Register(
  MFiles.Event.Stop,
  () => {
    // Handle event
  },
);

// Later unregister the event
shellPaneTab.Events.Unregister(eventHandle);