ShellBrowser Delphi Components Documentation
ContentsIndexHome
PreviousUpNext
JamControls.TJamFileList

Component for listing files from different folders and for performing a file search.

JamControls_TJamFileListJamControls_TJamFileListJamControls_TJamFileListJamControls_TJamFileListJamControls_TJamFileListJamControls_TJamFileListJamControls_TJamFileListJamControls_TJamFileListJamControls_TJamFileList
Syntax
Pascal
TJamFileList = class(TJamCustomFileList, IThumbnailViewer, IUICommandInvokable);

TJamFileList can be used to list files and folders from different directories in one list. You can use the Add method to add files or folders to the list.  

Additionally file multithreaded searches similar to the Windows file search can be performed. The settings of the search can be controlled using the SearchOptions property, the search can be started using the Search method and will be performed in an own thread.  

 

JamControls.TJamBaseShellListView
 
Name 
Description 
 
Creates and intializes an instance of this component.  
 
Destroys an instance of a TJamBaseShellListView component  
JamControls.TJamCustomFileList
 
Name 
Description 
 
Constructor of an instances of a TJamCustomFileList component  
 
Destructor of an instances of a TJamCustomFileList component  
JamControls.TJamFileList
 
Name 
Description 
 
Creates an instance of a TJamFileList component. 
 
Destroys an instance of a TJamFileList component  
JamControls.TJamBaseShellListView
 
Name 
Description 
 
This event is triggered before the user changes the columns by using the header context menu.  
 
This event is triggered before the user changes the columns by using the header context menu.  
 
This event can be implemented to customize columns. It is called when a column is added to the view, but also when the header context menu or the column selection dialog is displayed.  
 
This event is triggered before and after the sort. 
ShellBrowser.IShellCommandInvokable
 
Name 
Description 
 
This event occurs, before a shell context menu command is executed.  
JamControls.TJamCustomFileList
 
Name 
Description 
 
This event is fired if a file is to be added to the listview.  
 
OnAddPath occurs, whenever a new path is added to the listview.  
 
This event occurs, before a context menu command is executed.  
 
Happens when the user starts a shell drag operation.  
 
Allows you to prevent unwanted shell drops.  
 
This event is fired, if the state of a checkbox was changed by the user.  
 
The OnOperation event occurs after a shell operation like pasting or dragging and dropping files was performed.  
JamControls.TJamFileList
 
Name 
Description 
 
The OnEndSearch event occurs when a search is completed.  
 
The OnSearchProgress event occurs during a file search for each file.  
 
This event will be triggered whenever the selection changes.  
 
The OnThumbnailUpdated event occurs, when a thumbnail is updated.  
 
Name 
Description 
 
Returns the number of selected Objects in the control.  
 
Executes a shell command on the objects selected in the control.  
 
Displays a context menu for the selected items. 
Jam.Shell.Types.ICancellationIndicator
 
Name 
Description 
 
Gets whether cancellation has been requested for this token. 
Jam.Shell.Types.ICancellationToken
 
Name 
Description 
 
Communicates a request for cancellation. 
ShellLink.IJamShellControl
 
Name 
Description 
 
This method is called by the ShellLink instance if the currently selected item has changed. 
 
Getter method for the ShellLink property. 
 
GoUp 
This method indicates that the callee should go up one level and display the contents of the current folder's parent folder. 
 
This method is called by the ShellLink instance if the currently displayed folder has changed. 
 
This method indicates that the control should perform a refresh of its contents. 
 
This method indicates that the callee should select all item it currently displays. 
 
Setter method for the ShellLink property. 
JamControls.TJamBaseShellListView
 
Name 
Description 
 
Auto adjust the widths of all columns.  
 
Returns the current column index for a given TSHColumnId.  
 
Returns a drag cursor if a list item is being dragged. 
 
Use this function to get an array of currently visible columns. 
 
Returns whether the given SHColumnId is currently visible or not.  
 
Checks if the list is empty.  
 
Checks if the Item with the passed index is selected.  
 
Resets the current columns and the saved widths for the current special folder and restores the initial state.  
 
Selects all Items in a TJamShellList.  
 
Set the visibility of a column. 
 
Use this method to display the context menu for the selected entry.  
 
Sort 
Triggers sorting by the current settings (SortedBy, SortOrder)  
ShellBrowser.IShellCommandInvokable
 
Name 
Description 
 
Getter for the OnBeforeShellCommand property.  
 
Setter for the OnBeforeShellCommand property.  
ShellLink.IJamMultiSelectShellControl
 
Name 
Description 
 
