Click or drag to resize

ShellListView Class

This control displays the contents of a folder in a listview. When the user right clicks on a folder, it will automatically show the context menu. Use to Path property to get or set the current folder, use the SpecialFolder property to set a special folder like the Control Panel. The Filter property can be used to filter certain files by extension. The FullRefresh method refreshes the displayed information. You can synchronize a ShellListView with a ShellTreeView by using the ShellControlConnector property. By default, a double click is handled by the control and it tries to perform the default action for the selected object.

 

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

 

Sorting is handled automatically by this list when column headers are clicked. If custom sorting is needed, an IComparer can be assigned to property ListViewItemSorter. See Sort for an example.
Inheritance Hierarchy

Namespace:  Jam.Shell
Assembly:  ShellBrowser (in ShellBrowser.dll) Version: 6.1
Syntax
public class ShellListView : JamBaseShellListView, 
	ISupportInitializeNotification, ISupportInitialize

The ShellListView type exposes the following members.

Constructors
  NameDescription
Public methodShellListView
Initializes a new instance of the ShellListView class.
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 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.
Public propertyAutoSizeColumn
Adjust the size of the given column so that it fills the remaining horizontal space.
(Inherited from JamBaseShellListView.)
Public propertyCode exampleBackgroundContextMenu
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.
(Overrides SystemListViewBackgroundContextMenu.)
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 JamBaseShellListView.)
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 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.
Protected propertyCreateParams
Overwriting the CreateParams property to set the WS_VISIBLE flag; bug #8960
(Inherited from SystemListView.)
Protected propertyDragLeaveOccurred
Indicates that a DragLeave was executed recently; bug #6536
Protected propertyDropItem
Gets or sets the item on that a current drag and drop operation would be executed.
(Inherited from JamBaseShellListView.)
Public propertyFileSystemOnly
If FileSystemOnly is set to True, objects and virtual folders which do not have a file system path, will not be displayed. Exceptions are 'My Computer', 'Libraries' and 'Network'
Public propertyFilter
You can use a single pattern, e.g. '*.doc' or concatenate several patterns using semicolons to separate them, e.g. '*.exe;*.com'.
Public propertyFolderIdList
FolderIdList contains a pointer to the ItemIdList of the current folder.
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.)
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
Returns a collection containing all ShellListItems in the ShellListView. Items are of type ShellListItem
Public propertyLabelEdit
Gets or sets a value indicating whether the label text of the list items can be edited.
Protected propertyListChangedAfterDragLeave
Indicates that the list changed after a DragLeave was executed; bug #6536
Public propertyNoFillOnStartup
If set to true, the control will not fill automatically after it was created. The FullRefresh method must be called explicitly. Since filling shell control with the appropriate items is a costly operation, this property can be useful to prevent unnecessary refreshes of the control.
(Inherited from JamBaseShellListView.)
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.
Protected propertyPastedFiles
Contains the files that were pasted during a Paste operation.
(Inherited from JamBaseShellListView.)
Public propertyPath
This property allows you to get or set the folder, which contents should be displayed. If you want to display a non file system folder, use the SpecialFolder property.
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.
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).
Public propertyShowColorEncrypted
If set, encrypted files and folders will be shown in that particular color, show normally otherwise (if null).
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 propertyShowFiles
If set to true, files will be shown in the control. If set to false, files will not be visible in the control.
Public propertyShowFolders
The property ShowFolders allows you to include the folders in the ShellListView, similar to FrontPage 2000.
Public propertyShowHidden
Is set to 'true', hidden elements will also be shown.
Public propertyShowInfoToolTips
Whether to show the informational shell tooltips, the default is true
(Inherited from JamBaseShellListView.)
Public propertyShowNetHood
If set to 'false', the Network Neighbourhood is not shown in the component, otherwise it is shown (the default value is true).
Public propertyShowOverlayIcons
If set to 'false', no overlay icons will be shown, which improves the performance of the control.
Public propertyShowParentFolder
Use this property to show an additional folder with the caption '..' that allows the user to navigate to the parent folder of the current folder.
Public propertyShowRecycleBin
If set to true, the recycle bin will be visible. If set to false, the recycle bin will be hidden (the default value is true).
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.
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 propertySpecialFolder
SpecialFolder allows you to set or get the type of the currently listed folder. You can use the ShellFolder constants here.
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 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 complete file detail information is retrieved as soon as the item is displayed the first time within the listview. If the property is true thumbnails and icons are fetched in worker threads in the background. The setting of this property affects the control the next time the FullRefresh method is called.
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
Protected methodAcquireImageIndecesViaThreadPool
This method enqueues a work item into the system threadpool to get the image indeces of the particular ShellListItem.
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.
Protected methodCleanUpThumbnails
This method cleans up the currently loaded thumbnails and created a new image list.
(Inherited from JamBaseShellListView.)
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 eachother.
(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, m_Initialized 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 methodInvokeCommandOnSelected
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 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)
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 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 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.)
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.)
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
Events
  NameDescription
Public eventCode exampleAddItem
This event is fired whenever a new item is added to a ShellListView.
Public eventBeforeFullRefresh
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 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 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 eventPathChanged
This event is fired when the users changes the path.
Public eventPopulated
This event is fired after a ShellListView was filled completely.
Public eventShowOptionChanged
This event is fired after an display option changed.
(Inherited from JamBaseShellListView.)
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
See Also