FileList Class

Constructs a FileList object

Gets the ImageList that is currently used.

Use this property to turn on or off drag support with the Windows Explorer.

Use this property to turn on or off drop support with the Windows Explorer.

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.

Whether to allow duplicates in the Filelist or not, the default is to allow them. If AllowDuplicates is set to false, insertion to the FileList may get significantly slower for large sets of files.

Set this property to true if you like the component to be refreshed automatically if a Drive is added or removed. This property is directly connected to the Enabled property of an internal instance of ShellChangeNotifier.

Indicates whether automatic refresh is enabled or not.

The delay in milliseconds after that the control scrolls automatically during a drag and drop operation. A value of 0 disables the auto scroll feature.

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

Gets or sets the ContextMenuStrip that is displayed if no item of the listview is under the cursor if the user clicks the right mouse button. If this value is null, no ContextMenu is shown.

Use this property to turn on or off the checkboxes for file and folder selection. The checkboxes will only work, if a ShellControlConnector has been assigned to the ShellControlConnector property of this component. It will automatically synchronize the selection state of the items in multiple shell controls linked together with this ShellControlConnector.

Use this property to display checkboxes for the control.

Refer to the SelectionList property to determine which items are selected. Please do not use this property, it is currently not supported. The CheckBoxes in an ordinary ListView do not support the grayed CheckState furthermore the ListView does not support them at all in View TileView.

If set to true, it is checked whether the files that are added to the list do exist on the filesystem.

true if m_SelectedFiles should contain whole paths instead of files only.

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

Gets or sets the ToolStripRenderMode of the BackgroundContextMenu and the HeaderContextMenu.

The ContextMenuStrip is converted to an ordinary ContextMenu. This makes it possible to merge your ContextMenuStrip with the Default ShellContextMenu provided by the system. The "Opening" and "Closing" events of the ContextMenuStrip will be raised if the ContextMenu "Popup"/"Collapse" event occurs. For menu items only the "Click" event is available. All other events are not available. All ToolStripMenuItems are converted, and ToolStripSeparators are recognized. The ShortCut Keys defined in a ToolStripMenuItem are not converted. If you would like to have the ShortCut-Keys, leave this Property null, instead set the ContextMenu property to your menu explicitly.

Copy mode allows you to control the behaviour when files or folders get dropped.

Overwriting the CreateParams property to set the WS_VISIBLE flag; bug #8960

Gets a value indicating whether the design mode.

Local variable to detect whether the mouse is clicked or dragged

Local variable to detect whether the mouse is clicked or dragged

During a drag and drop operation that origins in this control this member contains the IDataObject. Filled in the ItemDrag method of the control.

Gets or sets the item on that a current drag and drop operation would be executed.

During a drag and drop operation this member contains the IDataObject that is dragged over the control. Filled in DragEnter.

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 live folder thumbnails reflecting the contents of the folder.

The font used to display text in the control.

Gets or sets the ContextMenuStrip that will be shown if the user rightclicks on the headerbar. Get: If it's null, we generate a list of available columns.

Returns the area occupied by the ListView header.

Gets or sets a value indicating whether the selected item in the control remains highlighted when the control loses focus.

The column index of the column containing the parent folder of a file.

Internal attribute is used by classes deriving from JamBaseShellListView.

Gets the columns as JamShellColumnCollection.

Gets a value indicating whether this object is currently in edit-mode.

Gets a value indicating whether the component is initialized.

The value this property is true between the calls BeginInit() and EndInit() of the ISupportInitialize interface.

Gets a collection containing all items in the control.

This dictionary contains LIST_ITEM entries sorted by filename, for fast access

Gets or sets an ImageList holding images that can be used as custom images in small viewstates.

Gets or sets a list of large images.

This property is always false for FileList and DriveList.

The number of system columns without the columns added by the user.

The value of the OwnerDraw property must always be true. This is why the Property is reimplemented here. The setting to false is ignored, and a debug message is shown.

Contains the files that were pasted during a Paste operation.

Prevents operations that change the file system from being executed.

The SearchOptions are used to set different options before calling the Search(String) method.

This property provides access to a list of all files including their extension, which are currently selected in the ShellListView. Dependent on the user settings, the file names in the ListView may be displayed without extension, which makes it difficult to further process them when they are accessed only by the SelectedItems property. You can also use the SelectedFiles property to add files to the selection by using SelectedFiles.Add method.

Simple getter/setter for m_SelectedFiles, for use by deriving classes.

Gets the items that are selected in the control.

Gets or sets the shellbrowser instance.

Returns the reference to the ShellChangeNotifier that is associated with this instance.

Indicates whether the Windows ShellContextMenu should be shown or not.

Connects this control to a ShellControlConnector component, which allows to synchronize several shell controls.

