Click or drag to resize

MFPropertyValuesBuilder Class

Provides chainable convenience methods for defining a new object's properties. Allows properties passed as aliases, by looking up the correct IDs.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.CommonMFPropertyValuesBuilder

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

The MFPropertyValuesBuilder type exposes the following members.

Constructors
  NameDescription
Public methodMFPropertyValuesBuilder(Vault)
Creates a new instance with an empty PropertyValues collection.
Public methodMFPropertyValuesBuilder(Vault, PropertyValues)
Creates a new instance that wraps a copy of the passed property values.
Top
Properties
  NameDescription
Public propertyHumanReadable
A human readable string of the set property values.
Public propertyValues
The propertyValues that this object wraps.
Public propertyVault
The vault to which the property values will be saved.
Top
Methods
  NameDescription
Public methodAdd(PropertyValue)
Adds a property value to the list.
Public methodAdd(Object, TypedValue)
Adds a property value to the list.
Public methodAdd(MFIdentifier, TypedValue)
Adds a property value to the list.
Public methodAdd(Object, MFDataType, Object)
Adds a property value to the list.
Public methodAdd(MFIdentifier, MFDataType, Object)
Adds a property value to the list.
Public methodAddLookup(Object, Object)
Adds a lookup to the passed property value. Creating it if it doesn't already exist.
Public methodAddLookup(MFIdentifier, MFIdentifier)
Adds a lookup to the passed property value. Creating it if it doesn't already exist.
Public methodAddLookup(Object, ObjVer, Boolean)
Adds a lookup to the passed property value. Creating it if it doesn't already exist.
Public methodAddLookup(MFIdentifier, ObjVer, Boolean)
Adds a lookup to the passed property value. Creating it if it doesn't already exist.
Public methodCopyFrom(PropertyValues, MFIdentifier)
Copies a set of property values to this set.
Public methodCopyFrom(PropertyValues, Object)
Copies a set of property values to this set.
Public methodCopyFrom(ObjVerEx, MFIdentifier)
Copies a set of property values from the passed object to this set of property values.
Public methodCopyFrom(ObjVerEx, Object)
Copies a set of property values from the passed object to this set of property values.
Public methodRemove(Object)
Removes the specified property value.
Public methodRemove(MFIdentifier)
Removes the specified property value.
Public methodRemoveLookup(Object, Object)
Removes a lookup value from a particular property, if set.
Public methodRemoveLookup(MFIdentifier, MFIdentifier)
Removes a lookup value from a particular property, if set.
Public methodRemoveSystemProperties
Removes all the built-in properties. Properties to remove: MFBuiltInPropertyDefCreated, MFBuiltInPropertyDefCreatedBy, MFBuiltInPropertyDefLastModified, MFBuiltInPropertyDefLastModifiedBy, MFBuiltInPropertyDefStatusChanged, MFBuiltInPropertyDefSizeOnServerThisVersion, MFBuiltInPropertyDefSizeOnServerAllVersions, MFBuiltInPropertyDefStateEntered, MFBuiltInPropertyDefObjectChanged
Public methodSetClass(Object)
Sets the class property.
Public methodSetClass(MFIdentifier)
Sets the class property.
Public methodSetLookup(Object, Object)
Sets a property to contain one lookup value. Creating it if it doesn't already exist. Works on both SSLU and MSLU.
Public methodSetLookup(MFIdentifier, MFIdentifier)
Sets a property to contain one lookup value. Creating it if it doesn't already exist. Works on both SSLU and MSLU.
Public methodSetLookup(Object, ObjVer, Boolean)
Sets a property to contain one lookup value. Creating it if it doesn't already exist. Works on both SSLU and MSLU, and optionally allows the specific version to be specified.
Public methodSetLookup(Object, Int32, Int32)
Sets a property to contain one lookup value. Creating it if it doesn't already exist. Works on both SSLU and MSLU, and optionally allows the specific version to be specified.
Public methodSetLookup(MFIdentifier, ObjVer, Boolean)
Sets a property to contain one lookup value. Creating it if it doesn't already exist. Works on both SSLU and MSLU, and optionally allows the specific version to be specified.
Public methodSetLookup(MFIdentifier, Int32, Int32)
Sets a property to contain one lookup value. Creating it if it doesn't already exist. Works on both SSLU and MSLU, and optionally allows the specific version to be specified.
Public methodSetSFD
Sets the SingleFileDocument property.
Public methodSetTitle(String, MFIdentifier)
Sets the default title property, and also optionally the custom one defined in a class.
Public methodSetTitle(String, Object)
Sets the default title property, and also optionally the custom one defined in a class.
Public methodSetWorkflowState(Object, Object)
Sets the workflow and state properties.
Public methodSetWorkflowState(MFIdentifier, MFIdentifier)
Sets the workflow and state properties.
Top
See Also