Name 

Description 

 

function IsCancellationRequested: Boolean; 

Gets whether cancellation has been requested for this token. 

 

Name 

Description 

 

procedure Cancel; 

Communicates a request for cancellation. 

 

Name 

Description 

 

procedure FileChanged(FolderPIDL: IItemIdList; FilePIDL: IItemIdList); 

This method is called by the ShellLink instance if the currently selected item has changed. 

 

function getShellLink: TJamShellLink; 

Getter method for the ShellLink property. 

 

function GoUp: Boolean; 

This method indicates that the callee should go up one level and display the contents of the current folder's parent folder. 

 

procedure PathChanged(FolderPIDL: IItemIdList); 

This method is called by the ShellLink instance if the currently displayed folder has changed. 

 

procedure Refresh(pRefreshLevel: TRefreshLevel; pItemIdList: IItemIdList = nil); 

This method indicates that the control should perform a refresh of its contents. 

 

procedure SelectAll; 

This method indicates that the callee should select all item it currently displays. 

 

procedure setShellLink(aValue: TJamShellLink); 

Setter method for the ShellLink property. 

 

Name 

Description 

 

procedure AutoAdjustColumnWidths(const pMinWidth: integer = 50; const pMaxWidth: integer = 750); 

Auto adjust the widths of all columns.  

 

function FindCaption(StartIndex: Integer; Value: string; Partial: Boolean; Inclusive: Boolean; Wrap: Boolean): TListItem; virtual; 

Returns a list view item, if any, with the specified caption. See TCustomListView.FindCaption 

 

function GetColumnPosition(const pColumnID: TShellColumnId): NativeInt; virtual; deprecated; 

Returns the current column index for a given TSHColumnId.  

 

function GetDragImages: TDragImageList; override; 

Returns a drag cursor if a list item is being dragged. 

 

function GetVisibleColumns: TColumnArray; deprecated; 

Use this function to get an array of currently visible columns. 

 

function IsColumnVisible(const pColumnID: TShellColumnId): Boolean; 

Returns whether the given SHColumnId is currently visible or not.  

 

function IsEmpty: Boolean; 

Checks if the list is empty.  

 

function IsItemSelected(pIndex: integer): boolean; 

Checks if the Item with the passed index is selected.  

 

procedure ResetColumns; 

Resets the current columns and the saved widths for the current special folder and restores the initial state.  

 

procedure SelectAll; override; 

Selects all Items in a TJamShellList.  

 

function SetColumnVisibility(const pColumnID: TShellColumnId; const pVisible: Boolean): Integer; virtual; 

Set the visibility of a column. 

 

function ShowContextMenu(const p: TPoint): String; virtual; 

Use this method to display the context menu for the selected entry.  

 

procedure Sort; overload; 

Triggers sorting by the current settings (SortedBy, SortOrder)  

 

procedure Sort(const pColumn: TShellColumnId; const pSortDirection: TJamSortDirection); overload; 

Sorts the current view by the passed attribute in the passed order.  

 

Name 

Description 

 

function GetSelCount: Integer; 

Returns the number of selected Objects in the control.  

 

function InvokeCommandOnSelected(const pCommand: TShellCommand): Boolean; 

Executes a shell command on the objects selected in the control.  

 

function ShowContextMenu(const pPosition: TPoint): String; 

Displays a context menu for the selected items. 

 

Name 

Description 

 

function GetSelectedElements: IItemIdListCollection; 

Returns an IItemIdListCollection containing the selected ItemIdLists or an empty list if nothing is selected. 

 

Name 

Description 

 

function Add(const pItemIdList: IItemIdList; pChecked: Boolean = false; pPos: integer = -1): TJamFileListItem; virtual; overload; 

Adds a file or folder to the list.  

 

function Add(const pPath: UnicodeString; pChecked: Boolean = false; pPos: integer = -1): TJamFileListItem; virtual; overload; 

Adds a file or folder to the list.  

 

procedure AddStrings(pPaths: TStrings; pInitiallyChecked: Boolean = false); 

Add a list of paths to the list. 

 

procedure CheckAll; 

Checks all items in the list  

 

procedure Clear; override; 

Removes all items from the FileList  

 

procedure DeleteItem(const pFullPath: UnicodeString); 

Removes an item from the list view and frees the associated memory.  

 

procedure FullRefresh; override; 

Executes a full refresh on the control. 

 

function GetFullPath(Index: Integer): UnicodeString; overload; 

Use this function to get the full path of an item of the list.  

 

