Name 

Description 

 

constructor Create(aOwner: TComponent); override; 

Creates and intializes an instance of this component.  

 

destructor Destroy; override; 

Destroys an instance of a TJamBaseSelectionList component  

 

Name 

Description 

 

constructor Create(aOwner: TComponent); override; 

Creates an instances of a TJamSelectionList component.  

 

constructor CreateCopy(aSelectionList: TJamSelectionList); 

Creates an cloned instances of a TJamSelectionList component.  

 

destructor Destroy; override; 

Destroys an instance of a TJamSelectionList component  

 

Name 

Description 

 

procedure AddPathToSelection(sFQPath: String); virtual; abstract; 

This procedure adds a path to the list of selected paths.  

 

procedure Assign(pSelectionList: TPersistent); override; 

See TPersistent.Assign 

 

procedure Clear; virtual; 

Clears list of paths. 

 

function IsEmpty: Boolean; 

Returns true if the list is empty. 

 

procedure LoadFromIniFile(const sFileName: String; const section: String = '_sectionlist'); 

With this procedure you can load an existing selection list from an ini file. You may pass the section name as second parameter. 

 

procedure RemovePathFromSelection(sFQPath: String); virtual; abstract; 

Use this procedure to remove an item from a selection list.  

 

procedure SaveToIniFile(const sFileName: String; const section: String = '_sectionlist'); 

Save the selection list to an INI-file.  

 

Name 

Description 

 

procedure AddPathToSelection(sFQPath: String); override; 

This procedure adds a path to the list of selected paths.  

 

procedure AddPIDLToSelection(PIDL: IItemIdList); 

Adds an ItemIdList to the selection.  

 

procedure BeginUpdate; 

Prevents updating of connected shell controls until EndUpdate method is called.  

 

class function BoolToSelectionState(pValue: Boolean): TJamSelectionState; 

Converts a boolean value to a selection state.  

 

procedure Clear; override; 

Call clear to switch all checkboxes of all connection shell controls to the state ssUnchecked.  

 

function CompletePathSelected(sFQPath: String): String; override; 

Returns smallest complete selected path. 

 

function CompletePIDLSelected(const PIDL: IItemIdList): IItemIdList; 

Returns smallest complete selected path as ItemIdList. 

 

class function CreateFile(pFullPath: String): Boolean; 

Creates a new empty file.  

 

procedure EndUpdate; 

Reenables screen repainting of connected shell controls that was turned off with the BeginUpdate method.  

 

class function FindFirstFile(const pPath: String; out pFindData: TWin32FindDataW): THandle; 

Builds a wrapper arround the FindFirstFileW function, but uses the long file name pre fix, So that also files with a full file name longer than 255 chars could be found.  

 

function FindNext: String; 

Enumerates all files of the current selection.  

 

class function ForceDirectories(pFullPath: String): Boolean; 

Ensure that all directories in the given path exist.  

 

function GetListOfAllFiles: TJamPathList; 

 

 

class function GetParentPathFromPath(const Path: String): String; 

Returns the parent path of the given path. 

 

class function GetUnicodeAPICallPath(const pPath: String): String; deprecated; 

The Unicode versions of several functions permit a maximum path length of approximately 32,000 characters composed of components up to 255 characters in length. To specify that kind of path, use the "\?"("\?UNC" for UNC-Path) prefix. This function prepares the path with the correct prefix.  

 

class function IsFile(const Path: String): Boolean; 

Checks is the given path is a file in the file system. 

 

class function IsFolder(const Path: String): Boolean; 

Checks is the given path is a file system folder. 

 

class function IsFolderToIgnore(const name: String): Boolean; 

Checks if the given object should be ignored when enumerating a directory. 

 

function IsPathSelected(const Path: String): TJamSelectionState; overload; 

Retrieves the TJamSelectionState of the passed path.  

 

function IsPIDLSelected(const PIDL: IItemIdList; var bIsSubItemOf: boolean): TJamSelectionState; 

Checks if given ItemIdList is part of the selection.  

 

procedure PathWasRenamed(const pOldPath: String; const pNewPath: String); virtual; 

Searches the path in the selected files and if found, replaces it by its new name.  

 

procedure RemovePathFromSelection(sFQPath: String); override; 

Remove item from selection list using the full qualified path.  

 

procedure RemovePIDLFromSelection(PIDL: IItemIdList); 

Removes the item that belongs to the given ItemIdList from selection list. 

 

procedure ResetFindNext; 

Reset enumeration of all files of the current selection.  

 

function ToString: string; override; 

Returns a string with all paths in the selection list.  

 

Name 

Description 

 

property Count: Integer read GetCount; 

The number of selected paths.  

 

property FileCount: Integer read GetFileCount; 

Use this property to get the total number of selected files.  

 

property FolderCount: Integer read GetFolderCount; 

Use this property to get the total number of selected folders.  

 

property OnChange: TNotifyEvent read fOnChange write fOnChange; 

Occurs, if the selection has changed.  

 

property Parent: TComponent read fParent write fParent; 

The parent component of this instance. 

 

property Path [i : Integer]: String read GetListItem; 

Gives back the filename of an item.  

 

property Paths: TFileNames read GetPaths write SetPaths; 

List of the selected files.  

 

property Size: Int64 read GetSize; 

Use this function to get back the total size of the selected files.  

 

Name 

Description 

 

property CalculateSelectedFiles: Boolean read fCalculateSelectedFiles write fCalculateSelectedFiles default true; 

Controls whether the size and count of the selected files is calculated.  

 

property DifferentDrives: boolean read GetDifferentDrivesSelected; 

Returns true, if files on different drives are selected.  

 

property FollowReparsePoint: Boolean read fFollowReparsePoint write fFollowReparsePoint default false; 

Set to True if reparse Points (e.g. symblic links) should be followed; Se to False if they should be ignroed.  

 

property HandleShellLinks: boolean read fHandleShellLinks write fHandleShellLinks; 

Decide, if the component should follow the link to the file.  

 

property IsLocalPathSelected: Boolean read GetIsLocalPathSelected; 

Returns true, if files on local drives are selected.  

 

property IsUNCPathSelected: Boolean read GetIsUNCPathSelected; 

Returns true, if files on UNC paths are selected.  

 

property OnCompletedCalculateFiles; 

Occurs, when the thread, which calculates the count and size of the selected files and folders, has terminated.  

 

property RemoveInvalidPaths: Boolean read fRemoveInvalidPaths write fRemoveInvalidPaths default True; 

If set to True (the default value), non-existing paths will not be ignored and not added to the list.  

 

Name 

Description 

 

property OnInvalidPath: TInvalidPathEvent read fOnInvalidPath write fOnInvalidPath; 

This is event is fired if an invlaid path was supposed to be added to the list.