Activates/deactivates the internal drag drop handling of the component.

If set, compressed files and folders will be shown in that particular Color, show normally otherwise (if null).

If set, encrypted files and folders will be shown in that particular color, show normally otherwise (if null).

If set to true, the context menu will be shown if a right click event occurs.

If set to true the ShellList component will show a MessageBox if an error occured, otherwise the errors will only be logged to the Debug output.

Obsolete: Use ViewState.ExtraLargeIcons instead.

Whether to show the informational shell tooltips, the default is true

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

If set to to 'true', the shell context menu will be shown on top of the provided popup menu. If set to 'false', the shell context menu will be shown below the provided popup menu. The value true is currently not supported. The menu items will be shown correctly, however their Click event cannot be triggered.

Gets or sets an ImageList holding images that can be used as custom images in small viewstates.

Gets or sets a list of small images.

The column according to which the listed objects are sorted. If this is set to a negative value, sorting is disabled by setting SortOrder to SortOrder.None, this is useful to insert large amounts of items, e.g. during a search.

Gets or sets the current sort order.

Gets or sets the sort order for items in the control.

Get or set the color of the frame that is drawn around the thumbnails. If this value is set to null, no frame will be shown.

Gets or sets preferences whether to display file icons or thumbnails in the list.

Obsolete: Use ViewState.Thumbnails instead.

Use the ThumbnailSize property to get or set the size in pixels of the thumbnail images.

This property returns the number of files in the FileList. If the FileList contains folders the files in those particular folders are also counted.

This property returns the size of all files in the FileList. If the FileList contains folders, the foldersize is determined recursively.

Returns an array of the currently used ShColumnIds.

If true, the slow tooltip that contains additional information like the folder size is used. Setting this value to false increases the performance.

Set this property to true if you want the component to utilize the default system font. It is also set to true if the UseSystemStyles property is set.

Use this property to turn on or off the usage of the system specific design, i.e. enable Vista visual styles of the explorer components.

Whether to use the system threadpool to obtain information on listview items. If this property is false (the default value), the complete file detail information is retrieved as soon as the item is displayed the first time within the listview. Sometimes it is useful to have all file information fetched as soon as possible without loosing userinterface responsiveness. If set to true, the item information for all files in the listview is additionally fetched from the background this further enhances performance on multicore systems.

The current version of the ShellBrowser.

Gets or sets the vertical scroll position.

Overrides the ListView.View property. Use ViewState instead.

Gets or sets how items are displayed in the ShellListView control.

Not supported.

Not supported.

Adds a path to the filelist. The item is initialized unchecked and it is assumed, that it is no duplicate entry.

Adds a path to the filelist. The item is initialized with state given in checked parameter and it is assumed, that it is no duplicate entry.

Adds a file or path to the list.

Creates a new list item and adds it to the passed temporary list.

Adds a shell column to the list view.

Adds a shell column with the given width to the list view.

Adds a list of paths to the filelist. The items are initialized to be unchecked. It is assumed that the paths do not contain duplicates. If you want pass a filelist that may contain duplicates, use the AddStrings(IEnumerableString, Boolean, Boolean) method.

Adds a list of paths to the filelist. It is assumed that the paths do not contain duplicates. If you want pass a filelist that may contain duplicates, use the AddStrings(IEnumerableString, Boolean, Boolean) method.

Adds a list of paths to the filelist. It is assumed that the paths do not contain duplicates. If you want to pass a filelist that may contain duplicates, use the AddStrings(IEnumerableString, Boolean, Boolean) method.

Calls the original inherited OnDragDrop method.

For use by subcontrols, that need to check the availability of the BeforeShellCommand event.

Signals the object that initialization is starting.

Sets the Checked state of all Items to "checked" (true).

This method is currently a surrogate for the implementation of the checkbox functionality that will follow.

Removes all items from the FileList

Clears the current columns and the header context menu. Please use this method instead of ListView.Columns.Clear().

Compares two FileListItem objects by their ItemIdList with each other.

Completes the details of an item, like image index, sub items etc.

Creates a new ListItem

Compares the given items by the content of the subitems at the SortColumn index.

Shows the BackgroundContextMenu if it is non-null.

Shows the shell context menu for the currently selected items

Shows the shell context menu for the currently selected items

Handles the HeaderRightClick event.

Remove reference to ShellControlConnector and implicitely remove this control from the list of known controls of the ShellControlConnector

Autosizes the column that is set in AutoSizeColumn.

Calls the BeforeShowContextMenu event if assigned.

Sets system specific behaviour, i.e. FullRowSelect in Vista and upwards.

Signals the object that initialization is complete. After this method is called, IsInitialized is true to indicate the state of the control.

