Click or drag to resize

ObjVerEx Class

Wraps an ObjVer object and vault, and provides convenience methods.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.CommonObjVerEx

Namespace:  MFiles.VAF.Common
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.1.0.1 (2.1.0.1)
Syntax
C#
public class ObjVerEx : IEquatable<ObjVerEx>

The ObjVerEx type exposes the following members.

Constructors
  NameDescription
Public methodObjVerEx
Default constructor which is used in ObjVerEx spoofing.
Public methodObjVerEx(Vault, Lookup)
Creates a new ObjVerEx Object from a Lookup.
Public methodObjVerEx(Vault, ObjectVersion)
Creates a new ObjVerEx Object from an ObjectVersion.
Public methodObjVerEx(Vault, ObjectVersionAndProperties)
Creates a new ObjVerEx Object from an ObjectVersionAndProperties object.
Public methodObjVerEx(Vault, ObjVer)
Creates a new ObjVerEx Object from an ObjVer.
Public methodObjVerEx(Vault, ObjectVersion, PropertyValues)
Creates a new ObjVerEx Object from an ObjectVersion.
Public methodObjVerEx(Vault, Int32, Int32, Int32)
Creates a new ObjVerEx Object.
Top
Properties
  NameDescription
Public propertyACL
Returns this object version's ACL.
Public propertyCanModify
Determines if this version can be modified. Specifically determines if this is the latest version, and is not checked out, or is checked out to this user.
Public propertyClass
Returns the object's class ID.
Public propertyExists
Determines if the object exists in the vault (not deleted, destroyed, nor unresolvable). Tries to be more efficient and safe than calling IsDeleted and IsDestroyed separately.
Public propertyHistory
Retrieves the history of this object, with each version wrapped as an ObjVerEx object. Also ensures the order of the object is from newest to oldest. Includes all versions, including the called instance.
Public propertyID
Returns the ID of this object.
Public propertyInfo
Returns the version information associated with this ObjVer.
Public propertyIsDeleted
Indicates whether the object is deleted.
Public propertyIsDestroyed
Indicates whether the object version has been destroyed.
Public propertyIsEnteringState
Determines if the object is entering the current state... IE. it is unique from the previous state.
Public propertyIsFirstVersion
Determines whether this object version is the first of the object.
Public propertyIsLatestVersion
Returns a boolean indicating whether the object is of the latest version.
Public propertyIsLoaded
Indicates whether both the Info (ObjectVersion) and Properties have been loaded in this wrapper.
Public propertyIsPromoted
Indicates whether this object is promoted from external source.
Public propertyIsRecord
Indicates whether this object is a M-Files Record.
Public propertyIsTemplate
Indicates whether this object is an M-Files template.
Public propertyObjID
Returns the ObjID of this object.
Public propertyObjVer
Returns the ObjVer of this object.
Public propertyPermissions
Returns this object version's permissions.
Public propertyPreviousVersion
The previous version of this object. Will fetch the properties and info of the previous version, as well.
Public propertyProperties
Returns the properties associated with this ObjVer.
Public propertySpecificVersion
Returns whether specific version information is available, or if this ObjVerEx refers to the latest. Note: Accessing the Version property will automatically lookup the latest version.
Public propertyState
Returns the object's state. -1 if not set.
Public propertyTitle
The title of this object version.
Public propertyType
Returns the Type of this object.
Public propertyVault
Returns the vault in which this object resides.
Public propertyVersion
Returns the Version of this object.
Public propertyVersionComment
The version comment.
Public propertyWorkflow
Returns the object's workflow. -1 if not set.
Top
Methods
  NameDescription
