ShellListView Methods |
The ShellListView type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AcquireImageIndecesViaThreadPool |
Retrieves the details (mostly images) of the item asynchronously.
|
| AddParentFolderItem |
Add an item ".." which represents the parent folder
|
| AddShellColumn(Int32) |
Adds a shell column to the list view.
(Inherited from JamBaseShellListView.) |
| AddShellColumn(Int32, Int32) | Adds a shell column with the given width to the list view. (Inherited from JamBaseShellListView.) |
| AddShellItem(ItemIdList) | Adds the currently active item of m_ShellBrowser to the list. |
| AddShellItem(ShellBrowser) | Adds the currently active item of m_ShellBrowser to the list. |
 | AutoResizeColumn |
Overrides the AutoResizeColumn(Int32, ColumnHeaderAutoResizeStyle) method. A SmartRefresh is called before the auto resize is executed.
|
| AutoResizeColumns |
Overrides the AutoResizeColumn(Int32, ColumnHeaderAutoResizeStyle) method. A SmartRefresh is called before the auto resize is executed.
|
| BaseOnDragDrop |
Calls the original inherited OnDragDrop method.
(Inherited from JamBaseShellListView.) |
| BeforeShellCommandAssigned |
For use by subcontrols, that need to check the availability of the BeforeShellCommand event.
(Inherited from JamBaseShellListView.) |
| BeginInit |
Signals the object that initialization is starting.
(Inherited from JamBaseShellListView.) |
| CanNavigate |
Called, before the ShellList displays a new folder.
Calls the CanNavigate(Object, ItemIdList) implementation if assigned.
|
| ChangeNotificationHandler |
This method gets called by the ShellChangeNotifier object and informs about changes in the current folder.
|
| Clear |
Removes all items and columns from the control.
(Inherited from JamBaseShellListView.) |
| ClearColumns |
Clears the current columns and the header context menu. Please use this method instead of ListView.Columns.Clear()>.
(Inherited from JamBaseShellListView.) |
| Compare |
Compares two ShellListItem objects with their ItemIdList with each other.
(Overrides JamBaseShellListViewCompare(Object, Object).) |
| CompleteDetails |
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.
|
| CreateDir |
Creates a new directory in the current folder.
|
| CreateShortcut |
Creates a new shortcut in the current folder.
|
| CustomCompare |
Compares the given items by the content of the subitems at the SortColumn index.
(Inherited from JamBaseShellListView.) |
| DisplayBackgroundContextMenu |
Shows the BackgroundContextMenu if it is non-null.
(Inherited from JamBaseShellListView.) |
| DisplayContextMenu |
Shows the shell context menu for the currently selected items
(Inherited from JamBaseShellListView.) |
| DisplayContextMenu(Point) |
Shows the shell context menu for the currently selected items
(Inherited from JamBaseShellListView.) |
| DisplayHeaderContextMenu | Empty handler of the HeaderRightClick event. This needs to be implemented by the deriving classes. (Inherited from JamBaseShellListView.) |
| Dispose |
Remove reference to ShellControlConnector and implicitely remove this control from the list of known controls of the ShellControlConnector
(Overrides JamBaseShellListViewDispose(Boolean).) |
| DoAutoSizeColumn |
Autosizes the column that is set in AutoSizeColumn.
(Inherited from JamBaseShellListView.) |
| DoBeforeShowContextMenu |
Calls the BeforeShowContextMenu event if assigned.
(Inherited from JamBaseShellListView.) |
| EnableSystemStyles |
Sets system specific behaviour,
i.e. FullRowSelect in Vista and upwards.
(Inherited from SystemListView.) |
| EndInit |
Signals the object that initialization is complete. After this method is called,
IsInitialized is true to indicate the state of the control.
(Overrides JamBaseShellListViewEndInit.) |
| FileChange |
This method should be called if files in the current view have changed.
|
| FinalizeColumnVisibilityChange |
Finalizes the column visibility change. The sort column is checked and the column order updated.
(Inherited from JamBaseShellListView.) |
| FindContextMenuPosition |
finds the position where to display the context menu based
upon the currently selected items and their positions
(Inherited from JamBaseShellListView.) |
| FindItemIdList | Searches for the first list item with the given ItemIdList. (Inherited from JamBaseShellListView.) |
| FindPath | Returns the ListItem for the given path. (Inherited from JamBaseShellListView.) |
| FolderChanged |
Gets called if the active folder should change.
(Overrides JamBaseShellListViewFolderChanged(ItemIdList).) |
| FullRefresh |
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, Filter or FilterRegularExpression property changes, or the connected ShellControlConnector reports a change.
(Overrides JamBaseShellListViewFullRefresh.) |
| GetColumnHeaderCollectionType |
Gets the type of the column header collection.
(Inherited from JamBaseShellListView.) |
| GetColumnOrder |
Retrieve the order in which columns appear.
(Inherited from SystemListView.) |
 | GetFullPath |
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.
|
| GetIndexOfShColumnId(SHCOLUMNID) |
Returns the local index for the given ShellColumnID (if the column is existing and visible)
(Inherited from JamBaseShellListView.) |
| GetIndexOfShColumnId(SHCOLUMNID, Boolean) |
Returns the local index for the given ShellColumnID.
(Inherited from JamBaseShellListView.) |
| GetItemCollectionType |
Gets the type of the Item Collection. It is used to create the correct JamBaseShellListViewShellListViewItemCollectionT for the inheriting classes.
(Overrides JamBaseShellListViewGetItemCollectionType.) |
| GetListViewItemSorter | Returns the Comparer to be used when the list is sorted. (Overrides JamBaseShellListViewGetListViewItemSorter.) |
| GetSelectedItemCollectionType |
Gets the type of the Selected Item Collection. It is used to create the correct JamBaseShellListViewShellListViewSelectedItemCollectionT for the inheriting classes.
(Overrides JamBaseShellListViewGetSelectedItemCollectionType.) |
| GetSelectedItemIdLists | Gets the items the command will be executed upon. (Inherited from JamBaseShellListView.) |
| GetSubItemBounds |
Retrieve the bounds of a ListViewSubItem
(Inherited from SystemListView.) |
| GetUIObject |
Returns for the currently selected item a COM object that implements the requested interface
(Overrides JamBaseShellListViewGetUIObject(Guid).) |
| GoUp |
Goes up one directory level.
(Overrides JamBaseShellListViewGoUp.) |
| HideColumn |
Hides the column with the passed SHCOLUMNID.
(Inherited from JamBaseShellListView.) |
| InformPathChanged |
Notifies connected controls that the active path of this control has changed
|
| InitColumns |
Prepares the columns according to the currently active folder.
If the user set custom columns, these are shown too.
(Overrides JamBaseShellListViewInitColumns.) |
| InvalidateSortColumns | For internal use: invalidates the current sort column. (Inherited from JamBaseShellListView.) |
| InvokeCommandOnFolder |
Invokes the given command on the currently listed folder.
|
 | InvokeCommandOnSelected |
