Event
The Event enumeration lists collectively all events.
| Name | Value | Description |
|---|---|---|
Started | 2 | OnStarted Event. |
Stop | 3 | OnStop Event. |
NewShellFrame | 7 | OnNewShellFrame Event. |
NewNormalShellFrame | 8 | OnNewNormalShellFrame Event. |
NewRightPane | 14 | OnNewRightPane Event. |
NewShellListing | 15 | OnNewShellListing Event. |
NewCommands | 16 | OnNewCommands Event. |
ActiveListingChanged | 17 | OnActiveListingChanged Event. |
TabSelected | 19 | OnTabSelected Event (ShellPaneContainer),OnTabSelected Event (ShellPaneTab). |
TabUnselected | 20 | OnTabUnselected Event (ShellPaneContainer),OnTabUnselected Event (ShellPaneTab). |
BuiltinCommand | 22 | This event is triggered when built-in command is fired. To cancel the event the UI Extension can return "false" in asyncronous event handler. |
CustomCommand | 23 | OnCustomCommand Event. |
SelectionChanged | 24 | OnSelectionChanged Event. |
SelectedItemsChanged | 25 | OnSelectedItemsChanged Event. |
ContentChanged | 26 | OnContentChanged Event. |
ShowContextMenu | 27 | OnShowContextMenu Event. |
ListingActivated | 29 | OnListingActivated Event. |
ListingDeactivated | 30 | OnListingDeactivated Event. |
CloseWindow | 33 | OnCloseWindow Event. |
CreateObject | 35 | OnCreateObject Event. Triggered when the creation of a new object is requested. This event occurs before the request is passed to M-Files Server. |
ObjectCreated | 36 | OnObjectCreated Event. Triggered after the request to create a new object succeeded on M-Files Server. |
DestroyObjects | 39 | OnDestroyObjects Event. Triggered when the destruction of one or more vault objects is requested. This event occurs before the request is passed to M-Files Server. |
ObjectsDestroyed | 40 | OnObjectsDestroyed Event. Triggered after the request to destroy one or more vault objects succeeded on M-Files Server. |
DestroyObjectVersions | 43 | OnDestroyObjectVersions Event. Triggered when the destruction of one or more object versions is requested. This event occurs before the request is passed to M-Files Server. NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments. |
ObjectVersionsDestroyed | 44 | OnObjectVersionsDestroyed Event. Triggered after the request to destroy one or more object versions succeeded on M-Files Server. NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments. |
RemoveObjects | 47 | OnRemoveObjects Event. Triggered when the deletion of one or more vault objects is requested. This event occurs before the request is passed to M-Files Server. |
ObjectsRemoved | 48 | OnObjectsRemoved Event. Triggered after the request to delete one or more vault objects succeeded on M-Files Server. |
UndeleteObjects | 51 | OnUndeleteObjects Event. Triggered when the undeletion of one or more vault objects is requested. This event occurs before the request is passed to M-Files Server. |
ObjectsUndeleted | 52 | OnObjectsUndeleted Event. Triggered after the request to undelete one or more vault objects succeeded on M-Files Server. |
AddObjectFile | 53 | OnAddObjectFile Event. Triggered when the addition of a new file to a document is requested. This event occurs before the request is passed to M-Files Server. |
ObjectFileAdded | 54 | OnObjectFileAdded Event. Triggered after a request to add a file to a document succeeds on M-Files Server. |
RemoveObjectFile | 55 | OnRemoveObjectFile Event. Triggered when the removal of a file from an object version is requested. This event occurs before the request is passed to M-Files Server. |
ObjectFileRemoved | 56 | OnObjectFileRemoved Event. Triggered after a request to remove an object file from an object version succeeds on M-Files Server. |
RenameObjectFile | 57 | OnRenameObjectFile Event. Triggered when the renaming of a file in a document is requested. This event occurs before the request is passed to M-Files Server. |
ObjectFileRenamed | 58 | OnObjectFileRenamed Event. Triggered after a request to rename a file in a document succeeds on M-Files Server. |
CheckInObjects | 61 | OnCheckInObjects Event. Triggered when the check in of one or more vault objects is requested. This event occurs before the request is passed to M-Files Server. |
ObjectsCheckedIn | 62 | OnObjectsCheckedIn Event. Triggered after the request to check in one or more vault objects succeeded on M-Files Server. |
CheckOutObjects | 65 | OnCheckOutObjects Event. Triggered when the checking out of one or more vault objects is requested. This event occurs before the request is passed to M-Files Server. |
ObjectsCheckedOut | 66 | OnObjectsCheckedOut Event. Triggered after the request to check out one or more vault objects succeeded on M-Files Server. |
UndoObjectCheckouts | 69 | OnUndoObjectCheckouts Event. Triggered when the undoing checkout of one or more vault objects is requested. This event occurs before the request is passed to M-Files Server. |
ObjectCheckoutsUndone | 70 | OnObjectCheckoutsUndone Event. Triggered after the request to undo checkout of one or more vault objects succeeded on M-Files Server. |
RollBackObjectVersion | 71 | OnRollBackObjectVersion Event. Triggered when the roll back of a previous vault object version is requested. This event occurs before the request is passed to M-Files Server. |
ObjectVersionRolledBack | 72 | OnObjectVersionRolledBack Event. Triggered after a request to roll back a previous vault object version succeeds on M-Files Server. |
SetPropertiesOfObjectVersions | 75 | OnSetPropertiesOfObjectVersions Event. Triggered when setting properties for one or more object versions is requested. This event occurs before the request is passed to M-Files Server. |
PropertiesOfObjectVersionsSet | 76 | OnPropertiesOfObjectVersionsSet Event. Triggered after a request to set properties of one or more object versions succeeds on M-Files Server. |
SetObjectVersionPermissions | 77 | OnSetObjectVersionPermissions Event. Triggered when changing the permissions of an object version is requested. This event occurs before the request is passed to M-Files Server. |
ObjectVersionPermissionsSet | 78 | OnObjectVersionPermissionsSet Event. Triggered after a request to change the permissions of an object version succeeds on M-Files Server. |
ModifyObjectVersionLabels | 87 | OnModifyObjectVersionLabels Event. Triggered when modifying the labels of an object version is requested. This event occurs before the request is passed to M-Files Server. NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments. |
ObjectVersionLabelsModified | 88 | OnObjectVersionLabelsModified Event. Triggered after a request to modify the labels of an object version succeeds on M-Files Server. NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments. |
SetObjectLevelProperty | 89 | OnSetObjectLevelProperty Event. Triggered when setting an object-level property is requested. This event occurs before the request is passed to M-Files Server. |
ObjectLevelPropertySet | 90 | OnObjectLevelPropertySet Event. Triggered after a request to set an object-level property succeeds on M-Files Server. |
LogOut | 99 | OnLogOut Event. Triggered when logging out of the vault is requested. This event occurs before the logout is processed. NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments. |
ChangeVaultLanguage | 100 | OnChangeVaultLanguage Event. Triggered when changing the vault language is requested. This event occurs before the request is passed to M-Files Server. NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments. |
VaultLanguageChanged | 101 | OnVaultLanguageChanged Event. Triggered after the vault language has been changed. NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments. |
ListItemAdded | 152 | ListItemAdded Event. |
ListItemModified | 153 | ListItemModified Event. |
ListItemRemoved | 154 | ListItemRemoved Event. |
FacetValuesReady | 162 | FacetValuesReady Event. |
CrossApplicationNotification | 168 | CrossApplicationNotification Event. |
NewLeftPane | 170 | OnNewLeftPane Event. |
SelectNextObject | 174 | OnSelectNextObject Event. |
SelectPreviousObject | 175 | OnSelectPreviousObject Event. |
SelectNextObjectFile | 176 | OnSelectNextObjectFile Event. |
SelectPreviousObjectFile | 177 | OnSelectPreviousObjectFile Event. |
SelectNextFolder | 178 | OnSelectNextFolder Event. |
SelectPreviousFolder | 179 | OnSelectPreviousFolder Event. |
ViewPageChanged | 180 | OnViewPageChanged Event. |
StartPageChange | 181 | OnStartPageChange Event. |
ListingPageChanged | 182 | OnListingPageChanged Event. |
Refresh | 185 | OnRefresh Event. |
ColumnGlobalSortingChanged | 187 | ColumnGlobalSortingChanged event. |
ViewLocationChanged | 188 | ViewLocationChanged event. |
ViewLocationChangedAsync | 189 | ViewLocationChangedAsync event. |
ViewCreationStarted | 190 | ViewCreationStarted event. |
CustomDataChanged | 199 | Custom data has changed in dashboard. |
Runtime Access
This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.Event.<value>.
Example:
const value = MFiles.Event.Started;
See also: MFiles Global Object