Click or drag to resize

FileList Class

Use the Filelist if you want to search for files or folders within a specific path. You can also display several files residing in different folders, and allow the user to use drag&drop operations to manage the files.

 

Items that are contained in the list are of type FileListItem. This applies to the Items and the SelectedItems properties.
Inheritance Hierarchy

Namespace:  Jam.Shell
Assembly:  ShellBrowser (in ShellBrowser.dll) Version: 6.1
Syntax
public class FileList : CustomFileList<FileListItem>, 
	IFileMatcher

The FileList type exposes the following members.

Constructors
  NameDescription
Public methodFileList
Constructs a FileList object
Top
Properties
  NameDescription
Public propertyAllowDrag
Use this property to turn on or off drag support with the Windows Explorer.
(Inherited from JamBaseShellListView.)
Public propertyAllowDrop
Use this property to turn on or off drop support with the Windows Explorer.
(Inherited from JamBaseShellListView.)
Public propertyAllowDropToTheBackground
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.
(Inherited from CustomFileListT.)
Public propertyAllowDuplicates
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.
(Inherited from CustomFileListT.)
Public propertyAutomaticRefresh
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.
(Inherited from JamBaseShellListView.)
Public propertyAutoScrollDelay
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.
(Inherited from CustomFileListT.)
Public propertyAutoSizeColumn
Adjust the size of the given column so that it fills the remaining horizontal space.
(Inherited from JamBaseShellListView.)
Public propertyBackgroundContextMenu
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.
(Inherited from SystemListView.)
Protected propertyBackgroundWorker
Returns the Backgroundworker that is associated with each FileList instance. The BackgroundWorker is the required and preferred way to asynchronously add items to a component from a different thread. See http://msdn2.microsoft.com/en-us/library/ms171728.aspx.
(Inherited from CustomFileListT.)
Public propertyCheckBoxes
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.
(Inherited from CustomFileListT.)
Public propertyCheckedItems
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.
(Inherited from JamBaseShellListView.)
Public propertyCheckIfExists
If set to true, it is checked whether the files that are added to the list do exist on the filesystem.
(Inherited from CustomFileListT.)
Public propertyColumns
Gets the collection of all column headers that appear in the control.
(Inherited from JamBaseShellListView.)
Public propertyContextMenuStrip
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.
(Inherited from JamBaseShellListView.)
Public propertyCopyMode
Copy mode allows you to control the behaviour when files or folders get dropped.
(Inherited from CustomFileListT.)
Protected propertyCreateParams
Overwriting the CreateParams property to set the WS_VISIBLE flag; bug #8960
(Inherited from SystemListView.)
Protected propertyDropItem
Gets or sets the item on that a current drag and drop operation would be executed.
(Inherited from JamBaseShellListView.)
Public propertyFont
The font used to display text in the control.
(Inherited from JamBaseShellListView.)
Public propertyHeaderMenuStrip
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.
(Inherited from JamBaseShellListView.)
Protected propertyHeaderRectangle
Returns the area occupied by the ListView header.
(Inherited from SystemListView.)
Public propertyHideSelection
Gets or sets a value indicating whether the selected item in the control remains highlighted when the control loses focus.
(Inherited from SystemListView.)
Public propertyInFolderColumnIndex
The column index of the column containing the parent folder of a file.
Protected propertyInternalColumns
Gets the columns as JamShellColumnCollection.
(Inherited from JamBaseShellListView.)
Public propertyIsDropTarget Obsolete.
Gets or sets if this controls is a drop target or not.
(Inherited from JamBaseShellListView.)
Protected propertyIsEditing
Gets a value indicating whether this object is currently in edit-mode.
(Inherited from JamBaseShellListView.)
Public propertyIsInitialized
Gets a value indicating whether the component is initialized.
(Inherited from JamBaseShellListView.)
Public propertyIsInitializing
The value this property is true between the calls BeginInit() and EndInit() of the ISupportInitialize interface.
(Inherited from JamBaseShellListView.)
Public propertyItems
Gets a collection containing all items in the control.
(Inherited from CustomFileListT.)
Protected propertyItemsDictionary
This dictionary contains LIST_ITEM entries sorted by filename, for fast access
(Inherited from CustomFileListT.)
Public propertyNoFillOnStartup
This property is always false for FileList and DriveList.
(Inherited from CustomFileListT.)
Protected propertyNumShellColumns
The number of system columns without the columns added by the user.
(Inherited from JamBaseShellListView.)
Public propertyOwnerDraw
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.
(Inherited from CustomFileListT.)
Protected propertyPastedFiles
Contains the files that were pasted during a Paste operation.
(Inherited from JamBaseShellListView.)
Public propertyReadOnly
Prevents operations that change the file system from being executed.
(Inherited from CustomFileListT.)
Public propertySearchOptions
The SearchOptions are used to set different options before calling the Search(String) method.
Public propertySelectedFiles
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.
(Inherited from JamBaseShellListView.)
Public propertySelectedItems
Gets the items that are selected in the control.
(Inherited from CustomFileListT.)
Public propertyShellBrowser
Gets or sets the shellbrowser instance.
(Inherited from JamBaseShellListView.)
Protected propertyShellChangeNotifier
Returns the reference to the ShellChangeNotifier that is associated with this instance.
(Inherited from JamBaseShellListView.)
Public propertyShellContextMenu
Indicates whether the Windows ShellContextMenu should be shown or not.
(Inherited from JamBaseShellListView.)
Public propertyShellControlConnector
Connects this control to a ShellControlConnector component, which allows to synchronize several shell controls.
(Inherited from JamBaseShellListView.)
Public propertyShellDragDrop
Activates/deactivates the internal drag drop handling of the component.
(Inherited from SystemListView.)
Public propertyShowColorCompressed
If set, compressed files and folders will be shown in that particular Color, show normally otherwise (if null).
(Inherited from CustomFileListT.)
Public propertyShowColorEncrypted
If set, encrypted files and folders will be shown in that particular color, show normally otherwise (if null).
(Inherited from CustomFileListT.)
Public propertyShowContextMenu
If set to true, the context menu will be shown if a right click event occurs.
(Inherited from JamBaseShellListView.)
Public propertyShowErrorMessages
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.
(Inherited from JamBaseShellListView.)
Public propertyShowExtraLargeIcons
Obsolete: Use ViewState.ExtraLargeIcons instead.
(Inherited from JamBaseShellListView.)
Public propertyShowInfoToolTips
Whether to show the informational shell tooltips, the default is true
(Inherited from JamBaseShellListView.)
Public propertyShowOverlayIcons
If set to 'false', no overlay icons will be shown, which improves the performance of the control.
(Inherited from CustomFileListT.)
Public propertyShowShellContextMenuOnTop
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.
(Inherited from JamBaseShellListView.)
Public propertySortColumn
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.
(Inherited from JamBaseShellListView.)
Public propertySortColumnShellID
Gets or sets the current sort order.
(Inherited from JamBaseShellListView.)
Public propertySorting
Gets or sets the sort order for items in the control.
(Inherited from JamBaseShellListView.)
Public propertyThumbnailBorderColor
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.
(Inherited from JamBaseShellListView.)
Public propertyThumbnails
Obsolete: Use ViewState.Thumbnails instead.
(Inherited from JamBaseShellListView.)
Public propertyThumbnailSize
Use the ThumbnailSize property to get or set the size in pixels of the thumbnail images.
(Inherited from JamBaseShellListView.)
Public propertyTotalFileCount
This property returns the number of files in the FileList. If the FileList contains folders the files in those particular folders are also counted.
Public propertyTotalFileSize
This property returns the size of all files in the FileList. If the FileList contains folders, the foldersize is determined recursively.
Public propertyUsedShColumnIds
Returns an array of the currently used ShColumnIds.
(Inherited from JamBaseShellListView.)
Public propertyUseSlowInfoTip
If true, the slow tooltip that contains additional information like the folder size is used. Setting this value to false increases the performance.
(Inherited from JamBaseShellListView.)
Public propertyUseSystemFont
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.
(Inherited from SystemListView.)
Public propertyUseSystemStyles
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.
(Inherited from SystemListView.)
Public propertyUseThreadPool
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.
(Inherited from CustomFileListT.)
Public propertyVersion
The current version of the ShellBrowser.
(Inherited from JamBaseShellListView.)
Protected propertyVerticalScrollPos
Gets or sets the vertical scroll position.
(Inherited from JamBaseShellListView.)
Public propertyView
Overrides the ListView.View property. Use ViewState instead.
(Inherited from JamBaseShellListView.)
Public propertyViewState
Gets or sets how items are displayed in the ShellListView control.
Public propertyVirtualListSize
Not supported-
(Inherited from JamBaseShellListView.)
Public propertyVirtualMode
Not supported-
(Inherited from JamBaseShellListView.)
Top
Methods
  NameDescription
