Click or drag to resize

MFUtils Class

Provides some common utility methods for M-Files operations.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.CommonMFUtils

Namespace:  MFiles.VAF.Common
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.2.0.9
Syntax
C#
public static class MFUtils

The MFUtils type exposes the following members.

Properties
  NameDescription
Public propertyStatic memberBuiltInProperties
Built in property def ids.
Top
Methods
  NameDescription
Public methodStatic memberAddUniqueT(IListT, IEnumerableT)
Collection Extension to Ensure items added to a collection are unique
Public methodStatic memberAddUniqueT(IListT, T)
Collection Extension to Ensure items added to a collection are unique
Public methodStatic memberAddWeekDays
Adds number of requested week days to current day and returns it.
Public methodStatic memberClearTransactionVariable
Removes a key from the named value storage.
Public methodStatic memberConvertToLocalVault
Converts the vault object to locally used and possibly stored vault object. This method allows the implementations to improve the performance by using in-process vault.
Public methodStatic memberGetFirstWorkflowState
Gets the first workflow state defined by a workflow.
Public methodStatic memberGetLoadableTypes
Get all loadable types from an assembly.
Public methodStatic memberGetStateActionSetPropertyValue
Retrieves the Property value of a State action for specific property if it exists. Returns null if property or action set properties not found.
Public methodStatic memberGetStateAdmin
Retrieves the StateAdmin object for a state.
Public methodStatic memberGetTransactionVariables
Gets all values from a specific named value storage namespace.
Public methodStatic memberGetWorkflowIDByState
Finds a state's workflow.
Public methodStatic memberGetWorkflowIDByTransition
Finds a transition's workflow.
Public methodStatic memberIsAlreadyCheckedOutError
Checks if the Exception is an 'Already checked out' error.
Public methodStatic memberIsAtleast
Return true if this version is at least the given separate version number.
Public methodStatic memberIsFileNotFoundError
Checks if the Exception is an 'The system cannot find the file specified.' error.
Public methodStatic memberIsMFilesAccessDeniedError
Checks if the COMException is an 'Object Locked' error.
Public methodStatic memberIsMFilesAlreadyExistsError
Checks if the Exception is a M-Files 'already exists' error.
Public methodStatic memberIsMFilesNotFoundError
Checks if the exception is a 'not found' error.
Public methodStatic memberIsMFilesObjectLockedError
Checks if the COMException is an 'Object Locked' error.
Public methodStatic memberIsObjIDString
Indicates if the passed string matches a valid ObjID format.
Public methodStatic memberIsObjVerString
Indicates if the passed string matches a valid ObjVer format.
Public methodStatic memberIsRemoteProcedureCallFailedError
Determines if this error is a Remote procedure call failed error..
Public methodStatic memberIsRpcServerUnavailableError
Determines if this error is a RPC Server Unavailable error.
Public methodStatic memberIsSessionWithServerNoLongerValidError
Determines if this error is a "The current session with M-Files Server is no longer valid" error.
Public methodStatic memberIsValidEmail
Email Address Validator.
Public methodStatic memberIsValidGuid
Indicates whether the passed string is a valid M-Files formatted GUID. {00000000-0000-0000-0000-000000000000}
Public methodStatic memberIsValidLicenseStatus
Return true if given license status is for valid license.
Public methodStatic memberObjIDString
Converts an ObjID into human readable, and code-parseable string.
Public methodStatic memberObjVerString
Converts an ObjVer into human readable, and code-parseable string.
Public methodStatic memberParseObjIDString
Parses a string into an ObjID object.
Public methodStatic memberParseObjVerString
Parses a string into an ObjVer object.
Public methodStatic memberRemoveWhitespace
Removes all white spaces from the given string.
Public methodStatic memberSetTransactionVariable
Sets a value to the named value storage.
Public methodStatic memberToAliasArray
Helper used for parsing the semantic aliases string into an string array of aliases.
Public methodStatic memberToLookups
Collection Extension to convert a List of ObjVerEx to a Lookups collection.
Public methodStatic memberToStrings
Converts a IEnumerable of string into a Strings collection.
Public methodStatic memberTryGetPropertyValueFromComObj
Attempts to resolve the value from the properties a COM object using the property name. This prevents errors in some com objects that may not have a value set for the property. - These properties will throw an "Unspecified error. (0x80004005)" when attempting to - access the value if no value is present.
Public methodStatic memberTryGetTransactionVariable
Gets a specific value from the named value storage.
Top
Fields
  NameDescription
Public fieldStatic memberCurrentUser
Constant -100, current user.
Public fieldStatic memberCurrentUserAndUsersForWhomTheCurrentUserIsASubstitute
Constant -103, current user and users for whom the current user is a substitute
Public fieldStatic memberDefaultClassPropertyDefs
List of properties included automatically as associated property defs in all classes.
Top
See Also