function GetFullPath(item: TJamFileListItem): UnicodeString; overload; 

Use this function to get the full path of an item of the list.  

 

function GetSelectedElements: IItemIdListCollection; virtual; 

Returns an IItemIdListCollection containing the selected ItemIdLists or an empty list if nothing is selected. 

 

function InvokeCommandOnSelected(const pCommand: TShellCommand): Boolean; 

Executes a command of the context menu of the current object.  

 

function InvokeContextMenuCommand(const Command: String): Boolean; deprecated; 

Executes a command of the context menu of the current object.  

 

function IsItemInList(const FileName: UnicodeString): Boolean; 

Checks whether an item with the given filename can be found in the list.  

 

function ReturnItemInList(const pFilePath: UnicodeString; const lStartIndex: integer = 0): TJamFileListItem; virtual; 

Returns the item that is associated to the filename, if it is in the list, otherwise nil.  

 

procedure SelectAll; override; 

Selects all items of the list.  

 

function ShowContextMenu(const p: TPoint): String; override; 

Show the context menu for the selected items.  

 

procedure SmartRefresh; override; 

Executes a quick refresh on the control. 

 

procedure UnCheckAll; 

Sets the Checked state of all Items to "unchecked" (false).  

 

Name 

Description 

 

function Add(const Path: UnicodeString; Checked: Boolean = false; pPos: integer = -1): TJamFileListItem; override; 

Adds a drive or path to the drive list.  

 

function AddEditable(const Path: UnicodeString; Checked: Boolean = false): TJamFileListItem; 

Add an object to the list and sets the item to edit-mode.  

 

procedure FillDriveList; 

Populates the drive list and ensures that all drives that are currently available are present in the list.  

 

procedure FullRefresh; override; 

Enures that all drives that are currently available are present in the list and recalculates their free and total disk space.  

 

procedure SmartRefresh; override; 

Executes a quick refresh on the control. 

 

Name 

Description 

 

property ShellLink: TJamShellLink read getShellLink write setShellLink; 

The TJamShellLink instance to which the current control connected. 

 

Name 

Description 

 

property AutoSizeColumn: Integer read fAutoSizeColumn write fAutoSizeColumn default -; 

Adjust the size of the given column so that it fills the remaining horizontal space.  

 

property ChangeDelay: Integer read GetChangeDelay write SetChangeDelay; 

The delay in ms after the selection has been changed before connected controls are informed. Default 100 ms.  

 

property Columns: TJamShellListColumns read GetColumns write SetColumns; 

Gets the collection of all column headers that appear in the control.  

 

property DefaultColumnWidth: integer read fDefaultColumnWidth write SetDefaultColumnWidth default -; 

Sets the column width that is used in ViewStyle vsList  

 

property DoubleBuffered default True; 

Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.  

 

property IconSize: TJamIconSize read GetIconSize write SetIconSize; 

The TJamIconSize that shall be used in viewstyle vsIcon.  

 

property IconSpacing: Integer read fIconSpacing write SetIconSpacing default -; 

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. 

 

property OnCreateColumns: TNotifyEvent read fOnCreateColumns write fOnCreateColumns; 

This event is triggered after the columns were created 

 

property OnCreateItemClass; 

OnCreateItemClass occurs when a list item object is about to be created.  

 

property ParentFont read GetParentFont write SetParentFont default False; 

Specifies where a control looks for its font information. 

 

property ReadOnly read GetReadOnly write SetReadOnly default false; 

Prevents operations that change the file system from being executed.  

 

property ShellContextMenu: Boolean read fContextMenu write fContextMenu default True; 

Automatically display the shell context menu.  

 

property ShowHeaderContextMenu: Boolean read fShowHeaderContextMenu write fShowHeaderContextMenu default True; 

Use this property to determine if the header conext menu should be displayed when the user right clicks on the columns 

 

property UseSystemStyles: Boolean read fUseSystemStyles write SetUseSystemStyles default true; 

Use the same styles as the Windows Explorer.  

 

property Version: String read GetVersion stored false; 

The version number of the ShellBrower controls. 

 

Name 

Description 

 

property Align; 

Gets or sets the alignment of items in the control.  

 

property Anchors; 

Gets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent.  

 

property BorderStyle; 

Gets or sets the border style of the control.  

 

property Checkboxes; 

See TCustomListView.Checkboxes 

 

property Color; 

Specifies the background color of the control.  

 

property Constraints; 

Specifies the size constraints for the control. 

 

property Ctl3D; 

Determines whether a control has a three-dimensional (3-D) or two-dimensional look. 

 