Public methodAdd(String)
Adds a path to the filelist. The item is initialized unchecked and it is assumed, that it is no duplicate entry.
(Inherited from CustomFileListT.)
Public methodAdd(String, Boolean)
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.
Public methodAdd(String, Boolean, Boolean)
Adds a file or path to the list.
(Inherited from CustomFileListT.)
Protected methodAddPathToTempList
Creates a new list item and adds it to the passed temporary list.
(Inherited from CustomFileListT.)
Protected methodAddShellColumn(Int32)
Adds a shell column to the list view.
(Inherited from JamBaseShellListView.)
Protected methodAddShellColumn(Int32, Int32)
Adds a shell column with the given width to the list view.
(Inherited from JamBaseShellListView.)
Public methodAddStrings(String)
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.
(Inherited from CustomFileListT.)
Public methodAddStrings(String, Boolean)
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.
(Inherited from CustomFileListT.)
Public methodAddStrings(IEnumerableString, Boolean, Boolean)
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.
(Inherited from CustomFileListT.)
Protected methodBaseOnDragDrop
Calls the original inherited OnDragDrop method.
(Inherited from JamBaseShellListView.)
Public methodBeginInit
Signals the object that initialization is starting.
(Inherited from JamBaseShellListView.)
Public methodCheckAll
Sets the Checked state of all Items to "checked" (true).
(Inherited from CustomFileListT.)
Protected methodCheckBoxHit
This method is currently a surrogate for the implementation of the checkbox functionality that will follow.
(Inherited from CustomFileListT.)
Protected methodCleanUpThumbnails
This method cleans up the currently loaded thumbnails and created a new image list.
(Inherited from JamBaseShellListView.)
Public methodClear
Removes all items from the FileList
(Inherited from CustomFileListT.)
Public methodClearColumns
Clears the current columns and the header context menu. Please use this method instead of ListView.Columns.Clear().
(Overrides JamBaseShellListViewClearColumns.)
Public methodCompare
Compares two FileListItem objects by their ItemIdList with each other.
(Overrides JamBaseShellListViewCompare(Object, Object).)
Protected methodCompleteDetails
Completes the details of an item, like image index, sub items etc.
(Overrides CustomFileListTCompleteDetails(T).)
Protected methodCreateListItem
Creates a new ListItem
(Inherited from CustomFileListT.)
Protected methodCustomCompare
Compares the given items by the content of the subitems at the SortColumn index.
(Inherited from JamBaseShellListView.)
Public methodDisplayBackgroundContextMenu
Shows the BackgroundContextMenu if it is non-null.
(Inherited from JamBaseShellListView.)
Public methodDisplayContextMenu
Shows the shell context menu for the currently selected items
(Inherited from JamBaseShellListView.)
Public methodDisplayContextMenu(Point)
Shows the shell context menu for the currently selected items
(Inherited from JamBaseShellListView.)
Protected methodDisplayHeaderContextMenu
Handles the HeaderRightClick event.
(Overrides JamBaseShellListViewDisplayHeaderContextMenu(Object).)
Protected methodDispose
Remove reference to ShellControlConnector and implicitely remove this control from the list of known controls of the ShellControlConnector
(Overrides CustomFileListTDispose(Boolean).)
Protected methodDoAutoSizeColumn
Autosizes the column that is set in AutoSizeColumn.
(Inherited from JamBaseShellListView.)
Public methodEnableSystemStyles
Sets system specific behaviour, i.e. FullRowSelect in Vista and upwards.
(Inherited from SystemListView.)
Public methodEndInit
Signals the object that initialization is complete. After this method is called, m_Initialized is true to indicate the state of the control.
(Inherited from JamBaseShellListView.)
Public methodCode exampleFileMatches
Override this method to implement/extend your own FileMatching mechanism.
Protected methodFinalizeColumnVisibilityChange
Finalizes the column visibility change. The sort column is checked and the column order updated.
(Inherited from JamBaseShellListView.)
Protected methodFindContextMenuPosition
finds the position where to display the context menu based upon the currently selected items and their positions
(Inherited from JamBaseShellListView.)
Protected methodFindItemIdList
Searches for the first list item with the given ItemIdList.
(Inherited from JamBaseShellListView.)
Protected methodFindPath
Returns the ListItem for the given path.
(Inherited from JamBaseShellListView.)
Public methodFolderChanged
Gets called if the active folder should change.
(Inherited from JamBaseShellListView.)
Public methodFullRefresh
This method removes not existing items if the property CheckIfExists is true.
(Inherited from CustomFileListT.)
Protected methodGetColumnHeaderCollectionType
Gets the type of the column header collection.
(Inherited from JamBaseShellListView.)
Public methodGetColumnOrder
Retrieve the order in which columns appear.
(Inherited from SystemListView.)
Public methodGetFullPath(Int32)
Get the fullpath of an item at the index specified.
(Inherited from CustomFileListT.)
Public methodGetFullPath(T)
Get the full path of an item.
(Inherited from CustomFileListT.)
Public methodGetIndexOfShColumnId(SHCOLUMNID)
Returns the local index for the given ShellColumnID (if the column is existing and visible)
(Inherited from JamBaseShellListView.)
Protected methodGetIndexOfShColumnId(SHCOLUMNID, Boolean)
Returns the local index for the given ShellColumnID.
(Inherited from JamBaseShellListView.)
Protected methodGetItemCollectionType
Gets the type of the item collection.
(Inherited from CustomFileListT.)
Protected methodGetListViewItemSorter
Returns the IComparer that should be used for sorting.
(Inherited from CustomFileListT.)
Protected methodGetSelectedItemCollectionType
Gets the type of the selected item collection.
(Overrides CustomFileListTGetSelectedItemCollectionType.)
Public methodGetSelectedItemIdLists
Gets the items the command will be executed upon.
(Inherited from JamBaseShellListView.)
Protected methodGetSubItemBounds
Retrieve the bounds of a ListViewSubItem
(Inherited from SystemListView.)
Protected methodGetUIObject
Returns for the currently selected item a COM object that implements the requested interface.
(Inherited from CustomFileListT.)
Public methodGoUp
Goes up one directory level.
(Inherited from JamBaseShellListView.)
Protected methodHideColumn
Hides the column with the passed SHCOLUMNID.
(Inherited from JamBaseShellListView.)
Protected methodInitColumns
Initializes the columns by reading the column headers from the users personal folder.
(Overrides JamBaseShellListViewInitColumns.)
Protected methodInvalidateSortColumns
For internal use: invalidates the current sort column.
(Inherited from JamBaseShellListView.)
Public methodInvokeCommandOnSelected
Invokes the given command on the selected items. See ShellCommand class for a list of possible commands.
(Inherited from JamBaseShellListView.)
Public methodInvokeContextMenuCommand Obsolete.
Invokes the given shell command on the selected file(s).
(Inherited from CustomFileListT.)
Public methodIsColumnVisible(Int32)
Returns whether the given column id is currently visible or not.
(Inherited from JamBaseShellListView.)
Public methodIsColumnVisible(SHCOLUMNID)
Returns whether the given SHColumnId is currently visible or not.
(Inherited from JamBaseShellListView.)
Protected methodIsColumnVisibleByDefault
Determines whether the column with the specified shellcolumnId is a column shown by default.
(Inherited from JamBaseShellListView.)
Public methodIsCustomColumn
Checks whether the given column index is a custom or shell column
(Inherited from JamBaseShellListView.)
Public methodIsEmpty
Checks if the list is empty.
(Inherited from JamBaseShellListView.)
Public methodIsItemInList
Checks whether an item with the given filename can be found in the list.
(Inherited from CustomFileListT.)
Protected methodItemOfPidl
Returns the ListItem for the given ItemIdList
(Inherited from JamBaseShellListView.)
Protected methodLogError(String)
Error method that displays an error messagebox if the property ShowErrorMessages is set. The message is always written to the debug output stream
(Inherited from JamBaseShellListView.)
Protected methodLogError(String, Exception)
Error method that displays an error messagebox if the property ShowErrorMessages is set. The message is always written to the debug output stream
(Inherited from JamBaseShellListView.)
Protected methodOnAddItem
Raises the AddItem event.
(Inherited from CustomFileListT.)
Public methodOnAfterInvokeCommand
Is called after the command has been called.
(Inherited from JamBaseShellListView.)
Protected methodOnAfterLabelEdit
Override the OnAfterLabelEdit event, to rename files or folders in the file system, when the have been renamed in the ShellListView.
(Inherited from JamBaseShellListView.)
Public methodOnBeforeInvokeCommand
Is called before the command is called.
(Inherited from JamBaseShellListView.)
Protected methodOnBeforeLabelEdit
Override the OnBeforeLabelEdit event, to prepare renaming a file or folder in the ShellListView.
(Inherited from JamBaseShellListView.)
Protected methodOnBeforeShellColumnChanged
Calls the BeforeShellColumnChanged event if it is assigned.
(Inherited from JamBaseShellListView.)
Protected methodOnBeforeShellDrop
Calls the BeforeShellDrop event if it is assigned.
(Inherited from JamBaseShellListView.)
Protected methodOnCheckStateChanged
Fires an event if the CheckState of an item has changed.
(Inherited from JamBaseShellListView.)
Protected methodOnColumnClick
Sort the column, which is clicked.
(Inherited from JamBaseShellListView.)
Protected methodOnColumnWidthChanged
Tracks column widths. Raises the System.Windows.Forms.ListView.ColumnWidthChanged event.
(Inherited from JamBaseShellListView.)
Protected methodOnColumnWidthChanging
Prevents changes at designtime. Raises the ColumnWidthChanging event.
(Inherited from JamBaseShellListView.)
Protected methodOnCreateColumns
Fires an event after the columns have been created
(Inherited from JamBaseShellListView.)
Protected methodOnCreateControl (Inherited from JamBaseShellListView.)
Protected methodOnDoubleClick
Overrides the OnDoubleClick eventhandler to invoke the default command on the selected item.
(Inherited from CustomFileListT.)
Protected methodOnDragDrop
This member overrides OnDragDrop(DragEventArgs)
(Inherited from CustomFileListT.)
Protected methodOnDragEnter
This member overrides OnDragEnter(DragEventArgs)
(Inherited from CustomFileListT.)
Protected methodOnDragLeave
This member overrides OnDragLeave(EventArgs)
(Inherited from CustomFileListT.)
Protected methodOnDragOver
This member overrides OnDragOver(DragEventArgs)
(Inherited from CustomFileListT.)
Protected methodOnDrawColumnHeader (Inherited from CustomFileListT.)
Protected methodOnDrawItem
This member overrides OnDrawItem(DrawListViewItemEventArgs).
(Overrides CustomFileListTOnDrawItem(DrawListViewItemEventArgs).)
Protected methodOnFileMatches
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.
Protected methodOnHandleCreated
Handles the OnHandleCreated event and e.g. initializes the image list
(Inherited from JamBaseShellListView.)
Protected methodOnHeaderContextMenuClick
Eventhandler for a HeaderContextMenuClick.
(Inherited from JamBaseShellListView.)
Protected methodOnHeaderRightClick
Raises the HeaderRightClick-Event
(Inherited from SystemListView.)
Protected methodOnItemChecked
Calls raising of the OnItemCheckedEvent.
(Inherited from JamBaseShellListView.)
Protected methodOnItemDrag
This member overrides OnItemDrag(ItemDragEventArgs)
(Inherited from CustomFileListT.)
Protected methodOnItemListChanged
Executes the item list changed action.
(Inherited from CustomFileListT.)
Protected methodOnItemShowToolTip
This method is extended to show tool tip texts of the particular shell objects.
(Inherited from JamBaseShellListView.)
Protected methodOnKeyDown
Overrides the OnKeyDown eventhandler.
(Inherited from CustomFileListT.)
Protected methodOnMouseDown
Raises the System.Windows.Forms.Control.MouseDown event.
(Inherited from JamBaseShellListView.)
Protected methodOnMouseEnter
Raises the System.Windows.Forms.Control.MouseEnter event.
(Inherited from CustomFileListT.)
Protected methodOnMouseLeave
Raises the System.Windows.Forms.Control.MouseLeave event.
(Inherited from CustomFileListT.)
Protected methodOnMouseUp
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.
(Inherited from JamBaseShellListView.)
Protected methodOnNotifyMessage
This method is called if a notification event is performed on the message pump WndProc(Message)
(Inherited from SystemListView.)
Protected methodOnOperation(ShellOperation, PathCollection, String)
Fires an event if an operation was performed on the JamBaseShellListView.
(Inherited from JamBaseShellListView.)
Protected methodOnOperation(ShellOperation, StringCollection, String)
Helper function for OnOperation(ShellOperation, PathCollection, String) to avoid type conversion.
(Inherited from JamBaseShellListView.)
Protected methodOnResize
Raises the OnResize event.
(Inherited from JamBaseShellListView.)
Protected methodOnSearchCompleted
Fires an event if the Search has completed.
Protected methodOnSearchProgressChanged
Fires an event if the Search has completed.
Protected methodOnShowOptionChanged
Calls the ShowOptionChanged event if it is assigned.
(Inherited from JamBaseShellListView.)
Protected methodPrepareMultiObjects Obsolete.
Prepares the selected items in the list for being used with the m_ShellBrowser, an instance of ShellBrowser.
(Inherited from JamBaseShellListView.)
Protected methodPrepareMultiObjects(ShellBrowser)
Prepares the selected items in the list for being used with the m_ShellBrowser, an instance of ShellBrowser.
(Inherited from CustomFileListT.)
Protected methodPreserveSystemStyle
This method preserves the Windows Vista lightblue selection line if UseSystemStyles is on. The Setting is lost if e.g. a column is clicked to sort things.
(Inherited from SystemListView.)
Public methodRefresh(RefreshLevel)
This method indicates that the control should perform a refresh of its contents.
(Inherited from JamBaseShellListView.)
Public methodRefresh(RefreshLevel, ItemIdList)
This method indicates that the control should perform a refresh of its contents.
(Inherited from JamBaseShellListView.)
Public methodRemove(String)
Removes an item from the list.
(Inherited from CustomFileListT.)
Protected methodRemove(T)
Removes an item from the list.
(Inherited from CustomFileListT.)
Protected methodRemoveItemFromList
Removes the list element from the list
(Inherited from CustomFileListT.)
Protected methodReset
Resets the SpecialFolder of the internal ShellBrowser. This is especially needed for Column or subitem initialization.
(Overrides CustomFileListTReset.)
Public methodResetColumns
Resets the columns to the initial state.
(Inherited from JamBaseShellListView.)
Protected methodResetItemDetails
Resets all items so the next time their CompleteDetails method is called, the information is retrieved again.
(Inherited from CustomFileListT.)
Protected methodResetItems
Resets the items and their subitems.
(Inherited from JamBaseShellListView.)
Public methodReturnItemInList
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.
(Inherited from CustomFileListT.)
Public methodSearch(String)
Searches the path given in the parameter for patterns defined in the SearchOptions property.
Public methodSearch(String)
Searches the paths given in the parameter for patterns defined in the SearchOptions property.
Public methodSearch(String, Boolean)
Searches the path given in the parameter for patterns defined in the SearchOptions property.
Public methodSearch(String, Boolean)
Searches the paths given in the parameter for patterns defined in the SearchOptions property.
Public methodSearch(String, Boolean, Boolean)
Searches the paths given in the parameter for patterns defined in the SearchOptions property.
Public methodSearchCancel
Call this method to cancel a pending search.
Public methodSelectAll
Use SelectAll to select all items in a ShellFileList.
(Inherited from CustomFileListT.)
Protected methodSelectAllItemsInternal
Selects all items.
(Inherited from JamBaseShellListView.)
Public methodSelectedFileChange
Gets called if the selected file should change.
(Inherited from JamBaseShellListView.)
Protected methodSelectPidl(ItemIdList)
Selects the ListItem that corresponds to the given ItemIdList.
(Inherited from JamBaseShellListView.)
Protected methodSelectPidl(ItemIdList, Boolean)
Selects the ListItem that corresponds to the given ItemIdList.
(Inherited from JamBaseShellListView.)
Protected methodSetColumnBitmap
Set the sort icon among the current sort order in the passed column.
(Inherited from SystemListView.)
Protected methodSetColumnOrder
Sets the order in which columns appear.
(Inherited from SystemListView.)
Public methodSetColumnVisibility(Int32, Boolean)
Sets the visibility of a column.
(Inherited from JamBaseShellListView.)
Public methodSetColumnVisibility(SHCOLUMNID, Boolean)
Sets the visibility of a column.
(Inherited from JamBaseShellListView.)
Protected methodSetFont
Sets the font without adjusting other properties.
(Inherited from SystemListView.)
Protected methodSetSortOrder(SHCOLUMNID)
Sets and applies the SortColumn in ascending.
(Inherited from JamBaseShellListView.)
Protected methodSetSortOrder(SHCOLUMNID, SortOrder)
Sets and applies the sortrder.
(Inherited from JamBaseShellListView.)
Protected methodShowColumn
Shows the column with the passed ShellColumnId.
(Overrides JamBaseShellListViewShowColumn(SHCOLUMNID).)
Public methodSmartRefresh (Inherited from CustomFileListT.)
Public methodCode exampleSort
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.
(Inherited from JamBaseShellListView.)
Public methodUnCheckAll
Sets the Checked state of all Items to "unchecked" (false).
(Inherited from CustomFileListT.)
Protected methodUpdateColumnBitmaps
Updates the sort icon in the column of the ShellListView.
(Inherited from JamBaseShellListView.)
Protected methodUpdateSubitemsAfterColumnGetsVisible
Updates the subitems after a column gets visible.
(Overrides JamBaseShellListViewUpdateSubitemsAfterColumnGetsVisible(SHCOLUMNID, Int32).)
Protected methodWndProc (Inherited from JamBaseShellListView.)
Top
Events
  NameDescription
