TJamSelectionList Class

Manages the list of selected paths.

Class Hierarchy

Syntax

Pascal

TJamSelectionList = class(TJamBaseSelectionList);

File

JamSelectionList

Remarks

This class is used as a property of the JamShellLink component for managing the list of selected paths that the user selects with shell controls that have the CheckBoxes property set to True. You can modify the list using the AddPathToSelection and RemovePathFromSelection method. You can save or load the list using the SaveToIniFile and LoadFromIniFile methods. You can access the list of selected paths using the Paths property, which is of type TStrings and so inherits the typical methods like GetText, SaveToFile, Clear etc. With FindNext you can enumerate the files of the current selection.

Public Methods

	Name	Description
	Create	Creates an instances of a TJamBaseSelectionList component
	Destroy	Destroys an instance of a TJamBaseSelectionList component

TJamSelectionList Class

	Name	Description
	Create	Creates an instances of a TJamSelectionList component
	CreateCopy	Creates an instances of a TJamSelectionList component
	Destroy	Destroys an instance of a TJamSelectionList component

public

	Name	Description
	Count	The number of selected paths.
	FileCount	Use this property to get the total number of selected files.
	FolderCount	Use this property to get the total number of selected folders.
	Parent	The parent component of this instance.
	Path	Gives back the filename of an item.
	Size	Use this function to get back the total size of the selected files.
	AddPathToSelection	This procedure adds a path to the list of selected paths.
	Assign	This is Assign, a member of class TJamBaseSelectionList.
	Clear	Clears list of paths.
	LoadFromIniFile	With this procedure you can load an existing selection list from an ini file. You may pass the section name as second parameter.
	RemovePathFromSelection	Use this procedure to remove an item from a selection list.
	SaveToIniFile	Save the selection list to an INI-file.

TJamSelectionList Class

	Name	Description
	CalculateSelectedFiles	Controls whether the size and count of the selected files is calculated.
	DifferentDrives	Returns true, if files on different drives are selected.
	FollowReparsePoint	This is FollowReparsePoint, a member of class TJamSelectionList.
	HandleShellLinks	Decide, if the component should follow the link to the file.
	IsLocalPathSelected	Returns true, if files on local drives are selected.
	IsUNCPathSelected	Returns true, if files on UNC paths are selected.
	RemoveInvalidPaths	If set to True (the default value), non-existing paths will not be ignored and not added to the list.
	AddPathToSelection	This procedure adds a path to the list of selected paths.
	AddPIDLToSelection	This is AddPIDLToSelection, a member of class TJamSelectionList.
	BeginUpdate	Prevents updating of connected shell controls until EndUpdate method is called.
	BoolToSelectionState	Converts a boolean value to a selection state.
	Clear	Call clear to switch all checkboxes of all connection shell controls to the state ssUnchecked.
	CompletePathSelected	returns smallest complete selected path
	CompletePIDLSelected	returns smallest complete selected path
	EndUpdate	Reenables screen repainting of connected shell controls that was turned off with the BeginUpdate method.
	FindFirstFile	This is FindFirstFile, a member of class TJamSelectionList.
	FindNext	Enumerates all files of the current selection.
	GetListOfAllFiles	This is GetListOfAllFiles, a member of class TJamSelectionList.
	GetParentPathFromPath	This is GetParentPathFromPath, a member of class TJamSelectionList.
	IsFile	Checks is the given path is a file in the file system.
	IsFolder	Checks is the given path is a file system folder.
	IsPathSelected	Checks if item is in the selection.
	IsPIDLSelected	This is IsPIDLSelected, a member of class TJamSelectionList.
	PathWasRenamed	Searches the path in the selected files and if found, replaces it by its new name.
	RemovePathFromSelection	Remove item from selection list via full qualified path.
	RemovePIDLFromSelection	This is RemovePIDLFromSelection, a member of class TJamSelectionList.
	ResetFindNext	Reset enumeration of all files of the current selection.

published

	Name	Description
	OnChange	Occurs, if the selection has changed.
	OnInvalidPath	This is event is fired if an invlaid path was supposed to be added to the list.
	Paths	List of the selected files.

TJamSelectionList Class

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

Links

Members, public, published

Contents | Index | Home