property Details; 

Choose if details of the listed objects should be shown.  

 

property DragCursor; 

Specifies the image used to represent the mouse pointer when the control is being dragged. 

 

property DragKind; 

Specifies whether the control is being dragged normally or for docking. 

 

property DragMode; 

Specifies how the control initiates drag-and-drop or drag-and-dock operations. 

 

property Enabled; 

Controls whether the control responds to mouse, keyboard, and timer events.  

 

property FlatScrollBars; 

Specifies whether the list view's scroll bars are flat.  

 

property 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.  

 

property FullDrag; 

Specifies whether headers are repainted when they are dragged.  

 

property GridLines; 

Determines whether grid lines appear between the rows and columns containing the items and subitems in the control.  

 

property HideSelection; 

Determines whether the list view gives a visual indication of which item is selected when focus shifts to another control.  

 

property Hint; 

Hint contains the text string that can appear when the user moves the mouse over the control. 

 

property HotTrack; 

Specifies whether list items are highlighted when the mouse passes over them.  

 

property IconOptions; 

Determines how icons displayed in the list view are arranged. 

 

property ImeMode; 

Gets or sets the Input Method Editor (IME) mode of the control.  

 

property ImeName; 

Specifies the input method editor (IME) to use for converting keyboard input to Asian language characters. 

 

property Items: TJamFileListItems read GetItems; 

Contains the list of items displayed by the list view.  

 

property MultiSelect default True; 

Determines whether the user can select more than one list item at a time.  

 

property OleDragDrop; 

Allow drag and drop operations with the Explorer.  

 

property OnAdvancedCustomDraw; 

See TCustomListView.OnAdvancedCustomDraw 

 

property OnAdvancedCustomDrawItem; 

See TCustomListView.OnAdvancedCustomDrawItem 

 

property OnAdvancedCustomDrawSubItem; 

See TCustomListView.OnAdvancedCustomDrawSubItem 

 

property OnChange; 

Occurs immediately after an item in the list changes. 

 

property OnChanging; 

Occurs when an item in the list is about to change. 

 

property OnClick; 

Occurs when the user clicks the control.  

 

property OnColumnClick; 

Occurs when the user clicks on a column header in a list view. 

 

property OnColumnDragged; 

Occurs when a column is dragged to a new position.  

 

property OnColumnRightClick; 

Occurs when the user right clicks on a column header in a list view. 

 

property OnCompare; 

Occurs when two items need to be compared during a sort of the list. 

 

property OnContextPopup; 

See TControl.OnContextPopup 

 

property OnCustomDraw; 

See TCustomListView.OnCustomDraw 

 

property OnCustomDrawItem; 

See TCustomListView.OnCustomDrawItem 

 

property OnCustomDrawSubItem; 

Occurs when a subitem must be rendered in an owner-draw list view. 

 

property OnDblClick; 

Occurs when the user double-clicks the left mouse button when the mouse pointer is over the control.  

 

property OnDeletion; 

See TCustomListView.OnDeletion 

 

property OnDragDrop; 

Occurs when the user drops an object being dragged. 

 

property OnDragOver; 

Occurs when the user drags an object over a control. 

 

property OnDrawItem; 

See TCustomListView.OnDrawItem 

 

property OnEdited; 

See TCustomListView.OnEdited 

 

property OnEditing; 

See TCustomListView.OnEditing 

 

property OnEndDock; 

See TControl.OnEndDock 

 

property OnEndDrag; 

Occurs when the dragging of an object ends, either by dropping the object or by canceling the dragging. 

 

property OnEnter; 

Occurs when a control receives the input focus. 

 

property OnExit; 

Occurs when the input focus shifts away from one control to another. 

 

property OnGetImageIndex; 

Occurs when an item is about to be displayed in the list view control. 

 

property OnInfoTip; 

See TCustomListView.OnInfoTip 

 

property OnInsert; 

See TCustomListView.OnInsert 

 

property OnKeyDown; 

Occurs when a user presses any key while the control has focus.  

 

property OnKeyPress; 

Occurs when key pressed.  

 

property OnKeyUp; 

Occurs when a user presses any key while the control has focus.  

 

property OnMouseDown; 

Occurs when the user presses a mouse button with the mouse pointer over a control. 

 

property OnMouseEnter; 

Occurs when the mouse pointer moves over the control.  

 

property OnMouseLeave; 

Occurs when the mouse pointer moves off from over the control.  

 

property OnMouseMove; 

Occurs when the user moves the mouse pointer while the mouse pointer is over a control. 

 

