Click or drag to resize

ShellListView Methods

The ShellListView type exposes the following members.

Methods
  NameDescription
Protected methodAcquireImageIndecesViaThreadPool
Retrieves the details (mostly images) of the item asynchronously.
Protected methodAddParentFolderItem
Add an item ".." which represents the parent folder
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.)
Protected methodAddShellItem(ItemIdList)
Adds the currently active item of m_ShellBrowser to the list.
Protected methodAddShellItem(ShellBrowser)
Adds the currently active item of m_ShellBrowser to the list.
Public methodAutoResizeColumn
Overrides the AutoResizeColumn(Int32, ColumnHeaderAutoResizeStyle) method. A SmartRefresh is called before the auto resize is executed.
Public methodAutoResizeColumns
Overrides the AutoResizeColumn(Int32, ColumnHeaderAutoResizeStyle) method. A SmartRefresh is called before the auto resize is executed.
Protected methodBaseOnDragDrop
Calls the original inherited OnDragDrop method.
(Inherited from JamBaseShellListView.)
Public methodBeginInit
Signals the object that initialization is starting.
(Inherited from JamBaseShellListView.)
Protected methodChangeNotificationHandler
This method gets called by the ShellChangeNotifier object and informs about changes in the current folder.
Public methodClear
Removes all items and columns from the control.
(Inherited from JamBaseShellListView.)
Public methodClearColumns
Clears the current columns and the header context menu. Please use this method instead of ListView.Columns.Clear()>.
(Inherited from JamBaseShellListView.)
Public methodCompare
Compares two ShellListItem objects with their ItemIdList with each other.
(Overrides JamBaseShellListViewCompare(Object, Object).)
Protected methodCompleteDetails
Completes the details of an item, like image index, sub items etc. If UseThreadPool is true, the items image index is obtained via a thread pool.
Public methodCreateDir
Creates a new directory in the current folder.
Public methodCreateShortcut
Creates a new shortcut in the current folder.
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
Empty handler of the HeaderRightClick event. This needs to be implemented by the deriving classes.
(Inherited from JamBaseShellListView.)
Protected methodDispose
Remove reference to ShellControlConnector and implicitely remove this control from the list of known controls of the ShellControlConnector
(Overrides JamBaseShellListViewDispose(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, IsInitialized is true to indicate the state of the control.
(Overrides JamBaseShellListViewEndInit.)
Protected methodFileChange
This method should be called if files in the current view have changed.
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.
(Overrides JamBaseShellListViewFolderChanged(ItemIdList).)
Public methodFullRefresh
Use the FullRefresh method if you want to refresh the contents of a ShellListView. Usually you don't have to call FullRefresh manually. It will be called automatically, when e.g. the Path or Filter property changes, or the connected ShellControlConnector reports a change.
(Overrides JamBaseShellListViewFullRefresh.)
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 methodStatic memberGetFullPath
This method returns name, extension and full path of a given ShellListViewItem of a ShellListView. Since the extensions of the file may be not displayed dependant on the user's settings it is important that you use FullPath instead of ShellListViewItem.Text.
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 (Overrides JamBaseShellListViewGetItemCollectionType.)
Protected methodGetListViewItemSorter
Returns the Comparer to be used when the list is sorted.
(Overrides JamBaseShellListViewGetListViewItemSorter.)
Protected methodGetSelectedItemCollectionType (Overrides JamBaseShellListViewGetSelectedItemCollectionType.)
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
(Overrides JamBaseShellListViewGetUIObject(Guid).)
Public methodGoUp
Goes up one directory level.
(Overrides JamBaseShellListViewGoUp.)
Protected methodHideColumn
Hides the column with the passed SHCOLUMNID.
(Inherited from JamBaseShellListView.)
Protected methodInformPathChanged
Notifies connected controls that the active path of this control has changed
Protected methodInitColumns
Prepares the columns according to the currently active folder. If the user set custom columns, these are shown too.
(Overrides JamBaseShellListViewInitColumns.)
Protected methodInvalidateSortColumns
For internal use: invalidates the current sort column.
(Inherited from JamBaseShellListView.)
Public methodInvokeCommandOnFolder
Invokes the given command on the currently listed folder.
Public methodCode exampleInvokeCommandOnSelected
Invokes the given command on the selected items. See ShellCommand class for a list of possible commands.
(Inherited from JamBaseShellListView.)
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.)
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
Fires an event if an item is added to the list.
Public methodOnAfterInvokeCommand
Is called after the command has been called.
(Overrides JamBaseShellListViewOnAfterInvokeCommand(ShellCommandEventArgs).)
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.)
Protected methodOnBeforeFullRefresh
Fires the BeforeFullRefresh event
Public methodOnBeforeInvokeCommand
Allows deriving classes to handle the command internally in InvokeCommandOnSelected(ShellCommand).
(Overrides JamBaseShellListViewOnBeforeInvokeCommand(BeforeShellCommandEventArgs).)
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
Override the OnDoubleClick event to try to perform the default action for the selected object.
(Overrides ControlOnDoubleClick(EventArgs).)
Protected methodOnDragDrop
This member overrides OnDragDrop(DragEventArgs)
(Overrides JamBaseShellListViewOnDragDrop(DragEventArgs).)
Protected methodOnDragEnter
This member overrides OnDragEnter(DragEventArgs) and adds drag images and cursors.
(Inherited from JamBaseShellListView.)
Protected methodOnDragLeave
This member overrides OnDragLeave(EventArgs)
(Overrides JamBaseShellListViewOnDragLeave(EventArgs).)
Protected methodOnDragOver
This member overrides OnDragOver(DragEventArgs)
(Overrides JamBaseShellListViewOnDragOver(DragEventArgs).)
Protected methodOnDrawColumnHeader (Overrides ListViewOnDrawColumnHeader(DrawListViewColumnHeaderEventArgs).)
Protected methodOnDrawItem
This member overrides OnDrawItem(DrawListViewItemEventArgs).
(Overrides ListViewOnDrawItem(DrawListViewItemEventArgs).)
Protected methodOnDrawSubItem (Overrides ListViewOnDrawSubItem(DrawListViewSubItemEventArgs).)
Protected methodOnHandleCreated
Handles the OnHandleCreated event and e.g. initializes the image list
(Inherited from JamBaseShellListView.)
Protected methodOnHandleDestroyed
Tracks the handle destruction.
(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)
(Overrides JamBaseShellListViewOnItemDrag(ItemDragEventArgs).)
Protected methodOnItemShowToolTip
This method is extended to show tool tip texts of the particular shell objects.
(Inherited from JamBaseShellListView.)
Protected methodOnKeyDown
Override the OnKeyDown event, to handle e.g. the key press like F2, F5, copy, paste, etc.
(Overrides ControlOnKeyDown(KeyEventArgs).)
Protected methodOnMouseDown
Raises the System.Windows.Forms.Control.MouseDown event.
(Inherited from JamBaseShellListView.)
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.
(Overrides JamBaseShellListViewOnMouseUp(MouseEventArgs).)
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, Exception)
Fires an event if an operation was performed on the JamBaseShellListView.
(Inherited from JamBaseShellListView.)
Protected methodOnOperation(ShellOperation, StringCollection, String, Exception)
Helper function for OnOperation(ShellOperation, PathCollection, String, Exception) to avoid type conversion.
(Inherited from JamBaseShellListView.)
Protected methodOnPathChanged
Fires the PathChanged event
Protected methodOnPopulated
Fires the Populated event
Protected methodOnResize
Raises the OnResize event.
(Inherited from JamBaseShellListView.)
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 methodPreserveSystemStyle
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.
(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.)
Protected methodRemoveItemFromList
Removes the list element from the list
(Inherited from JamBaseShellListView.)
Public methodResetColumns
Resets the columns to the initial state.
(Inherited from JamBaseShellListView.)
Protected methodResetItems
Resets the items and their subitems.
(Inherited from JamBaseShellListView.)
Protected methodRestoreItemSelection
Restores the selection and checkstate of the item.
(Inherited from JamBaseShellListView.)
Protected methodRestoreState
Counterpart of SaveState. Restores properties and possibly contents of the ListView.
(Inherited from JamBaseShellListView.)
Protected methodSaveCheckedItems
Saves the checked items.
(Inherited from JamBaseShellListView.)
Protected methodSaveColumnSettings
Saves the column settings.
(Inherited from JamBaseShellListView.)
Protected methodSaveSelection
Saves the current selection and checked items to a temporary List.
(Inherited from JamBaseShellListView.)
Protected methodSaveState
Saves the column properties of the current view, so that it can be restored later.
(Inherited from JamBaseShellListView.)
Protected methodScaleControl
Scales a control's location, size, padding and margin.
(Overrides JamBaseShellListViewScaleControl(SizeF, BoundsSpecified).)
Public methodSelectAll
Use SelectAll to select or unselect all items in a JamShellList.
Protected methodSelectAllItemsInternal
Selects all items.
(Inherited from JamBaseShellListView.)
Public methodSelectedFileChange
Gets called if the selected file should change.
(Overrides JamBaseShellListViewSelectedFileChange(ItemIdList).)
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.
(Inherited from JamBaseShellListView.)
Public methodSmartRefresh
Use the SmartRefresh to update the contents of a ShellListView.
Remarks
In comparison to the FullRefresh method, SmartRefresh is much faster, but only removes objects which have been deleted and adds objects which have been added. It does not update changed file sizes or dates. Usually this method will be called automatically, when a file was added or deleted.
(Overrides JamBaseShellListViewSmartRefresh.)
Public methodSort
Sorts the items in the list according to SortColumn and SortOrder. This sortorder can be replaced by assigning a IComparer to property ListViewItemSorter
Protected methodUpdateColumnBitmaps
Updates the sort icon in the column of the ShellListView.
(Inherited from JamBaseShellListView.)
Protected methodUpdateSubitemsAfterColumnGetsVisible
Loads subitems for a column that has been added at the passed position.
(Inherited from JamBaseShellListView.)
Protected methodWndProc (Inherited from JamBaseShellListView.)
Top
Extension Methods
  NameDescription
Public Extension MethodHandleNeeded
A Control extension method that ensures that the handle for a control is created.
(Defined by ExtensionMethods.)
Public Extension MethodScaledPixels
An extension method for controls: It scales the passed pixels according to the current dpi the control is displayed with.
(Defined by ExtensionMethods.)
Public Extension MethodScaleFont
A Control extension method that scales font according to the passed factor.
(Defined by ExtensionMethods.)
Top
See Also