Public methodAddLookup(Object, Object) Obsolete.
Adds a lookup item to the specified property in the PropertyValue collection. Adding the property to the object if it doesn't already exist.
Public methodAddLookup(MFIdentifier, MFIdentifier)
Adds a lookup item to the specified property in the PropertyValue collection. Adding the property to the object if it doesn't already exist.
Public methodAddLookup(Object, ObjVer, Boolean) Obsolete.
Adds a lookup to the passed PropertyValue. Creating it if it doesn't already exist.
Public methodAddLookup(MFIdentifier, ObjVer, Boolean)
Adds a lookup to the passed PropertyValue. Creating it if it doesn't already exist.
Public methodAssertCheckedOut
Asserts that the object is checked out. Throws an exception if it isn't.
Public methodCanCurrentUserDelete
Indicates whether the passed user can delete this object version.
Public methodCanCurrentUserEdit
Indicates whether the passed user can edit this object version.
Public methodCanCurrentUserRead
Indicates whether the passed user can see the object.
Public methodCheckIn
Checks in the object.
Public methodCheckOut
Checks out the object.
Public methodDelete
Deletes the underlying M-Files object.
Public methodDestroy
Destroys the underlying M-Files object.
Public methodEndRequireCheckedOut
Checks in the object if it was previously checked out by StartRequireCheckedOut().
Public methodStatic memberEnsureAllLoaded
Loads or reloads the Info (ObjectVersion) and Properties of multiple ObjVerExs with a single server call.
Public methodEnsureLoaded
Fetches the object data and properties from server if they are not fetched yet.
Public methodEquals(Object)
Overrides generic equals function.
(Overrides ObjectEquals(Object).)
Public methodEquals(ObjVerEx)
Overrides type specific equals function.
Public methodEquals(ObjVerEx, Boolean)
Compares to the other ObjVerEx with the option of leaving the version information out of the comparison.
Public methodExpandPlaceholders
Expands a placeholder template text with this object as the context.
Public methodExpandPlaceholderText
Returns a string with M-Files placeholders replaced with values. Supports ReferenceTree Syntax.
Public methodExpandReferenceTree
Returns a list of ObjVerEx from M-Files placeholders referencing Real Objects. Supports: id number and {alias} referencing.
Public methodExpandReferenceTreesAsLookup
Returns a ObjVerEx from an M-Files placeholder. Supports: id number and {alias} referencing.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodForceUndoCheckout
Forces the undo CheckOut operation.
Public methodGetAllDirectReferences(Object) Obsolete.
Gets all the direct references found in the given lookup-based property.
Public methodGetAllDirectReferences(MFIdentifier)
Gets all the direct references found in the given lookup-based property.
Public methodGetDirectReference(Object) Obsolete.
Returns the first non-deleted and non-destroyed object reference found in the given lookup based property.
Public methodGetDirectReference(MFIdentifier)
Returns the first non-deleted and non-destroyed object reference found in the given lookup based property.
Public methodGetDirectReferences(Object, Boolean, Boolean) Obsolete.
Gets all the direct references found in the given lookup-based property.
Public methodGetDirectReferences(MFIdentifier, Boolean, Boolean)
Gets all the direct references found in the given lookup-based property.
Public methodGetHashCode
Overrides hash code method for efficient use in HashSets.
(Overrides ObjectGetHashCode.)
Public methodGetIndirectReferences
Returns a set of objects that reference this one.
Public methodGetLookupID(Object) Obsolete.
Returns the lookup id of a Lookup propertyValue in the PropertyValue collection.
Public methodGetLookupID(MFIdentifier)
Returns the lookup id of a Lookup propertyValue in the PropertyValue collection.
Public methodGetLookups(Object) Obsolete.
Returns the property's value as a lookups collection.
Public methodGetLookups(MFIdentifier)
Returns the property's value as a lookups collection.
Public methodGetLookupsFromProperty(Object) Obsolete.
Gets all the object lookups from a lookup based property.
Public methodGetLookupsFromProperty(MFIdentifier)
Gets all the object lookups from a lookup based property.
Public methodGetProperty(Object) Obsolete.
Returns the specified object property if found.
Public methodGetProperty(MFIdentifier)
Returns the specified object property if found.
Public methodGetPropertyText(Object) Obsolete.
Returns the text representation of the property value.
Public methodGetPropertyText(MFIdentifier)
Returns the text representation of the property value.
Public methodGetPropertyText(ReferenceTreeMFDynamicIdentifier)
Returns the text representation of the property value.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasClass(Object) Obsolete.
Checks if the passed class reference matches this object.
Public methodHasClass(MFIdentifier)
Checks if the passed class reference matches this object.
Public methodHasLookup(Object, Object) Obsolete.
Determines if the referenced item is present in the referenced property.
Public methodHasLookup(MFIdentifier, MFIdentifier)
Determines if the referenced item is present in the referenced property.
Public methodHasMatchingValues(PropertyValues, MFIdentifier)
Indicates whether the specified properties in the passed PropertyValue collection have values that match in this object. If any of the property values cannot be resolved for either object there is never a match. When comparing lookups, versions in a lookup and the order of the lookups are meaningful.
Public methodHasMatchingValues(PropertyValues, Object) Obsolete.
Indicates whether the specified properties in the passed PropertyValue collection have values that match in this object. If any of the property values cannot be resolved for either object there is never a match. When comparing lookups, versions in a lookup and the order of the lookups are meaningful.
Public methodHasProperty(Object) Obsolete.
Checks whether an object has a specific property.
Public methodHasProperty(MFIdentifier)
Checks whether an object has a specific property.
Public methodHasPropertyFlag(Object, Boolean) Obsolete.
Checks whether an object has a specific boolean property and it is true.
Public methodHasPropertyFlag(MFIdentifier, Boolean)
Checks whether an object has a specific boolean property and it is true.
Public methodHasValue(Object) Obsolete.
Checks whether an object has a specific property and it's value is not null.
Public methodHasValue(MFIdentifier)
Checks whether an object has a specific property and it's value is not null.
Public methodIsType(Object) Obsolete.
Checks if the passed object type reference matches this object.
Public methodIsType(MFIdentifier)
Checks if the passed object type reference matches this object.
Public methodStatic memberLatest(Vault, ObjID)
Returns an ObjVerEx object pointing to the latest version of the M-Files object.
Public methodStatic memberLatest(Vault, Guid)
Returns an ObjVerEx object pointing to the latest version of the M-Files object.
Public methodLoadFullHistory
Loads the objects full history enusuring each version has its properties and history loaded and is properly previous-version chained.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMFilesURL
Generates an M-Files URL via the given params.
Public methodStatic memberParse
Loads an ObjVerEx object based on a ObjID or ObjVer string representation
Public methodRefresh
Updates the ObjVerEx to the latest version on the server.
Public methodStatic memberRefreshAll
Efficiently refreshes multiple objVerExs at one time.
Public methodRelationships
Returns related object references.
Public methodRelationshipsAsLookups
Returns related object references as Lookups.
Public methodRemoveLookup(Object, Object) Obsolete.
Removes a lookup item from the specified property in the PropertyValue collection.
Public methodRemoveLookup(MFIdentifier, MFIdentifier)
Removes a lookup item from the specified property in the PropertyValue collection.
Public methodRemoveProperty(Object) Obsolete.
Removes the specified PropertyValue from the PropertyValue collection.
Public methodRemoveProperty(MFIdentifier)
Removes the specified PropertyValue from the PropertyValue collection.
Public methodReplaceFiles
Replaces the object's existing files with the ones passed. Does not change the objects single file value.
Public methodRollback
Rolls back the object to a previous version, adding optional comment.
Public methodSaveProperties
Saves all properties as they currently are set, or the ones passed.
Public methodSaveProperty(PropertyValue)
Saves the specific property immediately.
Public methodSaveProperty(Object, MFDataType, Object) Obsolete.
Saves the specific property immediately.
Public methodSaveProperty(MFIdentifier, MFDataType, Object)
Saves the specific property immediately.
Public methodSetCreatedBy
Updates the created by property for the object. (Assumes the object is checked out)
Public methodSetLookup(Object, Object) Obsolete.
Sets the passed lookup item as the only value of specified property in the PropertyValue collection.
Public methodSetLookup(MFIdentifier, MFIdentifier)
Sets the passed lookup item as the only value of specified property in the PropertyValue collection.
Public methodSetModifiedBy
Updates the last modified by property for the object. (Assumes the object is checked out)
Public methodSetProperty(PropertyValue)
Adds or updates the specified PropertyValue in the PropertyValue collection.
Public methodSetProperty(Object, MFDataType, Object) Obsolete.
Adds or updates the specified PropertyValue in the PropertyValue collection.
Public methodSetProperty(MFIdentifier, MFDataType, Object)
Adds or updates the specified PropertyValue in the PropertyValue collection.
Public methodSetWorkflowState(Object, Object) Obsolete.
Sets workflow and state values for the object.
Public methodSetWorkflowState(MFIdentifier, MFIdentifier)
Sets workflow and state values for the object.
Public methodSetWorkflowStateTransition(Object, String) Obsolete.
Sets the workflow state transition for the object. Requires that the object already has a workflow.
Public methodSetWorkflowStateTransition(MFIdentifier, String)
Sets the workflow state transition for the object. Requires that the object already has a workflow.
Public methodStartRequireCheckedOut
Checks out the object if it isn't already. Should be paired with the EndRequireCheckedOut() call when an operation requiring the object to be checked out is complete. The return value of this method should be the first parameter of EndRequireCheckedOut().
Public methodToLookup
Returns a Lookup representation of this ObjVerEx.
Public methodToString
Returns a string representation of the object version.
(Overrides ObjectToString.)
Public methodToString(Boolean)
Returns a string representation of the object version.
Public methodTryGetProperty(Object, PropertyValue) Obsolete.
Attempts to retrieve the specified PropertyValue in the PropertyValue collection.
Public methodTryGetProperty(MFIdentifier, PropertyValue)
Attempts to retrieve the specified PropertyValue in the PropertyValue collection.
Public methodStatic memberTryParse
Tries to loads an ObjVerEx object based on a ObjID or ObjVer string representation
Top
See Also