Returns an IItemIdListCollection containing the selected ItemIdLists or an empty list if nothing is selected. 
JamControls.TJamCustomFileList
 
Name 
Description 
 
Add 
Adds a file or folder to the list.  
 
Add a list of paths to the list. 
 
Checks all items in the list  
 
Removes all items from the FileList  
 
Removes an item from the list view and frees the associated memory.  
 
Executes a full refresh on the control. 
 
Use this function to get the full path of an item of the list.  
 
Returns an IItemIdListCollection containing the selected ItemIdLists or an empty list if nothing is selected. 
 
Executes a command of the context menu of the current object.  
 
Executes a command of the context menu of the current object.  
 
Checks whether an item with the given filename can be found in the list.  
 
Returns the item that is associated to the filename, if it is in the list, otherwise nil.  
 
Selects all items of the list.  
 
Show the context menu for the selected items.  
 
Executes a quick refresh on the control. 
 
Sets the Checked state of all Items to "unchecked" (false).  
JamControls.TJamFileList
 
Name 
Description 
 
Add 
Adds elements to the list.  
 
Prevents updating of the list view until the EndUpdate method is called.  
 
Reenables internal operations that were turned off with the BeginUpdate method.  
 
Starts the search for files.  
 
Set the visibility of a column. 
 
Stop 
Call this method to stop the file search in the assigned path.  
ShellLink.IJamShellControl
 
Name 
Description 
 
The TJamShellLink instance to which the current control connected. 
JamControls.TJamBaseShellListView
 
Name 
Description 
 
Adjust the size of the given column so that it fills the remaining horizontal space.  
 
The delay in ms after the selection has been changed before connected controls are informed. Default 100 ms.  
 
Gets the collection of all column headers that appear in the control.  
 
Sets the column width that is used in ViewStyle vsList  
 
Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.  
 
The TJamIconSize that shall be used in viewstyle vsIcon.  
 
Lets you control the spacing between the large icons and thumbnails. -1 means the spacing is automatically set. A value >= 0 will be added to the width and height of the images of the current view. The small icons should not be affected by this property. 
 
This event is triggered after the columns were created 
 
OnCreateItemClass occurs when a list item object is about to be created.  
 
Specifies where a control looks for its font information. 
 
Prevents operations that change the file system from being executed.  
 
Automatically display the shell context menu.  
 
Use this property to determine if the header conext menu should be displayed when the user right clicks on the columns 
 
Use the same styles as the Windows Explorer.  
 
The version number of the ShellBrower controls. 
JamControls.TJamCustomFileList
 
Name 
Description 
 
Gets or sets the alignment of items in the control.  
 
Gets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent.  
 
Gets or sets the border style of the control.  
 
 
Specifies the background color of the control.  
 
Specifies the size constraints for the control. 
 
Determines whether a control has a three-dimensional (3-D) or two-dimensional look. 
 
Choose if details of the listed objects should be shown.  
 
Specifies the image used to represent the mouse pointer when the control is being dragged. 
 
Specifies whether the control is being dragged normally or for docking. 
 
Specifies how the control initiates drag-and-drop or drag-and-dock operations. 
 
Controls whether the control responds to mouse, keyboard, and timer events.  
 
Specifies whether the list view's scroll bars are flat.  
 
Font 
Controls the attributes of text written on or in the control. Make sure to turn off UseSystemFont before editing this control! Otherwise the changes will not persist.  
 
Specifies whether headers are repainted when they are dragged.  
 
Determines whether grid lines appear between the rows and columns containing the items and subitems in the control.  
 
Determines whether the list view gives a visual indication of which item is selected when focus shifts to another control.  
 
Hint 
Hint contains the text string that can appear when the user moves the mouse over the control. 
 
Specifies whether list items are highlighted when the mouse passes over them.  
 
Determines how icons displayed in the list view are arranged. 
 
Gets or sets the Input Method Editor (IME) mode of the control.  
 
Specifies the input method editor (IME) to use for converting keyboard input to Asian language characters. 
 
Contains the list of items displayed by the list view.  
 
Determines whether the user can select more than one list item at a time.  
 
Allow drag and drop operations with the Explorer.  
 
 
 
 
Occurs immediately after an item in the list changes. 
 
Occurs when an item in the list is about to change. 
 
Occurs when the user clicks the control.  
 
Occurs when the user clicks on a column header in a list view. 
 
Occurs when a column is dragged to a new position.  
 
Occurs when the user right clicks on a column header in a list view. 
 
Occurs when two items need to be compared during a sort of the list. 
 
 
 
 
Occurs when a subitem must be rendered in an owner-draw list view. 
 
