The IShellFrame is the central interface that models the whole M-Files Shell. It provides access to all the other UI parts: listing, side panes, search pane and task pane. It enables access to the custom commands creation interface.
Description
Public Methods
 CreateAdditionalListingForPath | Creates an additional listing object to represent the folder content from the path specified. |
| CreateAdditionalListingForView | Creates an additional listing object that represents the content of a view. |
| GetListing | Gets the specified listing object. |
| GetNavigationHistory | Returns the navigation history as paths relative to the vault root. |
| IsFolderLocation | Resolves if the shell frame represents a normal folder location. I.e. 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. |
| NavigateBack | Moves backward in the navigation history. |
| NavigateForward | Moves forward in the navigation history. |
| NavigateToDefaultLandingPage | |
| NavigateToFolder | Navigates to the given folder. |
| NavigateToObject | Navigates the shell frame to the location of an object. |
| NavigateToParent | Performs navigation to the parent folder. |
| SetTheme | Sets the UI theme of the shell frame. |
| ShowDashboard | Changes the listing area to show a dashboard. |
| ShowDefaultContent | Restores the normal listing to the listing area. |
| ShowMessage | Shows the default M-Files message box with the specified content and appearance. |
| ShowPopupDashboard | Shows a dashboard in popup window. |
| ShowPopupSSRSReport | Shows a report in popup window. |
| ShowSSRSReport | Shows a report in the place of shell frame listing area. |
| ShowToastNotification |
Public Properties
 ActiveListing | Accesses the currently active listing object. |
| BottomPane | Accessed the bottom pane of the shell frame. |
| Commands | Accesses the commands of the shell frame. |
| CurrentFolder | Accesses the current folder location. Valid only if the current location is a normal folder location. |
| CurrentObjectVersion | Returns the current object version if the shell frame represents an object folder. |
| CurrentPath | Gets or sets the path to the current folder as string. |
| Events | Returns the event registering interface for the IShellFrame interface. |
| Listing | Accesses the main listing object of the shell frame. |
| OuterWindow | Accesses the window in where the shell frame is located. |
| ParentFolder | Gets the parent folder for current location. |
| RightPane | Accessed the right pane of the shell frame. |
| SearchPane | Accessed the search pane of the shell frame. |
| ShellUI | Accesses the parent shell UI object. |
| TaskPane | Accesses the task pane of the current shell frame. |
| TopPane | Accesses the top pane object. |
| UseCompactLayout | Specifies if the shell frame layout should be more compact. |
See Also