SnapshotSelection Class

Class used to describe which documents are selected in a single snapshot. It is possilbe to select some or all documents in the snapshot, or to select all documents exluding some unselected ones.

Definition

Namespace: FileHold.LibraryManager
Assembly: FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.2.0.0
C#
public class SnapshotSelection
Inheritance
Object    SnapshotSelection

Constructors

SnapshotSelectionInitializes a new instance of the SnapshotSelection class

Properties

ContainsExcluded If false, DocumentIdList and MetadataVersionIdList contain information about documents that are included in the selection. If true, these lists contain information about documents that are excluded, and all remaining documents in the snapshot are included in the selection.
DocumentIdList The list of document IDs that are included or excluded from the selection depending on ContainsExcluded.
MetadataVersionIdList The list of metadata version IDs that are included or excluded from the selection depending on ContainsExcluded. It must contain the same number of values as the DocumentIdList, and the IDs at the same possition must correspond to each other in both lists.
SnapshotId The ID of the search snapshot containing selected documents

Extension Methods

Convert Converts an object to a specified type.
(Defined by ObjectExtension)
ConvertT
(Defined by ObjectExtension)
ConvertT Converts an object to a specified type.
(Defined by ObjectExtension)
ToJson
(Defined by ObjectExtension)
TryConvert
(Defined by ObjectExtension)
TryConvert
(Defined by ObjectExtension)
TryConvert
(Defined by ObjectExtension)
TryConvert
(Defined by ObjectExtension)
TryConvert
(Defined by ObjectExtension)
TryConvert
(Defined by ObjectExtension)
TryConvert Attempts to convert an object to a specified type.
(Defined by ObjectExtension)
TryConvertT
(Defined by ObjectExtension)
TryConvertT
(Defined by ObjectExtension)
TryConvertT
(Defined by ObjectExtension)
TryConvertT
(Defined by ObjectExtension)
TryConvertT
(Defined by ObjectExtension)
TryConvertT
(Defined by ObjectExtension)
TryConvertT Attempts to convert an object to a specified type.
(Defined by ObjectExtension)

See Also