MFSearchBuilder Class

Provides a chainable SearchConditions wrapper with convenience methods.

Definition

Namespace: MFiles.VAF.Common
Assembly: MFiles.VAF (in MFiles.VAF.dll) Version: 24.1.706.1
C#
public class MFSearchBuilder
Inheritance
Object    MFSearchBuilder

Constructors

MFSearchBuilder(Vault) Creates a new instance wrapping an empty SearchConditions object.
MFSearchBuilder(Vault, SearchConditions) Creates a new instance wrapping a copy of the passed SearchConditions.
MFSearchBuilder(Vault, String) Creates a new instance wrapping a SearchConditions created from the passed string.

Properties

Conditions The SearchConditions that this object wraps.
FilterString Quick access to a string version of the search conditions. Primarily for debugging.
HumanReadable A human readable string representing the set conditions.
Vault The vault to which these search conditions apply.

Methods

Class(MFIdentifier) Creates a condition for a specific class.
Class(Object) Creates a condition for a specific class.
Deleted Creates a deleted condition.
Find Executes an object search in the vault with the current conditions.
FindEx Executes an object search in the vault with the current conditions, wrapping each result as an ObjVerEx object.
FindOneEx Executes an object search in the vault with the current conditions, and returning the first result wrapped as an ObjVerEx object.
NotObject(MFIdentifier) Creates a condition that excludes an object by it's ID.
NotObject(Object) Creates a condition that excludes an object by it's ID.
Object(MFIdentifier) Add an ObjectID condition.
Object(Object) Add an ObjectID condition.
ObjType(MFIdentifier) Adds an ObjectType condition.
ObjType(Object) Adds an ObjectType condition.
Property(MFIdentifier, TypedValue) Adds a property based, 'equal' search condition.
Property(Object, TypedValue) Adds a property based, 'equal' search condition.
Property(MFIdentifier, MFDataType, Object) Adds a property based, 'equal' search condition.
Property(Object, MFDataType, MFIdentifier) Adds a property based, 'equal' search condition.
Property(Object, MFDataType, Object) Adds a property based, 'equal' search condition.
PropertyNot(MFIdentifier, MFDataType, Object) Adds a property based, 'not equal' search condition.
PropertyNot(Object, MFDataType, Object) Adds a property based, 'not equal' search condition.
PropertyNotMissing(MFIdentifier) Adds a property based search condition to check if the property value is not missing.
PropertyNotMissing(Object) Adds a property based search condition to check if the property value is not missing.
Record Creates a condition for the record property.
References(MFIdentifier, MFIdentifier) Sets a reverse reference search condition. (Result.Property = item.ID)
References(MFIdentifier, ObjVer) Sets a reverse reference search condition that targets an exact object version with a property
References(Object, ObjVer) Sets a reverse reference search condition that targets an exact object version with a property
References(Object, Object) Sets a reverse reference search condition. (Result.Property = item.ID)
ReferencesExactVersion Sets a reverse reference search condition that targets an exact object version with a property
ReferencesExactVersionWithAnyProperty Sets a reverse reference search condition that targets an exact object version with any property.
ReferencesWithAnyProperty(Object) Sets an any property reference search condition.
ReferencesWithAnyProperty(ObjID) Sets an any property reference search condition.
ReferencesWithAnyProperty(ObjVer) Sets a reverse reference search condition that targets an exact object version with any property.
ReferencesWithAnyProperty(MFIdentifier, MFIdentifier) Sets an any property reference search condition.
Status Adds a status based, 'equal' search condition.
StatusNot Adds a status based, 'not equal' search condition.

See Also