Click or drag to resize

MFSearchBuilder Class

Provides a chainable SearchConditions wrapper with convenience methods.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.CommonMFSearchBuilder

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

The MFSearchBuilder type exposes the following members.

Constructors
  NameDescription
Public methodMFSearchBuilder(Vault)
Creates a new instance wrapping an empty SearchConditions object.
Public methodMFSearchBuilder(Vault, SearchConditions)
Creates a new instance wrapping a copy of the passed SearchConditions.
Public methodMFSearchBuilder(Vault, String)
Creates a new instance wrapping a SearchConditions created from the passed string.
Top
Properties
  NameDescription
Public propertyConditions
The SearchConditions that this object wraps.
Public propertyFilterString
Quick access to a string version of the search conditions. Primarily for debugging.
Public propertyHumanReadable
A human readable string representing the set conditions.
Public propertyVault
The vault to which these search conditions apply.
Top
Methods
  NameDescription
Public methodClass(Object)
Creates a condition for a specific class.
Public methodClass(MFIdentifier)
Creates a condition for a specific class.
Public methodDeleted
Creates a deleted condition.
Public methodFind
Executes an object search in the vault with the current conditions.
Public methodFindEx
Executes an object search in the vault with the current conditions, wrapping each result as an ObjVerEx object.
Public methodFindOneEx
Executes an object search in the vault with the current conditions, and returning the first result wrapped as an ObjVerEx object.
Public methodNotObject(Object)
Creates a condition that excludes an object by it's ID.
Public methodNotObject(MFIdentifier)
Creates a condition that excludes an object by it's ID.
Public methodObject(Object)
Add an ObjectID condition.
Public methodObject(MFIdentifier)
Add an ObjectID condition.
Public methodObjType(Object)
Adds an ObjectType condition.
Public methodObjType(MFIdentifier)
Adds an ObjectType condition.
Public methodProperty(Object, TypedValue)
Adds a property based, 'equal' search condition.
Public methodProperty(MFIdentifier, TypedValue)
Adds a property based, 'equal' search condition.
Public methodProperty(Object, MFDataType, MFIdentifier)
Adds a property based, 'equal' search condition.
Public methodProperty(Object, MFDataType, Object)
Adds a property based, 'equal' search condition.
Public methodProperty(MFIdentifier, MFDataType, Object)
Adds a property based, 'equal' search condition.
Public methodPropertyNot(Object, MFDataType, Object)
Adds a property based, 'not equal' search condition.
Public methodPropertyNot(MFIdentifier, MFDataType, Object)
Adds a property based, 'not equal' search condition.
Public methodPropertyNotMissing(Object)
Adds a property based search condition to check if the property value is not missing.
Public methodPropertyNotMissing(MFIdentifier)
Adds a property based search condition to check if the property value is not missing.
Public methodRecord
Creates a condition for the record property.
Public methodReferences(Object, ObjVer)
Sets a reverse reference search condition that targets an exact object version with a property
Public methodReferences(Object, Object)
Sets a reverse reference search condition. (Result.Property = item.ID)
Public methodReferences(MFIdentifier, MFIdentifier)
Sets a reverse reference search condition. (Result.Property = item.ID)
Public methodReferences(MFIdentifier, ObjVer)
Sets a reverse reference search condition that targets an exact object version with a property
Public methodReferencesExactVersion
Sets a reverse reference search condition that targets an exact object version with a property
Public methodReferencesExactVersionWithAnyProperty
Sets a reverse reference search condition that targets an exact object version with any property.
Public methodReferencesWithAnyProperty(ObjID)
Sets an any property reference search condition.
Public methodReferencesWithAnyProperty(ObjVer)
Sets a reverse reference search condition that targets an exact object version with any property.
Public methodReferencesWithAnyProperty(Object)
Sets an any property reference search condition.
Public methodReferencesWithAnyProperty(MFIdentifier, MFIdentifier)
Sets an any property reference search condition.
Public methodStatus
Adds a status based, 'equal' search condition.
Public methodStatusNot
Adds a status based, 'not equal' search condition.
Top
See Also