Public eventAddItem
This event is fired if a file is to be added to the listview. It is possible to prevent adding the file by setting the CanAdd flag in the AddItemEventArgs to false.
(Inherited from CustomFileListT.)
Public eventBeforeInvokeCommandOnSelected Obsolete.
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
(Inherited from SystemListView.)
Public eventBeforeShellColumnChanged
This event is fired when a column is selected/deselected from the context menu of the list header.
(Inherited from JamBaseShellListView.)
Public eventCode exampleBeforeShellCommand
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
(Inherited from JamBaseShellListView.)
Public eventBeforeShellDrop
This event is fired before a ListView that inherits from JamBaseShellListView executes a shell drop.
(Inherited from JamBaseShellListView.)
Public eventCheckStateChanged
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.
(Inherited from JamBaseShellListView.)
Public eventClearItems
This event occurs if the FileList is cleared by calling the clear() method.
(Inherited from CustomFileListT.)
Public eventCode exampleCreatedColumns
This event is fired after the columns were created.
(Inherited from JamBaseShellListView.)
Public eventHeaderRightClick
The event is triggered when the user right clicks on the column headers.
(Inherited from SystemListView.)
Public eventInitialized
This event is fired after the initialization of the component.
(Inherited from JamBaseShellListView.)
Public eventItemChecked
Occurs when the checked state of an item was changed by the user.
(Inherited from JamBaseShellListView.)
Public eventItemListChanged
This event occurs if the FileList changed, ie. an item was removed, added or the list is cleared.
(Inherited from CustomFileListT.)
Public eventItemShowToolTip
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.
(Inherited from SystemListView.)
Public eventOperationPerformed
This event is fired after a JamBaseShellListView executed a shell operation like copying.
(Inherited from JamBaseShellListView.)
Public eventRemoveItem
This event is issued if a file is removed from the listview.
(Inherited from CustomFileListT.)
Public eventSearchCompleted
This event is fired when a search operation is complete, has been cancelled, or an exception has been thrown.
Public eventSearchExceptionOccurred
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.
Public eventSearchFileMatches
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.
Public eventSearchProgressChanged
This event is fired everytime the progress of the searcher changes, that is when new items are filled to the FileList.
Public eventShowOptionChanged
This event is fired after an display option changed.
(Inherited from JamBaseShellListView.)
Public eventSizeOrCountRefreshed
This event occurs if the FileList.TotalFileCount or FileList.TotalFileSize were refreshed.
Top
Fields
  NameDescription
