Skip to main content

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

NameTypeDescription
ActiveListingIShellListing
CommandsICommandsAccesses the commands of the shell frame.
CurrentFolderany
CurrentPathstring
CurrentUrlstring
EventsIEventsReturns the event registering interface for the IShellFrame interface.
LeftPaneIShellPaneContainerAccesses the left panes of the shell frame.
ListingIShellListingAccesses the main listing object of the shell frame.
ParentFolderany
RightPaneIShellPaneContainerAccesses the right panes of the shell frame.
SearchPaneISearchPaneAccesses the search pane of the shell frame.
ShellUIIShellUIAccesses the parent shell UI object.

Methods

NameDescription
GetViewsByIdGets known views details as key pair value of <ViewID,View Details.>
IsFolderLocationResolves 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.
IsObjectLocationResolves if the shell frame represents a object folder location.
NavigateToFolderNavigate to the given folder defs.
NavigateToObjectNavigate to the given object.
NavigateToParentPerforms navigation to the parent folder.
ShowDashboardChanges the listing area to show a dashboard.
ShowDefaultContentRestores the normal listing to the listing area.
ShowMessageDisplays a modal message box.
ShowPopupDashboardShows 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:

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);