Occurs when the user double-clicks the left mouse button when the mouse pointer is over the control.  
 
 
Occurs when the user drops an object being dragged. 
 
Occurs when the user drags an object over a control. 
 
 
 
 
 
Occurs when the dragging of an object ends, either by dropping the object or by canceling the dragging. 
 
Occurs when a control receives the input focus. 
 
Occurs when the input focus shifts away from one control to another. 
 
Occurs when an item is about to be displayed in the list view control. 
 
 
 
Occurs when a user presses any key while the control has focus.  
 
Occurs when key pressed.  
 
Occurs when a user presses any key while the control has focus.  
 
Occurs when the user presses a mouse button with the mouse pointer over a control. 
 
Occurs when the mouse pointer moves over the control.  
 
Occurs when the mouse pointer moves off from over the control.  
 
Occurs when the user moves the mouse pointer while the mouse pointer is over a control. 
 
Occurs when the user releases a mouse button that was pressed with the mouse pointer over a component. 
 
Occurs immediately after the control is resized.  
 
 
 
Occurs when the user begins to drag the control or an object it contains by left-clicking the control and holding the mouse button down. 
 
Specifies where a control looks for its color information. 
 
Determines where a component looks to determine whether it should have a three-dimensional look. 
 
Determines where a component looks to determine whether it should have a three-dimensional look. 
 
Returns a list with the full paths of all items.  
 
Specifies the pop-up menu associated with the control. 
 
Indicates if sort order is normal or reverse.  
 
Determines whether an entire row in the list view can be selected.  
 
Determines whether the JamFileList control has scroll bars.  
 
Specifies the number of selected items in the list view.  
 
Returns the index of the selected item. 
 
Returns the full path for the selected item.  
 
Returns a list with the full paths for the selected items.  
 
Determines whether the column headers are displayed.  
 
Show the context menu on the top of the supplied Delphi TPopupMenu.  
 
ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control. 
 
If set to false, no overlay icons will be shown, which improves the performance of the control.  
 
The column according to which the listed objects are sorted.  
 
The TShellColumnId of the column the view is currently sorted by.  
 
The current sort order of the view.  
 
Specifies additional icon images to display next to each item in the list view. 
 
Indicates the position of the control in its parent's tab order. 
 
Determines whether the user can tab to a control. 
 
Set this property to true if you want the component to utilize the default system font.  
 
Determines whether the component appears onscreen.  
JamControls.TJamFileList
 
Name 
Description 
 
If this property is set to true, the user is allowed to drop items onto the background in order to add them to the displayed list of files. 
 
If set to True, it`s possible to have multiple items for the same path.  
 
Allowed effects when dragging files/folders out of the control.  
 
Receives notifications about changes in the shell and performs refreshes automatically.  
 
Adjust the size of the given column so that it fills the remaining horizontal space.  
 
Offers the possibility to add files and folders, which do not exist in the file system.  
 
Use CopyMode to control the Drag'n'Drop behaviour.  
 
Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.  
 
Sets the new default text to be displayed when the view is empty.  
 
In Thumbnail view, only load thumbnails that are already in the thumbnail cache for folders. Default value true will avoid potentially huge delays that are caused by folder thumbnails reflecting the contents of the folder.  
 
If true (default) virtual objects that do not have a physical path are not accepted.  
 
List of TListGroup objects to group list items. See TCustomListView.Groups  
 
Turn on and off group view. If true, list items need a GroupID if they should be displayed.  
 
If set to True, Icons will be determined based on their file extensions only. This is usually faster, in certains cases like EXE files the icons will differ from those shown in Windows Explorer. 
 
The TJamIconSize that shall be used in viewstyle vsIcon.  
 
Turns sorting in the list on or off.  
 
Occurs when an attempt is made to resize the control. 
 
ParentDoubleBuffered defers the DoubleBuffered property of this component to the value of the parent's DoubleBuffered property. 
 
Collection of search details.  
 
Returns the count of the selected files.  
 
Returns the size of the selected files.  
 
Connects this component to a TJamShellLink in order to synchronize several shell controls.  
 
Allow Windows error messages.  
 
Shows extra large icons.  
 
Shows jumbo icons.  
 
Specifies the style elements that are used by the control. 
 
Specifies the style name for this control. 
 
Specifies the background color of the control.  
 
Indicates the vertical size (in pixels) of the jpeg image.  
 
Switches the thumbnail mode on and off.  
 
Indicates the horizontal size (in pixels) of the jpeg image.  
 
Returns the count of all files.  
 
Returns the size of all files.  
 
Touch specifies the touch manager component associated with the control.  
 
Determines how the list items are displayed.