IShellFrame

The IShellFrame is a property of IDashboard.

It can also be retrieved from the IShellUI using the NewNormalShellFrame event.

shellUI.Events.Register(
  MFiles.Event.NewNormalShellFrame,
  (shellFrame) => {

  }
)

Properties

Name	Type	Description
ActiveListing	IShellListing
Commands	ICommands	Accesses the commands of the shell frame.
CurrentFolder	any[]
CurrentPath	string
CurrentUrl	string
Events	IEvents	Returns the event registering interface for the IShellFrame interface.
LeftPane	IShellPaneContainer	Accesses the left panes of the shell frame.
Listing	IShellListing	Accesses the main listing object of the shell frame.
ParentFolder	any[]
RightPane	IShellPaneContainer	Accesses the right panes of the shell frame.
SearchPane	ISearchPane	Accesses the search pane of the shell frame.
ShellUI	IShellUI	Accesses the parent shell UI object.

Methods

Name	Description
GetViewsById	Gets known views details as key pair value of <ViewID,View Details.>
IsFolderLocation	Resolves if the shell frame represents a normal folder location. For example it is a search folder or view, a property folder or traditional folder, but not an object folder.
IsObjectLocation	Resolves if the shell frame represents a object folder location.
NavigateToFolder	Navigate to the given folder defs.
NavigateToObject	Navigate to the given object.
NavigateToParent	Performs navigation to the parent folder.
ShowDashboard	Changes the listing area to show a dashboard.
ShowDefaultContent	Restores the normal listing to the listing area.
ShowMessage	Displays a modal message box.
ShowPopupDashboard	Shows a dashboard in popup window.

Events

NewCommands

Triggered when a new commands object is created.

MFiles.Event.NewCommands

Event has no arguments

Example Code

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

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

NewRightPane

Triggered when a shell pane container is created for right shell pane.

MFiles.Event.NewRightPane

Event has no arguments

Example Code

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

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

NewShellListing

Triggered when a new shell listing object is created.

MFiles.Event.NewShellListing

Arguments:

• newShellisting : IShellListing The new shell listing object.

Example Code

const eventHandle = await shellFrame.Events.Register(
  MFiles.Event.NewShellListing,
  (
    newShellisting, // [IShellListing](/UIExt2/Interfaces/IShellListing/)
  ) => {
    // Handle event
  },
);

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

Started

Sent when the object turns to started state.

MFiles.Event.Started

Event has no arguments

Example Code

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

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

Stop

Sent before the object is stopped.

MFiles.Event.Stop

Event has no arguments

Example Code

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

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

ViewLocationChanged

MFiles.Event.ViewLocationChanged

Event has no arguments

Example Code

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

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

ViewLocationChangedAsync

MFiles.Event.ViewLocationChangedAsync

Event has no arguments

Example Code

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

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