M-Files UI Extensibility Framework
Client Application Developer's Guide
M-Files UI Extensibility Framework Objects
Overview
Interfaces
ICommands Interface
Overview
Methods
AddCustomCommandToMenu Method
CreateCustomCommand Method
DeleteCustomCommand Method
ExecuteCommand Method
GetCommandName Method
GetCommandState Method
RemoveCustomCommandFromMenu Method
SetCommandState Method
SetIcon Method
SetIconFromPath Method
Properties
Events Property
ICommonFunctions Interface
Overview
Methods
CreateInstance Method
CreateObjectCLR Method
DeleteRegistryKey Method
DeleteRegistryValue Method
EnableExceptionPropagation Method
ExecuteURL Method
GetErrorDescription Method
GetLongErrorDescription Method
IsClientFeatureEnabled Method
IsServerToolsFeatureEnabled Method
KillTimer Method
LaunchHelp Method
PersistStringData Method
ReadFromRegistry Method
ReadTextFile Method
ReportException Method
RetrieveStringData Method
SetTimer Method
ThrowError Method
WriteToRegistry Method
Properties
ApplicationPath Property
CurrentApplicationPlatform Property
IDashboard Interface
Overview
Methods
ShowMessage Method
ShowPopupDashboard Method
Properties
AutoStopWithParent Property
customData Property
DropTarget Property
Events Property
IsPopupDashboard Property
Parent Property
UseRightToLeftLayout Property
Vault Property
Window Property
IEvents Interface
Overview
Methods
Register Method
Unregister Method
ISearchPane Interface
Overview
Methods
ExecuteNewSearch Method
GetOptions Method
SetOptionState Method
SetTheme Method
UpdateSearch Method
Properties
Available Property
Events Property
SearchWithinView Property
SearchWithinViewOptionVisible Property
ShellFrame Property
Visible Property
IShellFrame Interface
Overview
Methods
CreateAdditionalListingForPath Method
CreateAdditionalListingForView Method
GetListing Method
GetNavigationHistory Method
IsFolderLocation Method
IsObjectLocation Method
NavigateBack Method
NavigateForward Method
NavigateToDefaultLandingPage Method
NavigateToFolder Method
NavigateToObject Method
NavigateToParent Method
SetTheme Method
ShowDashboard Method
ShowDefaultContent Method
ShowMessage Method
ShowPopupDashboard Method
ShowPopupSSRSReport Method
ShowSSRSReport Method
ShowToastNotification Method
Properties
ActiveListing Property
BottomPane Property
Commands Property
CurrentFolder Property
CurrentObjectVersion Property
CurrentPath Property
Events Property
Listing Property
OuterWindow Property
ParentFolder Property
RightPane Property
SearchPane Property
ShellUI Property
TaskPane Property
TopPane Property
UseCompactLayout Property
IShellItems Interface
Overview
Methods
GetFoldersCount Method
GetObjectVersionsCount Method
Properties
Count Property
Folders Property
ObjectFiles Property
ObjectVersions Property
ObjectVersionsAndProperties Property
IShellListing Interface
Overview
Methods
ActivateListing Method
ActivateSelected Method
GetFolderName Method
RefreshListing Method
RefreshListingAsync Method
RefreshObject Method
RefreshSelectedObjects Method
SelectFolder Method
SelectNextFolder Method
SelectNextObject Method
SelectNextObjectFile Method
SelectObjectFile Method
SelectObjectOrObjectFileVersion Method
SelectObjectVersion Method
SelectPrevFolder Method
SelectPrevObject Method
SelectPrevObjectFile Method
SetFolderSelectionStates Method
SetObjectOrObjectFileVersionSelectionStates Method
SetObjectVersionSelectionStates Method
SetTheme Method
SetVirtualSelection Method
UnselectAll Method
Properties
AutoFitAllColumns Property
AutoFitFirstColumn Property
ColumnHeadersVisible Property
ColumnsVisible Property
CurrentPath Property
CurrentSelection Property
Events Property
GroupObjectsByObjectType Property
GroupViewsAndFolders Property
IsActive Property
items Property
ShellFrame Property
SumOfResultCounts Property
IShellPaneContainer Interface
Overview
Methods
AddTab Method
Focus Method
GetSelectedTab Method
GetTab Method
GetTabIds Method
SetDefaultSize Method
SetDefaultVisibility Method
Properties
Available Property
Content Property
Events Property
IsFocused Property
Minimized Property
ShellFrame Property
Size Property
TabTitleSize Property
Visible Property
IShellPaneTab Interface
Overview
Methods
Remove Method
Select Method
SelectAsUser Method
ShowDashboard Method
ShowEmptyContent Method
ShowFilePreview Method
ShowPersistentContent Method
ShowSSRSReport Method
Unselect Method
Properties
Events Property
IsBuiltIn Property
Selected Property
TabId Property
Title Property
Visible Property
IShellUI Interface
Overview
Methods
BroadcastMessage Method
CreatePersistentBrowserContent Method
DestroyPersistentContent Method
GetObjectTypeIconURL Method
NotifyApplication Method
NotifyVaultEntry Method
SetPersistentBrowserContent Method
ShowMessage Method
ShowPopupDashboard Method
Properties
Events Property
FastBrowsingActive Property
ServerVault Property
Vault Property
Window Property
ITaskPane Interface
Overview
Methods
AddCustomCommandToGroup Method
CreateGroup Method
DeleteGroup Method
RemoveCustomCommandFromGroup Method
SetLogo Method
SetTheme Method
Properties
Available Property
Events Property
Minimized Property
ShellFrame Property
Visible Property
ITopPane Interface
Overview
Methods
HideUserResearchPanelNotification Method
OpenContextMenu Method
OpenUserResearchPanelNotificationLinkInBrowser Method
ShowConnectionStatusDialog Method
ShowDashboard Method
ShowOfflineSyncStatusDialog Method
StartAutoInstall Method
Properties
AutoInstallDeadline Property
Available Property
Breadcrumbs Property
BreadcrumbsEx Property
CanShowAutoInstallNoteNow Property
CanShowFastBrowsingIncompatibleApps Property
CanShowUserResearchPanelNotification Property
CanShowUserResearchPanelNotificationNow Property
Events Property
NetWorkStatusRoundTripTime Property
OfflineSyncStatusIconVisible Property
ShellFrame Property
Visible Property
IVaultCore Interface
Overview
Properties
Events Property
ServerVault Property
IVaultEntry Interface
Overview
Methods
NotifyVaultEntry Method
Properties
Events Property
Vault Property
VaultCore Property
VaultUI Property
IVaultUI Interface
Overview
Methods
ShowMessage Method
ShowPopupDashboard Method
Properties
Events Property
Vault Property
VaultEntry Property
IWindow Interface
Overview
Methods
Close Method
Focus Method
Maximize Method
Minimize Method
Restore Method
SetDefaultSize Method
Properties
Events Property
Handle Property
Height Property
IsFocused Property
Maximizable Property
Minimizable Property
Resizable Property
Title Property
Width Property
Methods
ActivateListing Method
ActivateSelected Method
AddCustomCommandToGroup Method
AddCustomCommandToMenu Method
AddTab Method
BroadcastMessage Method
Close Method
CreateAdditionalListingForPath Method
CreateAdditionalListingForView Method
CreateCustomCommand Method
CreateGroup Method
CreateInstance Method
CreateObjectCLR Method
CreatePersistentBrowserContent Method
DeleteCustomCommand Method
DeleteGroup Method
DeleteRegistryKey Method
DeleteRegistryValue Method
DestroyPersistentContent Method
EnableExceptionPropagation Method
ExecuteCommand Method
ExecuteNewSearch Method
ExecuteURL Method
Focus Method (IShellPaneContainer)
Focus Method (IWindow)
GetCommandName Method
GetCommandState Method
GetErrorDescription Method
GetFolderName Method
GetFoldersCount Method
GetListing Method
GetLongErrorDescription Method
GetNavigationHistory Method
GetObjectTypeIconURL Method
GetObjectVersionsCount Method
GetOptions Method
GetSelectedTab Method
GetTab Method
GetTabIds Method
HideUserResearchPanelNotification Method
IsClientFeatureEnabled Method
IsFolderLocation Method
IsObjectLocation Method
IsServerToolsFeatureEnabled Method
KillTimer Method
LaunchHelp Method
Maximize Method
Minimize Method
NavigateBack Method
NavigateForward Method
NavigateToDefaultLandingPage Method
NavigateToFolder Method
NavigateToObject Method
NavigateToParent Method
NotifyApplication Method
NotifyVaultEntry Method (IShellUI)
NotifyVaultEntry Method (IVaultEntry)
OpenContextMenu Method
OpenUserResearchPanelNotificationLinkInBrowser Method
PersistStringData Method
ReadFromRegistry Method
ReadTextFile Method
RefreshListing Method
RefreshListingAsync Method
RefreshObject Method
RefreshSelectedObjects Method
Register Method
Remove Method
RemoveCustomCommandFromGroup Method
RemoveCustomCommandFromMenu Method
ReportException Method
Restore Method
RetrieveStringData Method
Select Method
SelectAsUser Method
SelectFolder Method
SelectNextFolder Method
SelectNextObject Method
SelectNextObjectFile Method
SelectObjectFile Method
SelectObjectOrObjectFileVersion Method
SelectObjectVersion Method
SelectPrevFolder Method
SelectPrevObject Method
SelectPrevObjectFile Method
SetCommandState Method
SetDefaultSize Method (IShellPaneContainer)
SetDefaultSize Method (IWindow)
SetDefaultVisibility Method
SetFolderSelectionStates Method
SetIcon Method
SetIconFromPath Method
SetLogo Method
SetObjectOrObjectFileVersionSelectionStates Method
SetObjectVersionSelectionStates Method
SetOptionState Method
SetPersistentBrowserContent Method
SetTheme Method (IShellFrame)
SetTheme Method (IShellListing)
SetTheme Method (ITaskPane)
SetTheme Method (ISearchPane)
SetTimer Method
SetVirtualSelection Method
ShowConnectionStatusDialog Method
ShowDashboard Method (IShellFrame)
ShowDashboard Method (IShellPaneTab)
ShowDashboard Method (ITopPane)
ShowDefaultContent Method
ShowEmptyContent Method
ShowFilePreview Method
ShowMessage Method (IShellFrame)
ShowMessage Method (IShellUI)
ShowMessage Method (IVaultUI)
ShowMessage Method (IDashboard)
ShowOfflineSyncStatusDialog Method
ShowPersistentContent Method
ShowPopupDashboard Method (IShellFrame)
ShowPopupDashboard Method (IShellUI)
ShowPopupDashboard Method (IVaultUI)
ShowPopupDashboard Method (IDashboard)
ShowPopupSSRSReport Method
ShowSSRSReport Method (IShellFrame)
ShowSSRSReport Method (IShellPaneTab)
ShowToastNotification Method
StartAutoInstall Method
ThrowError Method
Unregister Method
Unselect Method
UnselectAll Method
UpdateSearch Method
WriteToRegistry Method
Properties
ActiveListing Property
ApplicationPath Property
AutoFitAllColumns Property
AutoFitFirstColumn Property
AutoInstallDeadline Property
AutoStopWithParent Property
Available Property (IShellPaneContainer)
Available Property (ITaskPane)
Available Property (ITopPane)
Available Property (ISearchPane)
BottomPane Property
Breadcrumbs Property
BreadcrumbsEx Property
CanShowAutoInstallNoteNow Property
CanShowFastBrowsingIncompatibleApps Property
CanShowUserResearchPanelNotification Property
CanShowUserResearchPanelNotificationNow Property
ColumnHeadersVisible Property
ColumnsVisible Property
Commands Property
Content Property
Count Property
CurrentApplicationPlatform Property
CurrentFolder Property
CurrentObjectVersion Property
CurrentPath Property (IShellFrame)
CurrentPath Property (IShellListing)
CurrentSelection Property
customData Property
DropTarget Property
Events Property (IShellFrame)
Events Property (IShellUI)
Events Property (IShellPaneContainer)
Events Property (IVaultCore)
Events Property (IShellListing)
Events Property (ITaskPane)
Events Property (IShellPaneTab)
Events Property (ITopPane)
Events Property (IVaultUI)
Events Property (IWindow)
Events Property (IDashboard)
Events Property (ISearchPane)
Events Property (ICommands)
Events Property (IVaultEntry)
FastBrowsingActive Property
Folders Property
GroupObjectsByObjectType Property
GroupViewsAndFolders Property
Handle Property
Height Property
IsActive Property
IsBuiltIn Property
IsFocused Property (IShellPaneContainer)
IsFocused Property (IWindow)
IsPopupDashboard Property
items Property
Listing Property
Maximizable Property
Minimizable Property
Minimized Property (IShellPaneContainer)
Minimized Property (ITaskPane)
NetWorkStatusRoundTripTime Property
ObjectFiles Property
ObjectVersions Property
ObjectVersionsAndProperties Property
OfflineSyncStatusIconVisible Property
OuterWindow Property
Parent Property
ParentFolder Property
Resizable Property
RightPane Property
SearchPane Property
SearchWithinView Property
SearchWithinViewOptionVisible Property
Selected Property
ServerVault Property (IShellUI)
ServerVault Property (IVaultCore)
ShellFrame Property (IShellPaneContainer)
ShellFrame Property (IShellListing)
ShellFrame Property (ITaskPane)
ShellFrame Property (ITopPane)
ShellFrame Property (ISearchPane)
ShellUI Property
Size Property
SumOfResultCounts Property
TabId Property
TabTitleSize Property
TaskPane Property
Title Property (IShellPaneTab)
Title Property (IWindow)
TopPane Property
UseCompactLayout Property
UseRightToLeftLayout Property
Vault Property (IShellUI)
Vault Property (IVaultUI)
Vault Property (IDashboard)
Vault Property (IVaultEntry)
VaultCore Property
VaultEntry Property
VaultUI Property
Visible Property (IShellPaneContainer)
Visible Property (ITaskPane)
Visible Property (IShellPaneTab)
Visible Property (ITopPane)
Visible Property (ISearchPane)
Width Property
Window Property (IShellUI)
Window Property (IDashboard)
Enumerations
BuiltinCommand Enumeration
CommandLocation Enumeration
CommandState Enumeration
DefaultIcon Enumeration
Event Enumeration
ExtApplicationPlatform Enumeration
ListingEmptinessState Enumeration
MenuLocation Enumeration
NavigationHistory Enumeration
SearchFeature Enumeration
TaskPaneGroup Enumeration
Events
OnActiveListingChanged Event
OnAddObjectFile Event
OnAddObjectsToFavorites Event
OnAddObjectToFavorites Event
OnAutoInstallScheduleChanged Event
OnBuiltinCommand Event
OnChangeVaultLanguage Event
OnCheckInObject Event
OnCheckInObjects Event
OnCheckOutObject Event
OnCheckOutObjects Event
OnCloseWindow Event
OnContentChanged Event
OnCopyConflictObjectAsNewVersionToBaseObject Event
OnCreateObject Event
OnCrossApplicationBroadcast Event
OnCrossApplicationNotification Event
OnCustomCommand Event
OnDestroyObject Event
OnDestroyObjects Event
OnDestroyObjectVersion Event
OnDestroyObjectVersions Event
OnDragEntered Event
OnDragLeft Event
OnDragOver Event
OnFacetValuesError Event
OnFacetValuesReady Event
OnHidePane Event
OnHideTab Event
OnItemsDropped Event
OnListingActivated Event
OnListingDeactivated Event
OnListingUpdated Event
OnLoggedIn Event
OnLogOut Event
OnMinimizedStateChanged Event (ShellPaneContainer)
OnModifyObjectVersionLabels Event
OnNewBottomPane Event
OnNewCommands Event
OnNewCommonDialogShellFrame Event
OnNewEmbeddedShellFrame Event
OnNewNormalShellFrame Event
OnNewRightPane Event
OnNewSearchPane Event
OnNewShellFrame Event
OnNewShellListing Event
OnNewSpecialShellFrame Event
OnNewTab Event
OnNewTaskPane Event
OnNewTopPane Event
OnNewVaultEntry Event
OnNewVersionBasedOnConflictObjectCreated Event
OnNotification Event
OnObjectAddedToFavorites Event
OnObjectCheckedIn Event
OnObjectCheckedOut Event
OnObjectCheckoutsUndone Event
OnObjectCheckoutUndone Event
OnObjectCreated Event
OnObjectDestroyed Event
OnObjectFileAdded Event
OnObjectFileRemoved Event
OnObjectFileRenamed Event
OnObjectLevelPropertySet Event
OnObjectOfflineAvailabilityRemoved Event
OnObjectOfflineAvailabilitySet Event
OnObjectRemoved Event
OnObjectRemovedFromFavorites Event
OnObjectsAddedToFavorites Event
OnObjectsCheckedIn Event
OnObjectsCheckedOut Event
OnObjectsDestroyed Event
OnObjectsRemoved Event
OnObjectsRemovedFromFavorites Event
OnObjectsUndeleted Event
OnObjectUndeleted Event
OnObjectVersionDestroyed Event
OnObjectVersionLabelsModified Event
OnObjectVersionPermissionsSet Event
OnObjectVersionRolledBack Event
OnObjectVersionsDestroyed Event
OnOfflineSyncStopped Event
OnOfflineSyncStarted Event
OnPaneResized Event
OnPropertiesOfObjectVersionSet Event
OnPropertiesOfObjectVersionsSet Event
OnRemoveObject Event
OnRemoveObjectFile Event
OnRemoveObjectFromFavorites Event
OnRemoveObjectOfflineAvailability Event
OnRemoveObjects Event
OnRemoveObjectsFromFavorites Event
OnRenameObjectFile Event
OnRollBackObjectVersion Event
OnSearchCriteriaChanged Event
OnSearchCriteriaReset Event
OnSearchInitiated Event
OnSearchReady Event
OnSelectedItemsChanged Event
OnSelectionChanged Event
OnSetObjectLevelProperty Event
OnSetObjectOfflineAvailability Event
OnSetObjectVersionPermissions Event
OnSetPropertiesOfObjectVersion Event
OnSetPropertiesOfObjectVersions Event
OnShowContextMenu Event
OnShowMainMenu Event (ShellFrame)
OnShowMainMenu Event (ShellListing)
OnShowPane Event
OnShowTab Event
OnStarted Event
OnStop Event
OnTabSelected Event (ShellPaneContainer)
OnTabSelected Event (ShellPaneTab)
OnTabUnselected Event (ShellPaneContainer)
OnTabUnselected Event (ShellPaneTab)
OnTemporarySearchModified Event
OnUndeleteObjects Event
OnUndeleteObject Event
OnUndoObjectCheckout Event
OnUndoObjectCheckouts Event
OnVaultLanguageChanged Event
Client Application Definition File Schemas
Application Definition File
Overview
Elements
application Element
Client Application Definition File (v3) Schema
Overview
Elements
application Element
Client Application Definition File (v4) Schema
Overview
Elements
application Element
Supported M-Files API Components in the Classic M-Files Web
Supported UI Extensibility Components in the Classic M-Files Web
Technical Articles
Using ShellUI Module
Using Dashboards
Using Tabs in Shell Frame Side Pane Tabs
Showing Message Boxes
Using VaultCore and VaultUI Modules
Communicating from ShellUI to VaultUI and VaultCore
Using Managed Assemblies with UI Extensibility Applications
Calling Asynchronous M-Files API Vault Operations
Theming And Branding
Error Handling in UI Extensibility Application
Using Persistent WWW Sessions in Windows Explorer
Creating M-Files API Objects
Embedding Shell Listings and File Previewers in Dashboards
Debugging UI Implementations
Delegating Work to M-Files Server
Customizing the Application Icon