Override this method to implement/extend your own FileMatching mechanism.

Finalizes the column visibility change. The sort column is checked and the column order updated.

finds the position where to display the context menu based upon the currently selected items and their positions

Searches for the first list item with the given ItemIdList.

Returns the ListItem for the given path.

Gets called if the active folder should change.

This method removes not existing items if the property CheckIfExists is true.

Gets the type of the column header collection.

Retrieve the order in which columns appear.

Get the full path of an item.

Get the fullpath of an item at the index specified.

Returns the local index for the given ShellColumnID (if the column is existing and visible)

Returns the local index for the given ShellColumnID.

Gets the type of the item collection.

Returns the IComparer that should be used for sorting.

Gets the type of the selected item collection.

Gets the items the command will be executed upon.

Retrieve the bounds of a ListViewSubItem

Returns for the currently selected item a COM object that implements the requested interface.

Goes up one directory level.

Hides the column with the passed SHCOLUMNID.

Initializes the columns by reading the column headers from the users personal folder.

For internal use: invalidates the current sort column.

Invokes the given command on the selected items. See ShellCommand class for a list of possible commands.

Guarding/helper method for InvokeCommandOnSelected(ShellCommand) suppressing exceptions when executing commands that don't work in readonly mode.

Returns whether the given column id is currently visible or not.

Returns whether the given SHColumnId is currently visible or not.

Determines whether the column with the specified shellcolumnId is a column shown by default.

Checks whether the given column index is a custom or shell column

Checks if the list is empty.

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

Returns the ListItem for the given ItemIdList

Error method that displays an error messagebox if the property ShowErrorMessages is set. The message is always written to the debug output stream

Error method that displays an error messagebox if the property ShowErrorMessages is set. The message is always written to the debug output stream

Raises the AddItem event.

Is called after the command has been called.

Override the OnAfterLabelEdit event, to rename files or folders in the file system, when the have been renamed in the ShellListView.

Is called before the command is called.

Override the OnBeforeLabelEdit event, to prepare renaming a file or folder in the ShellListView.

Calls the BeforeShellColumnChanged event if it is assigned.

Calls the BeforeShellDrop event if it is assigned.

Calls the BeforeShowContextMenu event.

Fires an event if the CheckState of an item has changed.

Sort the column, which is clicked.

Tracks column widths. Raises the System.Windows.Forms.ListView.ColumnWidthChanged event.

Prevents changes at designtime. Raises the ColumnWidthChanging event.

Fires an event after the columns have been created

Raises the CreateControl method.

Overrides the OnDoubleClick eventhandler to invoke the default command on the selected item.

This member overrides OnDragDrop(DragEventArgs)

This member overrides OnDragEnter(DragEventArgs)

This member overrides OnDragLeave(EventArgs)

This member overrides OnDragOver(DragEventArgs)

This member overrides OnDrawColumnHeader(DrawListViewColumnHeaderEventArgs).

This member overrides OnDrawItem(DrawListViewItemEventArgs).

Fires an event that a file matches the default search criteria if the user registers to the SearchFileMatches event the user can further decide whether the file should match.

Handles the OnHandleCreated event and e.g. initializes the image list

Tracks the handle destruction.

Eventhandler for a HeaderContextMenuClick.

Raises the HeaderRightClick-Event

Calls raising of the OnItemCheckedEvent.

This member overrides OnItemDrag(ItemDragEventArgs)

Executes the item list changed action.

This method is extended to show tool tip texts of the particular shell objects.

Overrides the OnKeyDown eventhandler.

Calls the LoadItem event with the passed parameters.

Raises the System.Windows.Forms.Control.MouseDown event.

Raises the System.Windows.Forms.Control.MouseEnter event.

Raises the System.Windows.Forms.Control.MouseLeave event.

Overrides the OnMouseUp event, to handle e.g. double clicks and right clicks on files or folders and the selection of files or folders, when the CheckBoxes are switched on.

This method is called if a notification event is performed on the message pump WndProc(Message)

Fires an event if an operation was performed on the JamBaseShellListView.

Helper function for OnOperation(ShellOperation, PathCollection, String, Exception) to avoid type conversion.

Raises the OnResize event.

Fires an event if the Search has completed.

Fires an event if the Search has completed.

Calls the ShowOptionChanged event if it is assigned.

Prepares the selected items in the list for being used with the m_ShellBrowser, an instance of ShellBrowser.

Prepares the selected items in the list for being used with the m_ShellBrowser, an instance of ShellBrowser.

This method preserves the Windows Vista light blue selection line if UseSystemStyles is on. The Setting is lost if e.g. a column is clicked to sort things.

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

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

Removes an item from the list.

Removes an item from the list.

Removes the list element from the list

