DocumentFinderGetDocumentsWithFields Method

An alternate search method to GetDocumentsBySnapshot that does not use view settings to determine the list of columns. The caller can specify a list of fields to return directly in the method call.

Definition

Namespace: FileHold.LibraryManager
Assembly: FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.2.0.0
C#
[WebMethodAttribute(Description = "Finds documents which fulfills specified search criteria using given array of field definitions.")]
[XmlIncludeAttribute(typeof(DropdownFieldChoice[]))]
[XmlIncludeAttribute(typeof(DrilldownFieldChoice[]))]
[XmlIncludeAttribute(typeof(int[]))]
public ColumnsWithValues GetDocumentsWithFields(
	Guid prevSnapshotId,
	ref Guid snapshotId,
	string viewContainerType,
	FieldDefinition[] fieldDefinitions,
	SearchCriteria searchCriteria,
	ColumnSelector[] sortOrder,
	int firstRowIndex,
	int pageSize
)

Parameters

prevSnapshotId  Guid
snapshotId  Guid
viewContainerType  String
fieldDefinitions  FieldDefinition
searchCriteria  SearchCriteria
sortOrder  ColumnSelector
firstRowIndex  Int32
pageSize  Int32

Return Value

ColumnsWithValues

Remarks

The viewContainerType parameter is only used for the search performance log; it can be set to an arbitrary three character value. In the FieldDefinition objects passed to this method, the Type and either MetadataVersionId or IsSystem and SystemFieldId properties should be set. Other parameters are the same as for the GetDocumentsBySnapshot() method.

See Also