Skip to main content

Interfaces

NameDescription
ICommandsICommands interface provides methods for managing user defined (custom) commands.
ICommonFunctionsICommonFunctions interface provides helper methods for M-Files API object creation, error handling and data persistency. This interface is accessible directly through the MFiles variable.
IDashboardIDashboard interface can be used from the dashboard's implementation. It enables access to the parent object and the underlying window. Also the access to the custom data that was passed to the dashboard when it was opened is provided.
IEventsIEvents interface allows explicit event handler registrations to be made. The alternative is to use the implicit mechanism by implementing the event handlers with pre-defined names e.g. Started -> OnStarted, Stop -> OnStop etc.
ISearchPaneISearchPane interface provides means to manage search pane visibility and to query its availability.
IShellFrameThe IShellFrame is the central interface that models the whole M-Files Shell. It provides access to all the other UI parts: listing, side panes, and search pane. It enables access to the custom commands creation interface.
IShellItemsIShellItems is an interface for accessing the content of M-Files Shell listing items. The set of all items currently visible in the listing are represented as an IShellItems as well as the set of currently selected items.
IShellListingThe IShellListing interface enables managing the listing in M-Files Shell. The items in the listing as well as the selection can be tracked and modified.
IShellPaneContainerIShellPaneContainer is a common interface for the embedded bottom pane and rightpane. The interface enables managing the pane content, size and visibility.
IShellPaneTabAn interface for managing a shell pane tab.
IShellUIThe IShellUI interface corresponds to the Windows Explorer window. It outlives the IShellFrame instances that get destroyed and re-created every time the folder or view is changed. IShellUI makes it possible to control the Windows explorer window, to show message boxes and dashboards so that the dashboards' parent object is not invalidated when navigating to a different view in the M-Files.
IWindowIWindow interface makes it possible to control dashboard's outer window objectwhen it has been opened as a popup.