M-Files UI Extensibility Framework
IShellFrame Interface
Members 
Description
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.
Public Methods
Creates an additional listing object to represent the folder content from the path specified.
Creates an additional listing object that represents the content of a view.
Gets the specified listing object.
Returns the navigation history as paths relative to the vault root.
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.
 
Resolves if the shell frame represents a object folder location.
Moves backward in the navigation history.
Moves forward in the navigation history.
Navigates to the given folder.
Navigates the shell frame to the location of an object.
Performs navigation to the parent folder.
 
Sets the UI theme of the shell frame.
Changes the listing area to show a dashboard.
Restores the normal listing to the listing area.
Shows the default M-Files message box with the specified content and appearance.
Shows a dashboard in popup window.
Shows a report in popup window.
Shows a report in the place of shell frame listing area.
Public Properties
Accesses the currently active listing object.
Accessed the bottom pane of the shell frame.
Accesses the commands of the shell frame.
Accesses the current folder location. Valid only if the current location is a normal folder location.
Returns the current object version if the shell frame represents an object folder.
Gets or sets the path to the current folder as string.
Returns the event registering interface for the IShellFrame interface.
Accesses the main listing object of the shell frame.
Accesses the window in where the shell frame is located.
Gets the parent folder for current location.
Accessed the right pane of the shell frame.
Accessed the search pane of the shell frame.
Accesses the parent shell UI object.
Accesses the task pane of the current shell frame.
Accesses the top pane object.
Specifies if the shell frame layout should be more compact.
See Also

IShellFrame Members