IShellFrame

The IShellFrame is a property of IDashboard.

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

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

  }
)

Properties

Name	Type	Description
ActiveListing	IShellListing	Accesses the currently active listing object.
Commands	ICommands	Accesses the commands of the shell frame.
CurrentFolder	Array < Folder >	Accesses the current folder location. Valid only if the current location is a normal folder location.
CurrentPath	string	Gets the path to the current folder as string. For special views, the following built-in path strings are used: - Search - Search view - Workspaces - Workspaces view - Pinned - Pinned view - Checked Out to Me\\ - Checked Out to Me - Recently Modified by Me\\ - Recently Modified by Me - Assigned to Me\\ - Assigned to Me - Recently Accessed by Me\\ - Recently Accessed by Me - Favorites\\ - Favorites - Object History - Object History - Conflict Resolution - Conflict Resolution - _singleObject - Single Object view (opened when navigating to an object)
CurrentUrl	string	Gets the current view url as a string.
Events	IShellFrameEvents	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	Array < Folder >	Gets the parent folder for current location.
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
GetSandboxAttributes	Gets the sandbox attributes for the specified Module.
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

Event	Description	Arguments
Stop	Sent before the IShellFrame is stopped.
Started	Registers event handler for the IShellFrame started event, which means that the IShellFrame is ready to be used. This event will trigger at least once for each registered callback if the IShellFrame is already started and not yet stopped.
ViewLocationChanged	Registers event handler for the IShellFrame ViewLocationChanged event, which means that the view location has changed.
ViewLocationChangedAsync	Registers event handler for the IShellFrame ViewLocationChangedAsync event, which means that the view location has changed.
NewCommands	Registers event handler for the IShellFrame NewCommands event, which means that a new ICommands interface has been created and is ready to be used.
NewRightPane	Registers event handler for the IShellFrame NewRightPane event, which means that a shell pane container is created for right shell pane.
NewShellListing	Registers event handler for the IShellFrame NewShellListing event, which means that a new shell listing object is created.	newShellisting The new IShellListing object.

shellFrame.Events.Register(
  Event.NewShellListing,
  (newShellisting: IShellListing) => {
    // Do something with the new shell listing object
  },
);