IShellPaneContainer

Represents an area of the screen which is reserved for displaying the dashboards. Usually a property of IShellFrame

Properties

Name	Type	Description
Available	boolean	Returns a True / False if the panel is available.
Events	IEvents	Returns the event registering interface for theIShellPaneContainer interface.
Minimized	boolean
ShellFrame	IShellFrame	Returns a reference to the IShellFrame which owns this IShellPaneContainer.
Size	number
Visible	boolean

Methods

Name	Description
AddTab	Creates a new tab and adds it to the collection of tabs.
GetSelectedTabs	Gets the selected (active) tabs.
GetTab	Gets the tab with the specified tab id.

Events

Started

Sent when the object turns to started state.

MFiles.Event.Started

Event has no arguments

Example Code

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

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

Stop

Sent before the object is stopped.

MFiles.Event.Stop

Event has no arguments

Example Code

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

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