Invokes the given command on the selected items.
See ShellCommand class for a list of possible commands.
(Inherited from JamBaseShellListView.) |
| InvokeCommandOnSelectedReadOnly |
Guarding/helper method for InvokeCommandOnSelected(ShellCommand) suppressing exceptions when executing commands that don't work in readonly mode.
(Inherited from JamBaseShellListView.) |
| IsColumnVisible(Int32) |
Returns whether the given column id is currently visible or not.
(Inherited from JamBaseShellListView.) |
| IsColumnVisible(SHCOLUMNID) |
Returns whether the given SHColumnId is currently visible or not.
(Inherited from JamBaseShellListView.) |
| IsColumnVisibleByDefault |
Determines whether the column with the specified shellcolumnId is a column shown by default.
(Inherited from JamBaseShellListView.) |
| IsCustomColumn |
Checks whether the given column index is a custom or shell column
(Inherited from JamBaseShellListView.) |
| IsEmpty |
Checks if the list is empty.
(Inherited from JamBaseShellListView.) |
| ItemOfPidl |
Returns the ListItem for the given ItemIdList
(Inherited from JamBaseShellListView.) |
| LogError(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.) |
| LogError(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.) |
| OnAddItem |
Fires an event if an item is added to the list.
|
| OnAfterInvokeCommand | Is called after the command has been called. (Overrides JamBaseShellListViewOnAfterInvokeCommand(ShellCommandEventArgs).) |
| OnAfterLabelEdit |
Override the OnAfterLabelEdit event, to rename files or folders in the file system, when the have been renamed in the ShellListView.
(Inherited from JamBaseShellListView.) |
| OnBeforeFullRefresh |
Fires the BeforeFullRefresh event
|
| OnBeforeInvokeCommand |
Allows deriving classes to handle the command internally in
InvokeCommandOnSelected(ShellCommand).
(Overrides JamBaseShellListViewOnBeforeInvokeCommand(BeforeShellCommandEventArgs).) |
| OnBeforeLabelEdit |
Override the OnBeforeLabelEdit event, to prepare renaming a file or folder in the ShellListView.
(Inherited from JamBaseShellListView.) |
| OnBeforeShellColumnChanged |
Calls the BeforeShellColumnChanged event if it is assigned.
(Inherited from JamBaseShellListView.) |
| OnBeforeShellDrop |
Calls the BeforeShellDrop event if it is assigned.
(Inherited from JamBaseShellListView.) |
| OnBeforeShowContextMenu | Calls the BeforeShowContextMenu event. (Inherited from JamBaseShellListView.) |
| OnCheckStateChanged |
Fires an event if the CheckState of an item has changed.
(Inherited from JamBaseShellListView.) |
| OnColumnClick |
Sort the column, which is clicked.
(Inherited from JamBaseShellListView.) |
| OnColumnWidthChanged |
Tracks column widths. Raises the System.Windows.Forms.ListView.ColumnWidthChanged event.
(Inherited from JamBaseShellListView.) |
| OnColumnWidthChanging |
Prevents changes at designtime.
Raises the ColumnWidthChanging event.
(Inherited from JamBaseShellListView.) |
| OnCreateColumns |
Fires an event after the columns have been created
(Inherited from JamBaseShellListView.) |
| OnCreateControl |
Raises the CreateControl method.
(Inherited from JamBaseShellListView.) |
| OnDoubleClick |
Override the OnDoubleClick event to try to perform the default action for the selected object.
(Overrides ControlOnDoubleClick(EventArgs).) |
| OnDragDrop |
This member overrides OnDragDrop(DragEventArgs) (Overrides JamBaseShellListViewOnDragDrop(DragEventArgs).) |
| OnDragEnter |
This member overrides OnDragEnter(DragEventArgs) and adds drag images and cursors.
(Inherited from JamBaseShellListView.) |
| OnDragLeave |
This member overrides OnDragLeave(EventArgs) (Overrides JamBaseShellListViewOnDragLeave(EventArgs).) |
| OnDragOver |
This member overrides OnDragOver(DragEventArgs) (Overrides JamBaseShellListViewOnDragOver(DragEventArgs).) |
| OnDrawColumnHeader |
This member overrides OnDrawColumnHeader(DrawListViewColumnHeaderEventArgs).
(Overrides ListViewOnDrawColumnHeader(DrawListViewColumnHeaderEventArgs).) |
| OnDrawItem |
This member overrides OnDrawItem(DrawListViewItemEventArgs).
(Overrides ListViewOnDrawItem(DrawListViewItemEventArgs).) |
| OnDrawSubItem |
This member overrides OnDrawSubItem(DrawListViewSubItemEventArgs).
(Overrides ListViewOnDrawSubItem(DrawListViewSubItemEventArgs).) |
| OnHandleCreated |
Handles the OnHandleCreated event and e.g. initializes the image list
(Inherited from JamBaseShellListView.) |
| OnHandleDestroyed | Tracks the handle destruction. (Inherited from JamBaseShellListView.) |
| OnHeaderContextMenuClick |
Eventhandler for a HeaderContextMenuClick.
(Inherited from JamBaseShellListView.) |
| OnHeaderRightClick |
Raises the HeaderRightClick-Event
(Inherited from SystemListView.) |
| OnItemChecked | Calls raising of the OnItemCheckedEvent. (Inherited from JamBaseShellListView.) |
| OnItemDrag |
This member overrides OnItemDrag(ItemDragEventArgs) (Overrides JamBaseShellListViewOnItemDrag(ItemDragEventArgs).) |
| OnItemShowToolTip | This method is extended to show tool tip texts of the particular shell objects. (Inherited from JamBaseShellListView.) |
| OnKeyDown |
Override the OnKeyDown event, to handle e.g. the key press like F2, F5, copy, paste, etc.
(Overrides ControlOnKeyDown(KeyEventArgs).) |
| OnLoadItem |
Calls the LoadItem event with the passed parameters.
(Inherited from JamBaseShellListView.) |
| OnMouseDown |
Raises the System.Windows.Forms.Control.MouseDown event.
(Inherited from JamBaseShellListView.) |
| OnMouseUp |
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).) |
| OnNavigationFailed |
Fires the NavigationFailed event.
|
| OnNotifyMessage |
This method is called if a notification event is performed on the message
pump WndProc(Message) (Inherited from SystemListView.) |
| OnOperation(ShellOperation, PathCollection, String, Exception) |
Fires an event if an operation was performed on the JamBaseShellListView.
(Inherited from JamBaseShellListView.) |
| OnOperation(ShellOperation, StringCollection, String, Exception) |
Helper function for OnOperation(ShellOperation, PathCollection, String, Exception)
to avoid type conversion.
(Inherited from JamBaseShellListView.) |
| OnPathChanged |
Fires the PathChanged event
|
| OnPopulated |
Fires the Populated event
|
| OnResize |
Raises the OnResize event.
(Inherited from JamBaseShellListView.) |
| OnSelectionChanged |
Raises the SelectionChanged event.
|
| OnShowOptionChanged | Calls the ShowOptionChanged event if it is assigned. (Inherited from JamBaseShellListView.) |
| PrepareMultiObjects | Obsolete.
Prepares the selected items in the list for being used with the m_ShellBrowser, an instance of ShellBrowser.
(Inherited from JamBaseShellListView.) |
| PreserveSystemStyle |
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.) |
| Refresh(RefreshLevel) | This method indicates that the control should perform a refresh of its contents. (Inherited from JamBaseShellListView.) |
| Refresh(RefreshLevel, ItemIdList) | This method indicates that the control should perform a refresh of its contents. (Inherited from JamBaseShellListView.) |
| RemoveItemFromList |
Removes the list element from the list
(Inherited from JamBaseShellListView.) |
| ResetColumns |
Resets the columns to the initial state.
(Inherited from JamBaseShellListView.) |
| ResetItems |
Resets the items and their subitems.
(Inherited from JamBaseShellListView.) |
| RestoreItemSelection | Restores the selection and checkstate of the item. (Inherited from JamBaseShellListView.) |
| RestoreState | Counterpart of SaveState. Restores properties and possibly contents of the ListView. (Inherited from JamBaseShellListView.) |
| SaveCheckedItems | Saves the checked items. (Inherited from JamBaseShellListView.) |
| SaveColumnSettings | Saves the column settings. (Inherited from JamBaseShellListView.) |
| SaveSelection | Saves the current selection and checked items to a temporary List. (Inherited from JamBaseShellListView.) |
| SaveState | Saves the column properties of the current view, so that it can be restored later. (Inherited from JamBaseShellListView.) |
| ScaleControl | Scales a control's location, size, padding and margin. (Overrides JamBaseShellListViewScaleControl(SizeF, BoundsSpecified).) |
| SelectAll | Use SelectAll to select or unselect all items in a JamShellList. |
| SelectAllItemsInternal | Selects all items. (Inherited from JamBaseShellListView.) |
| SelectedFileChange |
Gets called if the selected file should change.
(Overrides JamBaseShellListViewSelectedFileChange(ItemIdList).) |
| SelectPidl(ItemIdList) |
Selects the ListItem that corresponds to the given ItemIdList.
(Inherited from JamBaseShellListView.) |
| SelectPidl(ItemIdList, Boolean) |
Selects the ListItem that corresponds to the given ItemIdList.
(Inherited from JamBaseShellListView.) |
| SetColumnBitmap |
Set the sort icon among the current sort order in the passed column.
(Inherited from SystemListView.) |
| SetColumnOrder |
Sets the order in which columns appear.
(Inherited from SystemListView.) |
| SetColumnVisibility(Int32, Boolean) |
Sets the visibility of a column.
(Inherited from JamBaseShellListView.) |
| SetColumnVisibility(SHCOLUMNID, Boolean) |
Sets the visibility of a column.
(Inherited from JamBaseShellListView.) |
| SetFont |
Sets the font without adjusting other properties.
(Inherited from SystemListView.) |
| SetSortOrder(SHCOLUMNID) | Sets and applies the SortColumn in ascending. (Inherited from JamBaseShellListView.) |
| SetSortOrder(SHCOLUMNID, SortOrder) | Sets and applies the sortrder. (Inherited from JamBaseShellListView.) |
| ShowColumn |
Shows the column with the passed ShellColumnId.
(Inherited from JamBaseShellListView.) |
| SmartRefresh |
Use the SmartRefresh to update the contents of a ShellListView.
(Overrides JamBaseShellListViewSmartRefresh.)RemarksIn 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.
|
| Sort |
Sorts the items in the list according to SortColumn and SortOrder.
This sortorder can be replaced by assigning a IComparer to property ListViewItemSorter |
| UpdateColumnBitmaps |
Updates the sort icon in the column of the ShellListView.
(Inherited from JamBaseShellListView.) |
| UpdateSubitemsAfterColumnGetsVisible |
Loads subitems for a column that has been added at the passed position.
(Inherited from JamBaseShellListView.) |
| WndProc |
Overrides
WndProc(Message).
(Inherited from JamBaseShellListView.) |
Extension Methods| Name | Description | |
|---|---|---|
 | HandleNeeded | A Control extension method that ensures that the handle for a control is created. (Defined by ExtensionMethods.) |
| ScaledPixels | An extension method for controls: It scales the passed pixels according to the current dpi the control is displayed with. (Defined by ExtensionMethods.) |
| ScaleFont | A Control extension method that scales font according to the passed factor. (Defined by ExtensionMethods.) |
See Also