C# Class SIL.FieldWorks.FwCoreDlgs.MoveOrCopyFilesController

Used to move or copy media files when they are linked to a FieldWorks project

Mostra file Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method	Description
MoveCopyOrLeaveExternalFile ( string sFile, string sRootDirLinkedFiles, IHelpTopicProvider helpTopicProvider, bool isLocal ) : string	Checks to see whether the given file is located in the given root directory (or any subfolder of it), and if not, prompts the user to allow FW to move, copy, or leave the file. If anything unexpected happens, the default is to leave the file where it is.
MoveCopyOrLeaveMediaFiles ( string files, string sRootDirLinkedFiles, IHelpTopicProvider helpTopicProvider, bool isLocal ) : string[]	Checks to see whether the given files are located in the given root directory (or any subfolder of it), and if not, prompts the user to allow FW to move, copy, or leave the files. If anything unexpected happens, the default is to leave the files where they are.

Private Methods

Method	Description
FileIsInExternalLinksFolder ( string sFile, string sRootDir ) : bool	Determines whether the given file is located in the given root directory (or any subfolder of it).
MoveCopyOrLeaveFiles ( string files, string subFolder, string sRootDirExternalLinks, IHelpTopicProvider helpTopicProvider, bool isLocal ) : string[]
PerformMoveCopyOrLeaveFile ( string sFile, string sRootDir, FileLocationChoice action ) : string	Performs the action the user requested: move, copy, or leave the file.

Method Details

MoveCopyOrLeaveExternalFile() public static method

Checks to see whether the given file is located in the given root directory (or any subfolder of it), and if not, prompts the user to allow FW to move, copy, or leave the file. If anything unexpected happens, the default is to leave the file where it is.

public static MoveCopyOrLeaveExternalFile ( string sFile, string sRootDirLinkedFiles, IHelpTopicProvider helpTopicProvider, bool isLocal ) : string
sFile	string	The fully-specified path name of the file.
sRootDirLinkedFiles	string	The fully-specified path name of the LinkedFiles root directory.
helpTopicProvider	IHelpTopicProvider	The help topic provider.
isLocal	bool	True if running on the local server: allows file not to be moved or copied
return	string

MoveCopyOrLeaveMediaFiles() public static method

Checks to see whether the given files are located in the given root directory (or any subfolder of it), and if not, prompts the user to allow FW to move, copy, or leave the files. If anything unexpected happens, the default is to leave the files where they are.

public static MoveCopyOrLeaveMediaFiles ( string files, string sRootDirLinkedFiles, IHelpTopicProvider helpTopicProvider, bool isLocal ) : string[]
files	string	The fully-specified path names of the files.
sRootDirLinkedFiles	string	The fully-specified path name of the LinkedFiles root directory.
helpTopicProvider	IHelpTopicProvider	The help topic provider.
isLocal	bool	True if running on the local server: allows file not to be moved or copied
return	string[]