Protected fieldm_AutomaticRefresh
Indicates whether automatic refresh is enabled or not.
(Inherited from JamBaseShellListView.)
Protected fieldm_CollectSelectedPaths
true if m_SelectedFiles should contains whole paths instead of files only.
(Inherited from JamBaseShellListView.)
Protected fieldm_DetectLeftClick
Local variable to detect whether the mouse is clicked or dragged
(Inherited from JamBaseShellListView.)
Protected fieldm_DetectRightClick
Local variable to detect whether the mouse is clicked or dragged
(Inherited from JamBaseShellListView.)
Protected fieldm_DraggedDataObject
During a drag and drop operation that origins in this control this member contains the IDataObject. Filled in the ItemDrag method of the control.
(Inherited from JamBaseShellListView.)
Protected fieldm_DroppedDataObject
During a drag and drop operation this member contains the IDataObject that is dragged over the control. Filled in DragEnter.
(Inherited from JamBaseShellListView.)
Protected fieldm_headerRect
The area occupied by the ListView header.
(Inherited from SystemListView.)
Protected fieldm_Initialized
The attribute is used by classes deriving from JamBaseShellListView.
(Inherited from JamBaseShellListView.)
Protected fieldm_InitialSortColumnIndex
Zero-based index of the initial sort column. -2 means: Default value not overriden or already applied
(Inherited from JamBaseShellListView.)
Protected fieldm_SelectedFiles
A collection of the currently selected files.
(Inherited from JamBaseShellListView.)
Protected fieldm_ShellBrowser
An instance of our ShellBrowser.
(Inherited from JamBaseShellListView.)
Protected fieldm_SortColumnIndex
The current sort order as index of column.
(Inherited from JamBaseShellListView.)
Protected fieldm_SortColumnShellIndex
The shell index of the sort column. Default is 0 - the name column.
(Inherited from JamBaseShellListView.)
Protected fieldm_SortOrder
The initial sort order.
(Inherited from JamBaseShellListView.)
Protected fieldm_UseSystemFont
If true the component will use the default system font.
(Inherited from SystemListView.)
Protected fieldm_UseSystemStyles
If false the component won't use the vista styles. UseSystemStyles
(Inherited from SystemListView.)
Top
Remarks
To get the path of an item in the FileList, use the Path property.
See Also