FileHold 17.0 API Documentation
FileHold 17.0 API Reference
FileHold.LibraryManager
DocumentManager Class
DocumentManager Methods
AddAssembleDocumentsJob Method
AddDocument Method
AddDocumentInfo Method
AddDocumentLinks Method
AddDocumentWithAutoFiling Method
AddLinks Method
AddMoveFilesJob Method
AddRemoveFavourites Method
AddShortcut Method
AddSnapshotSelection Method
AddToFavourites Method
AddUsageLogEntry Method
AddUsageLogEntryForDocument Method
AddUsageLogEntryWithDetails Method
Archive Method
ArchiveDocumentData Method
ArchiveDocuments Method
ArchiveSearchCriteria Method
CanCheckOutDocumentsInSelection Method
ChangeDocumentOwner Method
ChangeDocumentsOwner Method
ChangeDocumentType Method
ChangeType Method
ChangeVersionNumber Method
CheckAccess Method
CheckAccessToDocumentMetadataVersions Method
CheckAccessToDocumentsAndShortcuts Method
CheckAccessToDocumentVersions Method
CheckAllCanChangeType Method
CheckAllCanConvertToElectronic Method
CheckAllCanUnArchive Method
CheckDocumentsInWorkflow Method
CheckDocumentType Method
CheckIn Method
CheckInDocument Method
CheckInDocumentsWithNoChanges Method
CheckNewOwnerPermissons Method
CheckOut Method
CheckOutDocuments Method
CheckSelectionContent Method
CheckSelectionDeleted Method
CheckSelectionDocumentNumber Method
CheckSelectionDocumentType Method
CheckSelectionLocation Method
CheckSelectionSchemaType Method
CheckShortcutsExist Method
CleanUpRemovedDocuments Method
ConvertToElectronic Method
ConvertToOffline Method
ConvertToOfflineById Method
ConvertUtcToLocalDates Method
Copy Method
CopyAllDocumentsInFolder Method
CopyAndEdit Method
CopyDocument Method
CopyDocuments Method
CopySelection Method
CopyShortcuts Method
CreateArchiveFolder Method
CreateLocation Method
CreateSelection Method
CreateSelectionForMetadataVersionIds Method
CreateWorkingDocumentSelection Method
DeleteDocuments Method
FormatValue Method
GenerateDocumentNumber Method
GetActiveEasyViewWorkflowDocumentsFromSelection Method
GetActiveWorkflowDocumentsForCheckOut Method
GetActiveWorkflowDocumentsFromSelection Method
GetAssembleConfiguration Method
GetAssembleDocumentsForCourierAction Method
GetAssembleDocumentsForViewAction Method
GetAssembleDocumentsForWorkflowAction Method
GetAssembleDocumentsJob Method
GetAutoTaggingForDocument Method
GetAutoTaggingForFolders Method
GetAutoTaggingForSelection Method
GetBinaryVersionsFromSelection Method
GetCheckedOutDocumentsFromSelection Method
GetDocumentFileMetadata Method
GetDocumentFileMetadataByDocumentVersionId Method
GetDocumentFolder Method
GetDocumentFolderAndName Method
GetDocumentId Method
GetDocumentIdByDocumentVersionId Method
GetDocumentLatestVersionInfo Method
GetDocumentLink Method
GetDocumentLocation Method
GetDocumentLocationAndArchive Method
GetDocumentName Method
GetDocumentNameAndSchema Method
GetDocumentNameWithLinks Method
GetDocumentOwnerGuid Method
GetDocumentsAssociatedWithWorkflows Method
GetDocumentSchemaFromSelection Method
GetDocumentsForUsageLog Method
GetDocumentsInSchemas Method
GetDocumentsInSchemaType Method
GetDocumentsToAssemble Method
GetDocumentsToCheckIn Method
GetDocumentsToDownload Method
GetDocumentsToSend Method
GetDocumentsToView Method
GetDocumentsWithCustomNaming Method
GetDocumentUrl Method
GetDocumentUrlByLinkType Method
GetDocumentVersionId Method
GetDocumentVersionName Method
GetDocumentVersionsForSelection Method
GetDropdownChanges Method
GetFileExtensions Method
GetFilteredLibraryAuditLogs Method
GetFTSServiceStatus Method
GetIdsFromSelection Method
GetLastVisibleVersionsFromSelection Method
GetLibraryAuditLogs Method
GetLockedMarkupDocumentsFromSelection Method
GetMoveFilesJobData Method
GetNamesFromSelection Method
GetNotLastVersionsFromSelection Method
GetObjectUrl Method
GetObjectUrlByLinkType Method
GetRepFileDetails Method
GetRepFileId Method
GetRepFilesSummary Method
GetScalarFromSelection Method
GetSchemaTypesFromSelection Method
GetSelectionContent Method
GetShortcutsFromSelection Method
GetSingleDocumentToDownload Method
GetSqlDate Method
GetUrlForDownloads Method
GetUserCulture Method
GetUtcSqlDate Method
GetWC3PathBase Method
GetWrappedWC2Url Method
InternalPrepareDocuments Method
InvokeUserAction Method
IsCheckedOut Method
IsCheckedOutBy Method
IsDocumentValidAssembleTemplate Method
IsDocumentVersionDeleted Method
Move Method
MoveAndEdit Method
MoveDocuments Method
MoveSelection Method
MoveShortcuts Method
NotifyUsers Method
PrepareDocumentsToDownload Method
PrepareMultipleDocumentsToDownload Method
PrepareSingleDocumentToDownload Method
PrepareSingleDocumentToDownloadByDocumentVersionId Method
PrepareToRename Method
Recover Method
RecoverDocuments Method
ReinstateAsLatestVersion Method
ReinstateAsLatestVersionWithMarkup Method
RemoveAllDocumentVersions Method
RemoveDocumentLinks Method
RemoveDocumentsAndShortcuts Method
RemoveDocumentVersion Method
RemoveDocumentVersions Method
RemoveFromFavourites Method
RemoveLinks Method
RemoveSelection Method
RemoveShortcuts Method
RenameDocuments Method
RenamePreparedDocuments Method
SendEmail Method
SendEmailWithDocuments Method
SetMetadata Method
SetMultiMetadata Method
UpdateAssembleDocumentsJob Method
UpdateAutoTaggedDocuments Method
UpdateDocumentName Method
UpdateOriginalFileName Method
UpdateRepFileId Method
VerifyDocumentsToAssemble Method
Click or drag to resize

DocumentManagerGetDocumentsToDownload Method

Checks if the selected documents can be downloaded and returns detailed information.

Namespace:  FileHold.LibraryManager
Assembly:  FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.0.0.0
Syntax
C#
Copy
public DownloadDocument[] GetDocumentsToDownload(
	Guid selectionId,
	bool includeShortcuts,
	bool checkingOut
)

Parameters

selectionId
Type: SystemGuid
includeShortcuts
Type: SystemBoolean
checkingOut
Type: SystemBoolean

Return Value

Type: DownloadDocument
See Also