property OnMouseUp; 

Occurs when the user releases a mouse button that was pressed with the mouse pointer over a component. 

 

property OnMouseWheel; 

Occurs when the mouse wheel is rotated.  

 

property OnResize; 

Occurs immediately after the control is resized.  

 

property OnSelectItem; 

See TCustomListView.OnSelectItem 

 

property OnStartDock; 

See TControl.OnStartDock 

 

property OnStartDrag; 

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. 

 

property ParentColor default false; 

Specifies where a control looks for its color information. 

 

property ParentCtl3D; 

Determines where a component looks to determine whether it should have a three-dimensional look. 

 

property ParentShowHint; 

Determines where a component looks to determine whether it should have a three-dimensional look. 

 

property Paths: TFilenames read GetPathList; 

Returns a list with the full paths of all items.  

 

property PopupMenu; 

Specifies the pop-up menu associated with the control. 

 

property ReverseSortOrder; 

Indicates if sort order is normal or reverse.  

 

property RowSelect; 

Determines whether an entire row in the list view can be selected.  

 

property ScrollBars: TScrollStyle read fScrollBars write fScrollBars default ssBoth; 

Determines whether the JamFileList control has scroll bars.  

 

property SelCount; 

Specifies the number of selected items in the list view.  

 

property Selected: TJamFileListItem read GetSelected write SetSelected; 

Returns the index of the selected item. 

 

property SelectedPath: UnicodeString read GetSelectedPath; 

Returns the full path for the selected item.  

 

property SelectedPaths: TFilenames read GetSelectedPaths; 

Returns a list with the full paths for the selected items.  

 

property ShowColumnHeaders; 

Determines whether the column headers are displayed.  

 

property ShowContextMenuOnTop: Boolean read GetShowContextMenuOnTop write SetShowContextMenuOnTop; 

Show the context menu on the top of the supplied Delphi TPopupMenu.  

 

property ShowHint; 

ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control. 

 

property ShowOverlayIcons: Boolean read fShowOverlayIcons write SetShowOverlayIcons default false; 

If set to false, no overlay icons will be shown, which improves the performance of the control.  

 

property SortColumn; 

The column according to which the listed objects are sorted.  

 

property SortedBy; 

The TShellColumnId of the column the view is currently sorted by.  

 

property SortOrder; 

The current sort order of the view.  

 

property StateImages; 

Specifies additional icon images to display next to each item in the list view. 

 

property TabOrder; 

Indicates the position of the control in its parent's tab order. 

 

property TabStop default true; 

Determines whether the user can tab to a control. 

 

property UseSystemFont; 

Set this property to true if you want the component to utilize the default system font.  

 

property Visible; 

Determines whether the component appears onscreen.  

 

Name 

Description 

 

property AutomaticRefresh default true; 

Receives notifications about changes in the shell and performs refreshes automatically.  

 

property AutoSizeColumn; 

Adjust the size of the given column so that it fills the remaining horizontal space.  

 

property CheckedDrives: TFilenames read GetCheckedDrives; 

Returns a list of the checked drives.  

 

property CheckIfExists; 

Offers the possibility to add items that do not exist in the file system.  

 

property DefaultUpdateInterval: Cardinal read fDefaultUpdateInterval write fDefaultUpdateInterval default cDefaultUpdateInterval; 

Refresh interval for the contents of the DriveList. If 0 no regular refresh will take place.  

 

property DoubleBuffered; 

Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.  

 

property ErrorColor: TColor read fErrorColor write fErrorColor default clRed; 

The color free percentage column exceeding the ErrorLevelPercent threshold.  

 

property ErrorLevelPercent: Integer read fErrorLevel write fErrorLevel default 2; 

If the free space on the drive is below this value, the bar will be drawn in red. 

 

property ExcludeList: TJamPathList read fExcludeList write SetExcludeList; 

The ExcludeList contains drives, which should not be displayed in the TJamDriveList.  

 

property FileSystemOnly default False; 

If true virtual objects that do not have a physical path are not accepted. Default value is false.  

 

property Initialized; 

This property indicates whether the DriveList has been initialized.  

 

property IsSorted default true; 

Turns sorting in the list on or off.  

 

property MultiSelect default false; 

Determines whether the user can select more than one list item at a time.  

 

property OleDragDrop default false; 

Allow drag and drop operations with the Explorer.  

 

property OnCanResize; 

Occurs when an attempt is made to resize the control. 

 

property OnEdited; 

This event is fired when an item has been edited.  

 

property OnEditing; 

