finDocumentFiles Class

A collection of Document Manager Files.
Implements I_ISObjectName, I_ISDeleteWarning

Methods

Name Description
Add Add a File to the Document Manager Folder.
AddExcelWorkbook Adds the specified Excel Workbook to the Document Manager.
AddImage Add an Image File to the Document Manager.
AddWordDocumentAsPdfFile Adds the specified Word Document to the Document Manager.
AddWordDocumentsAsPdfFile Adds the specified Word Document(s) to the Document Manager.
CanAdd Determines whether a file can be added.
CanDelete Determines whether a file can be deleted.
CanRename Determines whether a file can be renamed.
CanUndelete Determines whether a file can be undeleted.
Clear
CopyFromDocumentFile Copy from an existing Document File.
Delete Delete a File.
DeleteRelatedSource Permanently deletes all Files that match the Source and Pk - except if there are other Related Items.
DeleteWarning
FileExists Checks to see if the specified File exists in the Collection.
GetCategoryList Gets a list of File Categories. Includes the standard list from the relevant Information List, plus any existing used Categories.
GetChronologicalList Gets a List of finDocumentFile sorted by the Documents FileCreatedDate
GetFileBinaryDataFromFileName Get a File's Binary Content given its File Name and File Category.
GetFileStreamFromFileName System Use Only Get a File's Binary Content given its File Name and File Category.
GetObjectName
GetRelatedSource Returns the Document File with the specified Related Source, or Nothing if not found.
HasRelatedSource Returns True if any Document File includes the specified Related Source.
HasRelatedSourceOnly Returns True if any Document File includes the specified Related Source and Pk AND no other related Items.
IndexOf Get the index of a File in the Collection.
IsFileCategoryValid Returns True if the File Category is valid.
IsFileInLocalFolder Returns True if the specified file is in the Local Folder.
ReadOnlyClear Clears the Read-Only flag for the Document File.
ReadOnlySet Set the Read-Only flag for the Document File.
Refresh Refreshes the collection.
Rename Rename a File.
Undelete Undeletes a File, if the Service supports this.

Properties

Name Description
LocalFolder Read-Only Returns the Root Folder (File System service) or Local Cache Folder.
SourceBranchId Read-Only The Id of the Source Object's Branch.
SourceBranchPk Read-Only The Primary Key of the Source Object's Branch.
SourceId Read-Only The Id of the Source Object, e.g. Client Id.
SourcePk Read-Only The Primary Key of the Source Object, e.g. Client.
SourceTypePermissionKeyPrefix Read-Only
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0