Resets the SpecialFolder of the internal ShellBrowser. This is especially needed for Column or subitem initialization.

Resets the columns to the initial state.

Resets all items so the next time their CompleteDetails method is called, the information is retrieved again.

Resets the items and their subitems.

Restores the selection and checkstate of the item.

Counterpart of SaveState. Restores properties and contents of the ListView.

Returns the item that is associated to the filename given as a parameter. Uses the SortedDictionary that is maintained within the FileList to determine whether the p_FileName is contained as a key if the AllowDuplicates property is set to true. Otherwise it iterates through the list of items in O(n) to find the first entry.

Saves the checked items.

Saves the column settings.

Saves the current selection and checked items to a temporary List.

Saves the column properties of the current view, so that it can be restored later.

Scales a control's location, size, padding and margin.

Searches the path given in the parameter for patterns defined in the SearchOptions property.

Searches the paths given in the parameter for patterns defined in the SearchOptions property.

Searches the path given in the parameter for patterns defined in the SearchOptions property.

Searches the paths given in the parameter for patterns defined in the SearchOptions property.

Searches the paths given in the parameter for patterns defined in the SearchOptions property.

Call this method to cancel a pending search.

Selects all items in a ShellFileList.

Selects all items.

Gets called if the selected file should change.

Selects the ListItem that corresponds to the given ItemIdList.

Selects the ListItem that corresponds to the given ItemIdList.

Set the sort icon among the current sort order in the passed column.

Sets the order in which columns appear.

Sets the visibility of a column.

Sets the visibility of a column.

Sets the font without adjusting other properties.

Sets and applies the SortColumn in ascending.

Sets and applies the sortrder.

Shows the column with the passed ShellColumnId.

This method is left empty in the CustomFileListT and FileList classes.

Sorts the items of the list view. Uses a custom sort order if an IComparer is assigned to property ListViewItemSorter. If no custom sortorder is supplied the default sorting handles sorting by columns and is only useful in Details. In this case SortColumn must be non-negative.

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

Updates the sort icon in the column of the ShellListView.

Updates the subitems after a column gets visible.

Overrides WndProc(Message).

This event is fired if a file is to be added to the listview. It is possible to change details of the item or to prevent adding the file by setting the CanAdd flag in the AddItemEventArgs to false.

Assign this event to be able to control the behaviour of the control when the user double-clicks on an item to start the default action

This event is fired when a column is selected/deselected from the context menu of the list header.

This event is fired when a shell command is to be executed, ie. via the context menu It is possible to permit the execution of the shell command by modifying the BeforeShellCommandEventArgs

This event is fired before a ListView that inherits from JamBaseShellListView executes a shell drop.

This event is called before the ShellContextMenu is displayed. You may use it to cancel the context menu appearing or to modify the custom menu entries in the ContextMenuStrip.

This event is fired when the state of a checkbox was changed by the user or if it was changed internally via checkstate synchronization of other controls.

This event occurs if the FileList is cleared by calling the clear() method.

This event is fired after the columns were created.

The event is triggered when the user right clicks on the column headers.

This event is fired after the initialization of the component.

Occurs when the checked state of an item was changed by the user.

This event occurs if the FileList changed, ie. an item was removed, added or the list is cleared.

This event occurs if the user moved the mouse over a listview item so a tooltip can appear, this event also occurs if no ToolTipText is set, it can be added dynamically.

This event is called, when the data for an item is loaded.

This event is fired after a JamBaseShellListView executed a shell operation like copying.

This event is issued if a file is removed from the listview.

This event is fired when a search operation is complete, has been cancelled, or an exception has been thrown.

This event is fired everytime an exception occurs when a single item is processed during the search process. It is possible to handle or ignore the exception and mark this in the SearchExceptionEventArgs If e.g. the exception is permanent and is left unhandled the search will cancel, a SearchCompleted event will immediately follow which passes the Exception in the event args again, so it can be finally handled.

Register to this event if you want to further investigate the files the component examines. In the FileMatchEventArgs you have access to the Filename and can explicitly specify whether the file matches, e.g. after you performed a pattern match within the data of the file.

This event is fired everytime the progress of the searcher changes, that is when new items are filled to the FileList.

This event is fired after a display option, like e.g. the ViewState changed.

This event occurs if the FileList.TotalFileCount or FileList.TotalFileSize were refreshed.

This event is fired for each item in Thumbnail view. It can be used to update the thumbnail.

Zero-based index of the initial sort column. -2 means: Default value not overriden or already applied

The current sort order as index of column.

The shell index of the sort column. Default is 0 - the name column.

The initial sort order.

A Control extension method that ensures that the handle for a control is created.

An extension method for controls: It scales the passed pixels according to the current dpi the control is displayed with.

A Control extension method that scales font according to the passed factor.