Click or drag to resize

FileList Methods

The FileList type exposes the following members.

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
See Also