IShellUI
The IShellUI is available for the Modules on the module startup event
The IShellUI is available for the Dashboards from the ShellFrame property of the IDashboard.
Properties
| Name | Type | Description |
|---|---|---|
| Events | IShellUIEvents | Returns the event registering interface of the IShellUI interface. |
| Vault | IVault | Returns the logged-in M-Files server connection. |
Methods
| Name | Description |
|---|---|
| BroadcastMessage | Sends a synchronous broadcast message to all shellUI modules of all applications running in the current shellUI (main-window). |
| GetFileTypeIconURL | Returns the file type icon from the filename extension as data url. |
| GetObjectTypeIconURL | Gets the URL of the icon for the specified object type. |
| NotifyApplication | Sends a synchronous notification message to all shellUI modules of a specific application running in the current shellUI (main-window). |
| ShowMessage | Shows the default M-Files message box with the specified content and appearance. |
| ShowPopupDashboard | Shows a dashboard in a separate window. |
Events
| Event | Description | Arguments |
|---|---|---|
| Started | Sent when the object turns to started state. | |
| Stop | Register event to listen for the stop event. | |
| NewShellFrame | Register event handler for the NewShellFrame event. This event is triggered when any shell frame object is created, including normal shell frames, common dialogs, and embedded or special shell frames. | shellFrame |
| NewNormalShellFrame | Register event handler for the NewNormalShellFrame event. This event is triggered when a normal shell frame object is created. Note that this event is not triggered for common dialogs, or embedded or special shell frames. | shellFrame The new shell frame object. |
| CrossApplicationNotification | Broadcasted message to multiple applications. | appGUID GUID of the target application, or null if broadcasted to all applications msgId ID of the message which is sent to the other applications. data Custom data to be sent. |