Click or drag to resize

SearchType Enumeration

List of all condition types. Required operators and operands are described for each type in format (S-FM-100): allowed operator(s) / type of parameters (number of parameters is defined by the operator)

Namespace:  FileHold.LibraryManager
Assembly:  FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.0.0.0
Syntax
C#
public enum SearchType
Members
  Member nameValueDescription
AnywhereInFileHold0 Search for any user defined metadata field, document name or file contents using Full Text Search. Contains / String
FullTextSearch1 Obsolete. Use AnywhereInFileHold instead.
DocumentName2 Equal, Contains / String. Contains operator uses Full Text Search index.
FolderName3 Equal, Contains / String Contains operator uses simple SQL search without Full Text Search index.
OwnedBy4 Equal, InList
ApprovedBy5 Equal, InList
DateLastModified6 any / DateTime
DateCreated7 any / DateTime
DateApproved8 any / DateTime
FolderId9 Equal / int (id)
CabinetId10 Equal / int (id)
DrawerId11 Equal / int (id)
CategoryId12 Equal / int (id)
DrawerAndFolderGroup13 Equal / 2 operands required: int (DrawerId) + int (FolderGroupId) Note exception in description of operands.
SchemaFieldValue14 This type of search requires providing FieldDefinitionId (int) as the first operand. First is int with FieldDefinitionId. Operand types from 2. to n. depend on FileHold data type of the field identified by FieldDefinitionId. Operators also depend of field data type. text -> Equal / String; IsBlank (without operands) number, currency -> any / number?; IsBlank (without operands) date -> any / DateTime; IsBlank (without operands) checkbox -> Equal, bool drop down menu -> Equal, InList / int (item id); IsBlank (without operands) Note exception in description of operands.
SchemaId15 Equal, InList / int (schema id)
IncludeArchive16 if not present assume false Equal / bool
IncludeDeleted17 if not present assume false Equal / bool
OnlyDeleted18 Equal / bool (default is false, you must also set IncludeDeleted to true for this search type to work)
LogAction19 Equal, InList / int (action id, FileHold.Common.ActionType enumeration)
LogEntryDate20 any / DateTime
LogActionPerformer21 Equal, InList / Guid (Guid.Empty means current user)
FileType22 Equal, InList / int (extension id as returned by the GetFileExtensions() method of Document Manager)
DocumentId23 Equal / int (document id)
DocumentVersionId24 Equal, InList / int (document version id)
MetadataVersionId25 Equal / int (metadata version id)
ScanningBatchId26 Obsolete. Do not use.
OnlyLastVersion27 Equal / bool (only last binary version - default is true), bool (only last metadata version - default is true)
VirtualFolderId28 Equal / int (virtual folder id)
Tray29 Equal / bool
IsStarredByUser30 Equal / bool
IsCheckedOutByUser31 Equal, InList / int (user)
OnlyWhenCabinetOwner32 Equal / bool
ApprovalStatus33 Equal / int (ApprovalStatus Enumeration)
WithAlert34 Equal / bool
WithReminder35 Equal / bool
DateAccessed36 Allows for searches like 'recently accessed' any / DateTime
IsLinkedWithDocument37 Equal / int (document id of document for which linked document should be returned)
IncludeShortcuts38 if not present assume true Equal / bool
OnlyShortcuts39 if not present assume false Equal / bool
ReturnLastForBinaryVersion40 Return last metadata version for each matching document version. Used for searching for historical metadata values. if not present assume false Equal / bool
FileSize41 any / long
IncludeInvisible42 if not present assume true Equal / bool
Location43 Wrap a FolderId, DrawerId, DrawerAndFolderGroup or CabinetId condition. Equal / SearchType, params
SchemaWithField44 Equal / int, int (schemaId, fieldId)
IsAssociatedWithActiveTask45 operator is not taken into consideration; operands are not needed
IsAssociatedWithWorkflow46 operator is not taken into consideration; operands are not needed WARNING: must be used with ReturnLastForBinaryVersion condition set to true
HasMarkup47 Equal / bool
DocumentFormat48 Equal / DocumentSchemaType
DocumentNumber49 Equal / string
VersionNumber50 Equal / string
SmartFolderId51 For internal use only
HasLink52 Equal / bool
IsFavorite53 Equal / bool
ScheduledEventDate54 any / (int) documentSchemaId, (int) event type, int for Before/After operator or DateTime for other operators
CheckedOutStatus55 Equal / bool ( (false)CheckedIn / (true)CheckedOut)
CheckedOutBy56 Equal, InList / (int) user id
AllReminders57 has reminder with given initial date any / DateTime
ActiveTaskDueDate58 has active task with given due date any / DateTime
CompletedTaskDate59 has completed task with given completed date any / DateTime
WorkflowInstance60 is associated with specific workflow instance Equal / guid
ScheduledEventDateId61 any / (int) event id, int for Before/After operator or DateTime for other operators
ReviewStatus62 Equal / int (ReviewStatus enum)
DateReviewed63 any / DateTime
NotNotifiedScheduledEventDateId64 any / (int) event id, int for Before/After operator or DateTime for other operators
DtSearchFileOnly65 Search in file content using dtSearch. Contains / String
DtSearchMetadataOnly66 Search in metadata content using dtSearch. Contains / String
DtSearchRawQuery67 Search that send user query directly to dtSearch. Contains / String
EmptySnapshot68 Create an empty snapshot Equals / bool
See Also