Click or drag to resize

MFiles.VAF.Common Namespace

 
Classes
  ClassDescription
Public classCode exampleAccessCache Obsolete.
Access Cache Class : Caches all Object, Class, and Property Structure elements. User and Groups Access rights are stored on the structure element that each are related to.
Examples
Used in order to check the Levels of Access a User or UserGroup has to a Object, Class or Property, or from an ObjVerEx.
AccessCache cache = new AccessCache( ServerVault );
ObjVerEx objVerEx = ObjVerEx.Parse( ServerVault, "(0-6)" );

AccessCache.ObjVerExPermissions objVerExPermissions = new AccessCache.ObjVerExPermissions(
           objVerEx,
           cache,
           ( int ) MFBuiltInUserGroup.MFBuiltInUserGroupAllInternalUsers,
           true );

Console.WriteLine( objVerExPermissions.ToString(true) );

AccessCache.Accessibility hiddenProp = objVerExPermissions.Properties.SingleOrDefault( p => p.StructureID == 1234 );
Assert.IsNotNull( hiddenProp );
Assert.IsFalse( hiddenProp.CanRead );
Public classAccessibility Obsolete.
The Accessibility Class provides a wrapper around the AccessControlEntry class.
Public classApplicationDefinition
ApplicationDefinition is a class that provides the application basic information read from the appdef.xml which is associated with the application.
Public classApplicationDefinitionApplicationDefinitionData
The internal data representation in appdef.xml.
Protected classApplicationDefinitionApplicationDefinitionDataElementNames
appdef.xml element names from which the data is read.
Public classAutomaticStateTransitionTriggerAttribute
Attribute for marking the automatic state transition conditions evaluation handlers. Handler signature: delegate bool AutomaticStateTransitionTriggerMethod( StateEnvironment environment, out int nextState )
Public classAutoTempFile
A class to create and hold the ownership of a temporary file. The temporary file is deleted when the class instance is disposed.
Public classAutoTempFolder
A class to create and hold the ownership of a temporary folder. The temporary folder is deleted when the class instance is disposed.
Public classBackgroundOperation
A background operation, that can be used to run a method in a background task. The method can be run at given intervals. Runs only one method at a time. Will delay the next run, if previous run is still ongoing.
Public classBackgroundOperationManager
A manager to keep track of running background operations and their cancellation.
Public classBackgroundOperationStatus
The status of a background operation at one given moment.
Public classByteExtensions
Byte extensions.
Public classClassAccess Obsolete.
ObjectClass implementation of the StructureAccess base.
Public classEnvironmentBase
An object that contains variables available to a script.
Public classEventHandlerAttribute
Allows methods to be specified as event handler delegates. If these attributes match a certain event environment, the attached method will be executed.
Public classEventHandlerEnvironment
An object that contains variables available to a script.
Public classExtensionMethods
Convenience methods for Vault objects.
Public classFlaggedFeatureHelper
Helper methods for the FlaggedFeatures operations.
Public classJTokenExtensionMethods
Extension / Helper methods for the JToken objects used in JSON Serialization / Deserialization throughout the VAF.
Public classLookupExtensionMethods
Defines convenience methods for the Lookup interface.
Public classLookupsExtensionMethods
Defines convenience methods for the Lookups interface.
Public classMethodSource
Implements method source for the inheriting class.
Public classMFConfigurationAttribute
Attribute for marking the configuration objects.
Public classMFFileHelper
Utility methods for file handling in M-Files.
Public classMFPropertyValuesBuilder
Provides chainable convenience methods for defining a new object's properties. Allows properties passed as aliases, by looking up the correct IDs.
Public classMFSearchBuilder
Provides a chainable SearchConditions wrapper with convenience methods.
Public classMFUtils
Provides some common utility methods for M-Files operations.
Public classNamedACLAccess Obsolete.
NamedACL implementation of the StructureAccess base.
Public classNotFoundException
A generic 'Not found' exception. This is .NET replacement for the E_MFILES_NOT_FOUND error.
Public classObjectAccess Obsolete.
ObjType implementation of the StructureAccess base.
Public classObjectVersionsExtensionMethods
ObjectVersions Extension Methods.
Public classObjIDEqualityComparer
Equality comparer for ObjID objects
Public classObjIDExtensionMethods
Extension methods for the ObjID object.
Public classObjVerChanges
Resolves the property changes between an object, and its previous version.
Public classObjVerEqualityComparer
Equality comparer for ObjVer objects.
Public classObjVerEx
Wraps an ObjVer object and vault, and provides convenience methods.
Public classObjVerExCollectionExtensionMethods
Provides extension methods for collections of ObjVerExs.
Public classObjVerExPermissions Obsolete.
Permissions Accessibility wrapper for an ObjVerEx.
Public classObjVerExtensionMethods
Extension methods for the ObjVer object.
Public classObjVerIDEqualityComparer
Equality comparer for ObjVers based only on ID (not version) Essentially compares their underlying ObjID.
Public classPropertyAccess Obsolete.
PropertyDef implementation of the StructureAccess base.
Public classPropertyAttribute
Allows methods to be specified as event handler delegates. If these attributes match a certain event environment, the attached method will be executed.
Public classPropertyAutomaticNumberingAttribute
Attribute for marking the customized automatic numbering handler methods. Handler signature: delegate TypedValue ValidationMethod( PropertyEnvironment environment )
Public classPropertyCustomValueAttribute
Attribute for marking the custom value calculation handler methods. Handler signature: delegate TypedValue CustomValueMethod( PropertyEnvironment environment )
Public classPropertyEnvironment
An object that contains variables available to a script.
Public classPropertyValueChange
Defines a changed property value between object versions.
Public classPropertyValueExtensionMethods
Provides convenience extension methods for the PropertyValue objects.
Public classPropertyValuesExtensionMethods
Provides convenience extension methods for the PropertyValues collection.
Public classPropertyValueValidationAttribute
Attribute for marking the property value validation handler methods. Handler signature: delegate bool ValidationMethod( PropertyEnvironment environment, out string message )
Public classReferenceTree Obsolete.
Reference Tree Resolution Object.
Public classReferenceTreeMFDynamicIdentifier
Public classReferenceTreeProcessCmd
Static Command Processing Class.
Public classReferenceTreeReferenceTreeBranch
Contains Nested[ Depth ], Tree Branch ReferenceTree Information.
Public classReferenceTreeTreeMap
Public classReferenceTrees Obsolete.
Public classRegistryHelper
Registry helper class originally taken from the, "MFiles.System" namespace
Public classRegKey
Registry key helper class.
Public classRegValue
Registry value helper.
Public classScriptAttributeBase
Common VAF Attribute base class. If these attributes match a certain environment, the attached method will be executed.
Public classSearchConditionsExtender
Convenience methods for SearchConditions objects.
Public classStateActionAttribute
Attribute for marking the state run action handlers. Handler signature: delegate void RunActionMethod( StateEnvironment environment )
Public classStateAttribute
Allows methods to be specified as event handler delegates. If these attributes match a certain event environment, the attached method will be executed.
Public classStateEnvironment
An object that contains variables available to a script.
Public classStatePostConditionsAttribute
Attribute for marking the state post-condition evaluation handlers. Handler signature: delegate bool PostConditionsMethod( StateEnvironment environment, out string message )
Public classStatePreConditionsAttribute
Attribute for marking the state precondition evaluation handlers. Handler signature: delegate bool PreConditionsMethod( StateEnvironment environment, out string message )
Public classStateTransitionAttribute
Allows methods to be specified as event handler delegates. If these attributes match a certain event environment, the attached method will be executed.
Public classStateTransitionEnvironment
An object that contains variables available to a script.
Public classStringExtensions
Provides generic string extensions.
Public classStringsExtensions
Strings collection extensions.
Public classStructureAccess Obsolete.
Base Class : Structure Access : Inherited from by all classes in the Structure Access Family used by the AccessCache.
Public classSysUtils
Provides some common utility methods for system operations.
Public classTranslatableContentExtender
The TranslatableContentExtender static class contains extension methods for the TranslatableContent class.
Public classTypedValueEqualityComparer
Equality comparer for TypedValues objects.
Public classTypedValueExtensionMethods
TypedValue extension methods.
Public classUrlHelper
Helps generate urls to m-files content.
Public classUserAccountEqualityComparer
Equality comparer for UserAccounts objects.
Public classUserGroupEqualityComparer
Equality comparer for UserGroups objects.
Public classVaultExtensionMethodAttribute
The attribute class for extension method implementations.
Public classVaultObjectOperationsExtensionMethods
Vault ObjectOperations Extension Methods.
Structures
Interfaces
  InterfaceDescription
