ICommonFunctions interface provides helper methods for M-Files API object creation, error handling and data persistency. This interface is accessible directly through the MFiles variable.
Description
Public Methods
 CreateInstance | Creates a new M-Files API object. This method is no longer needed. New applications should create objects with the new keyword. See remarks for more details. |
| CreateObjectCLR | Creates a managed object from a class in managed assembly. |
| DeleteRegistryKey | Deletes the M-Files registry key. |
| DeleteRegistryValue | Deletes the M-Files registry value. |
| EnableExceptionPropagation | Enables exception propagation to the caller process. After calling this method the exception must be rethrown. The method is meant to be used in dashboards. It suppresses the browser's default error dialog and propagates the error to M-Files that can show it together with a proper callstack. |
| ExecuteURL | Executes the given URL. |
| GetErrorDescription | Extracts the error description from the error exception object. |
| GetLongErrorDescription | Extracts the long (detailed) error description from the error exception object. |
| IsClientFeatureEnabled | Checks whether the flagged feature is enabled in the client. |
| IsServerToolsFeatureEnabled | Checks whether a flagged feature is available in M-Files Admin. |
| KillTimer | Kills a timer that was previously created with the "SetTimer" method. |
| LaunchHelp | Opens the M-Files user guide and shows a topic in the guide. |
| PersistStringData | Persists string data to the Windows registry. |
| ReadFromRegistry | Reads the registry value from registry. |
| ReadTextFile | Read a text file and returns the contents as a string. |
| ReportException | Reports an exception. The exception can be displayed to the user or written to the event log. |
| RetrieveStringData | Retrieves string data from the Windows registry. |
| SetTimer | Creates a timer for triggering an asynchronous method call after a specified time interval. |
| ThrowError | Throws an error with a description. Interrupts the application execution. |
| WriteToRegistry | Writes a new value to the registry. |
Public Properties
 ApplicationPath | Gets the current application path (full path). The path is meant to be used with custom solutions, paths used with application interface do not need to use this method because they are always relative to the application path. |
| CurrentApplicationPlatform | Returns the ExtApplicationPlatform type. |
See Also