This event is fired when an item is being edited.  

 

property ParentDoubleBuffered; 

ParentDoubleBuffered is a boolean indicating that the DoubleBuffered property of this component is overridden by the value of the parent's DoubleBuffered property. 

 

property ReadOnly default true; 

Prevents operations that change the file system from being executed.  

 

property ShowShellObjectNames: Boolean read fShowShellObjectNames write SetShowShellObjectNames default true; 

Determines whether the shell object name should be displayed.  

 

property StatusBarColor: TColor read fStatusBarColor write SetStatusBarColor default $00FF9090; 

The color for the status bar that shows the free percentage.  

 

property StyleElements; 

Specifies the style elements that are used by the control. 

 

property StyleName; 

Specifies the style name for this control. 

 

property Touch; 

Touch specifies the touch manager component associated with the control.  

 

property WarnColor: TColor read fWarnColor write fWarnColor default clYellow; 

The color free percentage column exceeding the WarnLevelPercent threshold.  

 

property WarnLevelPercent: Integer read fWarnLevel write fWarnLevel default 8; 

If the free space on the drive is below this value, the bar will be drawn in yellow. 

 

Name 

Description 

 

constructor Create(AOwner: TComponent); override; 

Creates and intializes an instance of this component.  

 

destructor Destroy; override; 

Destroys an instance of a TJamBaseShellListView component  

 

Name 

Description 

 

constructor Create(AOwner: TComponent); override; 

Constructor of an instances of a TJamCustomFileList component  

 

destructor Destroy; override; 

Destructor of an instances of a TJamCustomFileList component  

 

Name 

Description 

 

constructor Create(AOwner: TComponent); override; 

Creates an instance of a TJamDriveList component  

 

destructor Destroy; override; 

Destroys an instance of a TJamDriveList component  

 

Name 

Description 

 

property OnAfterShellColumnChanged: TOnAfterShellColumnChangedEvent read fOnAfterShellColumnChanged write fOnAfterShellColumnChanged; 

This event is triggered before the user changes the columns by using the header context menu.  

 

property OnBeforeShellColumnChanged: TOnBeforeShellColumnChangedEvent read fOnBeforeShellColumnChanged write fOnBeforeShellColumnChanged; 

This event is triggered before the user changes the columns by using the header context menu.  

 

property OnGetColumnInfo: TOnGetColumnInfo read fOnGetColumnInfo write fOnGetColumnInfo; 

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.  

 

property OnSort: TOnSort read fOnSort write fOnSort; 

This event is triggered before and after the sort. 

 

Name 

Description 

 

property OnAddItem: TOnAddItem read fOnAddItem write fOnAddItem; 

This event is fired if a file is to be added to the listview.  

 

property OnAddPath: TOnAddPath read fOnAddPath write fOnAddPath; 

OnAddPath occurs, whenever a new path is added to the listview.  

 

property OnBeforeCommand: TOnBeforeCommand read GetOnBeforeCommand write SetOnBeforeCommand; 

The OnBeforeCommand event is fired before a command (usually a context menu command) is executed.  

 

property OnBeforeShellCommand: TOnBeforeShellCommand read GetOnBeforeShellCommand write SetOnBeforeShellCommand; 

This event occurs, before a context menu command is executed. This event is deprecated and will be removed. Use Jam.Shell.Controls.BaseShellListView.TJamCustomFileList.OnBeforeCommand instead.  

 

property OnBeforeShellDrag: TOnBeforeShellDragEvent read fOnBeforeShellDrag write fOnBeforeShellDrag; 

Happens when the user starts a shell drag operation.  

 

property OnBeforeShellDrop: TOnBeforeShellDropEvent read fOnBeforeShellDrop write fOnBeforeShellDrop; 

Allows you to prevent unwanted shell drops.  

 

property OnCheckStateChanged; 

This event is fired, if the state of a checkbox was changed by the user.  

 

property OnOperation; 

The OnOperation event occurs after a shell operation like pasting or dragging and dropping files was performed.  

 

Name 

Description 

 

property OnDriveSpaceChanged: TOnDriveSpaceChanged read fOnDriveSpaceChanged write fOnDriveSpaceChanged; 

The OnDriveSpaceChanged event is fired, when the total or free space of one of the listed drives changes.  

 

property OnListItemAction: TOnListItemEvent read fOnListItemEvent write fOnListItemEvent; 

This event occurs after the existance of DriveListItems has been checked asnchronously.  

 

property OnShellNotification; 

This event occurs, when the DriveList receives shell notifications.