Public interfaceIAccessCache Obsolete.
Accessor Interface.
Public interfaceIEnvironment
The execution environment interface.
Public interfaceIEventHandlerAttribute
Common interface for event handler attributes.
Public interfaceIEventHandlerEnvironment
The event hander
Public interfaceIMethodSource
Interface for accessing methods decorated with the given attribute.
Public interfaceIPropertyAttribute
Common interface for event handler attributes.
Public interfaceIPropertyEnvironment
The property execution environment.
Public interfaceIStateAttribute
Common interface for state handlers attributes.
Public interfaceIStateEnvironment
The state execution environment.
Public interfaceIStateTransitionAttribute
Common interface for state handlers attributes.
Public interfaceIStateTransitionEnvironment
The state execution environment.
Delegates
  DelegateDescription
Public delegateBackgroundOperationOperationEventHandler
An event handler, that takes a background operation.
Enumerations
  EnumerationDescription
Public enumerationBackgroundOperationState
A type for the state of the background operation.
Public enumerationEqualityCompareOptions
Equality compare options.
Public enumerationMFEventFilterOptions
Flags that allow further filtering of event handler delegation.
Public enumerationMFFeatureFlagMaturity
The recognized feature maturity states.
Public enumerationPropertyAttributeAttributeType
The property attribute type enumeration.
Public enumerationPropertyValueChangeType
Indicates the type of property change between versions of an object.
Public enumerationReferenceTreeComplexReference
The Complex Placeholder - Available Triggers that can perform logical actions against an object in order to retrieve an Object. These Items Modify the Base Context Object.
Public enumerationReferenceTreePropertyReference
The Simple Reference - Available Triggers that can perform a logical actions against an object in order to retrieve an object or lookup reference. These Items Modify the Base Context Object.
Public enumerationReferenceTreeResolutionType
Specifies the value type to resolve using a ReferenceTree.
Public enumerationReferenceTreeSimplePlaceholder
The Simple Placeholder - Available Triggers that can perform logical actions against an object in order to retrieve a string value. These Items Do Not Modify the Base Context Object.
Public enumerationRegistryHelperRegistryAccessFlags
Registry access flags.
Public enumerationRegistryHelperRegOption
Registry option enum.
Public enumerationRegistryHelperRegResult
Result of registry action.
Public enumerationRegistryHelperRegSAM
Registry security access mask. IE, permissions flags.
Public enumerationStateAttributeAttributeType
The state attribute type enumeration.
Public enumerationUrlTargetPlatform
The various platforms MFiles Urls can target.