Jam.Shell.Dialogs.FileOperation.TJamFileOperation

Perform file operations.

Syntax

Pascal

TJamFileOperation = class(TComponent);

Description

If multiple operations are started asynchronous they are added to the progress dialog window.

Remarks

TJamFileOperation is a component to perform file operations like copy, move, rename or delete. It has to be activated like a TOpenDialog, with the call of the Execute method. To perform a single operation first specify the requested operation by setting Operation and use SourceFiles to add files or folders. After that specify a destination by setting Destination and call Execute.

Example 1

The following sample shows how to copy a single file to the root of drive D:</c>:

  JamFileOperation.Operation := otCopy;
  JamFileOperation.SourceFiles.Add('C:\Windows\explorer.exe'); // You may add more of this line or use AddStrings()
  JamFileOperation.Destination := 'D:\';
  JamFileOperation.Execute();

Example 2

The same can also be done in a simplier way:

  TJamFileOperation.Copy('C:\Windows\explorer.exe', 'D:');

In this case the operation is also performed on a background thread where the dialog is not modal.

Namespace

Jam.Shell.Dialogs.FileOperation

Public Methods

	Name	Description
	constructor Create(pOwner: TComponent); override;	Constructor for creating a TJamFileOperation instance.
	destructor Destroy; override;	Destructor for destroying a TJamFileOperation instance.

TJamFileOperation Methods

	Name	Description
	class procedure Copy(const pFileName: IItemIdList; const pFolder: IItemIdList; pOptions: TOperationOptions = soDefault); overload; static;	Copies a file or folder.
	class procedure Copy(const pFileNames: IItemIdListCollection; const pFolder: IItemIdList; pOptions: TOperationOptions = soDefault); overload; static;	Copies files or folders.
	class procedure Copy(const pFileName: string; const pFolder: string; pOptions: TOperationOptions = soDefault); overload; static;	Copies a file or folder.
	class procedure Delete(const pFileName: IItemIdList; pOptions: TOperationOptions = soDefault); overload; static;	Deletes a file or folder.
	class procedure Delete(const pFileNames: IItemIdListCollection; pOptions: TOperationOptions = soDefault); overload; static;	Deletes files or folders.
	class procedure Delete(const pFileName: string; pOptions: TOperationOptions = soDefault); overload; static;	Deletes a file or folder.
	function Execute: Boolean; overload;	Performs the requested operation.
	function Execute(pParentWnd: HWND): Boolean; overload;	Performs the requested operation.
	class procedure Move(const pFileName: IItemIdList; const pFolder: IItemIdList; pOptions: TOperationOptions = soDefault); overload; static;	Moves a file or folder.
	class procedure Move(const pFileNames: IItemIdListCollection; const pFolder: IItemIdList; pOptions: TOperationOptions = soDefault); overload; static;	Moves files or folders.
	class procedure Move(const pFileName: string; const pFolder: string; pOptions: TOperationOptions = soDefault); overload; static;	Moves a file or folder.
	class procedure NewFile(const pFolder: IItemIdList; const pNewName: string; pOptions: TOperationOptions = soDefault); overload; static;	Creates a new file.
	class procedure NewFile(const pFileName: TFileName; pOptions: TOperationOptions = soDefault); overload; static;	Creates a new file.
	class procedure NewFolder(const pFolder: IItemIdList; const pNewname: string; pOptions: TOperationOptions = soDefault); overload; static;	Creates a new folder.
	class procedure NewFolder(const pFileName: TFileName; pOptions: TOperationOptions = soDefault); overload; static;	Creates a new folder.
	class procedure Rename(const pFileName: IItemIdList; const pNewname: string; pOptions: TOperationOptions = soDefault); overload; static;	Renames a file or folder.
	class procedure Rename(const pFileNames: IItemIdListCollection; const pNewname: string; pOptions: TOperationOptions = soDefault); overload; static;	Renames files or folders.
	class procedure Rename(const pFileName: string; const pNewname: string; pOptions: TOperationOptions = soDefault); overload; static;	Renames a file or folder.
	class procedure SetProperties(const pFileName: IItemIdList; const pProperties: TDictionary<TShellColumnId, TShellPropertyValue>; pOptions: TOperationOptions = soDefault); overload; static;	Sets properties of files.
	class procedure SetProperties(const pFileNames: IItemIdListCollection; const pProperties: TDictionary<TShellColumnId, TShellPropertyValue>; pOptions: TOperationOptions = soDefault); overload; static;	Sets properties of files.
	class procedure SetProperties(const pFileName: string; const pProperties: TDictionary<TShellColumnId, TShellPropertyValue>; pOptions: TOperationOptions = soDefault); overload; static;	Sets properties of files.
	class procedure SetProperty(const pFileName: IItemIdList; const pProperty: TShellColumnId; const pValue: TShellPropertyValue; pOptions: TOperationOptions = soDefault); overload; static;	Sets a property of a file.
	class procedure SetProperty(const pFileNames: IItemIdListCollection; const pProperty: TShellColumnId; const pValue: TShellPropertyValue; pOptions: TOperationOptions = soDefault); overload; static;	Sets a property of files.
	class procedure SetProperty(const pFileName: string; const pProperty: TShellColumnId; const pValue: TShellPropertyValue; pOptions: TOperationOptions = soDefault); overload; static;	Sets a property of a file.
	class procedure Unzip(const pZipFile: IItemIdList; const pFolder: IItemIdList; pOptions: TOperationOptions = soDefault); overload; static;	Extracts files from a ZIP file to an existing directory.
	class procedure Unzip(const pZipFile: string; const pFolder: string; pOptions: TOperationOptions = soDefault); overload; static;	Extracts files from a ZIP file to an existing directory.
	class procedure Zip(const pFileName: IItemIdList; const pZipFile: IItemIdList); overload; static;	Appends a file or folder to a ZIP file.
	class procedure Zip(const pFileNames: IItemIdListCollection; const pZipFile: IItemIdList); overload; static;	Appends files to a ZIP file.
	class procedure Zip(const pFileName: string; const pZipFile: string); overload; static;	Appends a file or folder to a ZIP file.

TJamFileOperation Properties

	Name	Description
	property Destination: string read fDestination write fDestination;	Destination determines the destination folder for the file operation.
	property DestinationIdList: IItemIdList read fDestinationIdList write fDestinationIdList;	Destination determines the destination folder for the file operation.
	property LastErrorCode: HRESULT read fLastErrorCode;	Last error code of Execute.
	property Operation: TJamOperationType read fOperation write fOperation default otCopy;	Gets or sets the operation that should be performed.
	property OperationAborted: Boolean read fOperationAborted;	Check if the user has canceled the operation.
	property Options: TOperationOptions read fOptions write fOptions default [soAllowUndo, soNoConfirmMkDir];	Gets or sets the options.
	property Properties: TDictionary<TShellColumnId, TShellPropertyValue> read fProperties write SetPropertiesDict;	The properties of TJamFileOperation.SourceFiles that should be changed.
	property RaiseExceptions: Boolean read fRaiseExceptions write fRaiseExceptions default False;	Raise exceptions in Execute or just store error in LastErrorCode.
	property SourceFiles: IItemIdListCollection read fSourceFiles write SetSourceFiles;	List of the selected files or directories.
	property Version: string read GetVersion stored False;	The current version of the ShellBrowser components.

Links

Jam.Shell.Dialogs.FileOperation, Legend, Members, Public Methods, Example 1, Example 2, TJamFileOperation Methods, TJamFileOperation Properties

Contents | Index | Home