Click or drag to resize

JamBaseShellListView Methods

The JamBaseShellListView type exposes the following members.

Methods
 NameDescription
Protected methodAddShellColumn(Int32) Adds a shell column to the list view.
Protected methodAddShellColumn(Int32, Int32)Adds a shell column with the given width to the list view.
Protected methodBaseOnDragDrop Calls the original inherited OnDragDrop method.
Protected methodBeforeShellCommandAssigned For use by subcontrols, that need to check the availability of the BeforeShellCommand event.
Public methodBeginInit Signals the object that initialization is starting.
Public methodClear Removes all items and columns from the control.
Public methodClearColumns Clears the current columns and the header context menu. Please use this method instead of ListView.Columns.Clear()>.
Public methodCompare Override this method to compare objects given the SortColumn. The basic implementation compares the items alphabetically. If you need to change this, you can start out like this:
C#
public override int Compare(object x, object y)
{
    ShellListBaseItem item1 = x as ShellListBaseItem;
    ShellListBaseItem item2 = y as ShellListBaseItem;
    if (item1 == null || item2 == null)
        return 0;
    if (!SortColumnShellID.IsCustomId())
    {
        // the shell is asked
        ShellBrowser.SpecialFolder = ShellFolder.Desktop;
        if (Sorting == SortOrder.Ascending)
            return ShellBrowser.CompareIDs(item1.RelativeItemIdList, item2.RelativeItemIdList, m_SortColumnShellIndex);
        else
            return ShellBrowser.CompareIDs(item2.RelativeItemIdList, item1.RelativeItemIdList, m_SortColumnShellIndex);
    }
    else
    {
        // perform a normal alphanumeric compare
        if (Sorting == SortOrder.Ascending)
            return item1.SubItems[SortColumn].Text.CompareTo(item2.SubItems[SortColumn].Text);
        else
            return item2.SubItems[SortColumn].Text.CompareTo(item1.SubItems[SortColumn].Text);
    }
}
Protected methodCustomCompare Compares the given items by the content of the subitems at the SortColumn index.
Public methodDisplayBackgroundContextMenu Shows the BackgroundContextMenu if it is non-null.
Public methodDisplayContextMenu Shows the shell context menu for the currently selected items
Public methodDisplayContextMenu(Point) Shows the shell context menu for the currently selected items
Protected methodDisplayHeaderContextMenuEmpty handler of the HeaderRightClick event. This needs to be implemented by the deriving classes.
Protected methodDispose Releases the unmanaged resources used by the ListView and optionally releases the managed resources.
(Overrides ListViewDispose(Boolean))
Protected methodDoAutoSizeColumn Autosizes the column that is set in AutoSizeColumn.
Protected methodDoBeforeShowContextMenu Calls the BeforeShowContextMenu event if assigned.
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.
Protected methodFinalizeColumnVisibilityChange Finalizes the column visibility change. The sort column is checked and the column order updated.
Protected methodFindContextMenuPosition finds the position where to display the context menu based upon the currently selected items and their positions
Protected methodFindItemIdListSearches for the first list item with the given ItemIdList.
Protected methodFindPathReturns the ListItem for the given path.
Public methodFolderChanged Gets called if the active folder should change.
Public methodFullRefresh Call a full refresh.
Protected methodGetColumnHeaderCollectionType Gets the type of the column header collection.
Public methodGetColumnOrder Retrieve the order in which columns appear.
(Inherited from SystemListView)
Public methodGetIndexOfShColumnId(SHCOLUMNID) Returns the local index for the given ShellColumnID (if the column is existing and visible)
Protected methodGetIndexOfShColumnId(SHCOLUMNID, Boolean) Returns the local index for the given ShellColumnID.
Protected methodGetItemCollectionType Gets the type of the Item Collection. It is used to create the correct JamBaseShellListViewShellListViewItemCollectionT for the inheriting classes.
Protected methodGetListViewItemSorter Return an instance of IComparer that should be used for sorting the lists in subclasses
Protected methodGetSelectedItemCollectionType Gets the type of the Selected Item Collection. It is used to create the correct JamBaseShellListViewShellListViewSelectedItemCollectionT for the inheriting classes.
Public methodGetSelectedItemIdListsGets the items the command will be executed upon.
Protected methodGetSubItemBounds Retrieve the bounds of a ListViewSubItem
(Inherited from SystemListView)
Protected methodGetUIObject Get the UI object.
Public methodGoUp Goes up one directory level.
Protected methodHideColumn Hides the column with the passed SHCOLUMNID.
Protected methodInitColumns Initializes the columns.
Protected methodInvalidateSortColumnsFor internal use: invalidates the current sort column.
Public methodCode exampleInvokeCommandOnSelected Invokes the given command on the selected items. See ShellCommand class for a list of possible commands.
Protected methodInvokeCommandOnSelectedReadOnly Guarding/helper method for InvokeCommandOnSelected(ShellCommand) suppressing exceptions when executing commands that don't work in readonly mode.
Public methodIsColumnVisible(Int32) Returns whether the given column id is currently visible or not.
Public methodIsColumnVisible(SHCOLUMNID) Returns whether the given SHColumnId is currently visible or not.
Protected methodIsColumnVisibleByDefault Determines whether the column with the specified shellcolumnId is a column shown by default.
Public methodIsCustomColumn Checks whether the given column index is a custom or shell column
Public methodIsEmpty Checks if the list is empty.
Protected methodItemOfPidl Returns the ListItem for the given ItemIdList
Protected methodLoad Helper method that triggers the loading of the component. Only triggers a FullRefesh in the base implementation.
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
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
Public methodOnAfterInvokeCommandIs called after the command has been called.
Protected methodOnAfterLabelEdit Override the OnAfterLabelEdit event, to rename files or folders in the file system, when the have been renamed in the ShellListView.
(Overrides ListViewOnAfterLabelEdit(LabelEditEventArgs))
Public methodOnBeforeInvokeCommandIs called before the command is called.
Protected methodOnBeforeLabelEdit Override the OnBeforeLabelEdit event, to prepare renaming a file or folder in the ShellListView.
(Overrides ListViewOnBeforeLabelEdit(LabelEditEventArgs))
Protected methodOnBeforeShellColumnChanged Calls the BeforeShellColumnChanged event if it is assigned.
Protected methodOnBeforeShellDrop Calls the BeforeShellDrop event if it is assigned.
Public methodOnBeforeShowContextMenuCalls the BeforeShowContextMenu event.
Protected methodOnCheckStateChanged Fires an event if the CheckState of an item has changed.
Protected methodOnColumnClick Sort the column, which is clicked.
(Overrides ListViewOnColumnClick(ColumnClickEventArgs))
Protected methodOnColumnWidthChanged Tracks column widths. Raises the System.Windows.Forms.ListView.ColumnWidthChanged event.
(Overrides ListViewOnColumnWidthChanged(ColumnWidthChangedEventArgs))
Protected methodOnColumnWidthChanging Prevents changes at designtime. Raises the ColumnWidthChanging event.
(Overrides ListViewOnColumnWidthChanging(ColumnWidthChangingEventArgs))
Protected methodOnCreateColumns Fires an event after the columns have been created
Protected methodOnCreateControl Raises the CreateControl method.
(Overrides ControlOnCreateControl)
Protected methodOnDragDrop This member overrides OnDragDrop(DragEventArgs) and resets the drag effect.
(Overrides ControlOnDragDrop(DragEventArgs))
Protected methodOnDragEnter This member overrides OnDragEnter(DragEventArgs) and adds drag images and cursors.
(Overrides ControlOnDragEnter(DragEventArgs))
Protected methodOnDragLeaveThis member overrides OnDragLeave(EventArgs) and resets the DropTargetHelper.
(Overrides ControlOnDragLeave(EventArgs))
Protected methodOnDragOver This member overrides OnDragOver(DragEventArgs) and adds drag images and cursors.
(Overrides ControlOnDragOver(DragEventArgs))
Protected methodOnHandleCreated Handles the OnHandleCreated event and e.g. initializes the image list
(Overrides SystemListViewOnHandleCreated(EventArgs))
Protected methodOnHandleDestroyedTracks the handle destruction.
(Overrides ListViewOnHandleDestroyed(EventArgs))
Protected methodOnHeaderContextMenuClick Eventhandler for a HeaderContextMenuClick.
Protected methodOnHeaderRightClick Raises the HeaderRightClick-Event
(Inherited from SystemListView)
Protected methodOnItemCheckedCalls raising of the OnItemCheckedEvent.
Protected methodOnItemDrag This member overrides OnItemDrag(ItemDragEventArgs)
(Overrides ListViewOnItemDrag(ItemDragEventArgs))
Protected methodOnItemShowToolTipThis method is extended to show tool tip texts of the particular shell objects.
(Overrides SystemListViewOnItemShowToolTip(SystemListViewShowToolTipEventArgs))
Protected methodOnLoadItem Calls the LoadItem event with the passed parameters.
Protected methodOnMouseDown Raises the System.Windows.Forms.Control.MouseDown event.
(Overrides ControlOnMouseDown(MouseEventArgs))
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 ControlOnMouseUp(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.
Protected methodOnOperation(ShellOperation, StringCollection, String, Exception) Helper function for OnOperation(ShellOperation, PathCollection, String, Exception) to avoid type conversion.
Protected methodOnResize Raises the OnResize event.
(Overrides ListViewOnResize(EventArgs))
Protected methodOnShowOptionChangedCalls the ShowOptionChanged event if it is assigned.
Protected methodPrepareMultiObjects Prepares the selected items in the list for being used with the m_ShellBrowser, an instance of ShellBrowser.
Obsolete
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.
Public methodRefresh(RefreshLevel, ItemIdList)This method indicates that the control should perform a refresh of its contents.
Protected methodRemoveItemFromList Removes the list element from the list
Public methodResetColumns Resets the columns to the initial state.
Protected methodResetItems Resets the items and their subitems.
Protected methodRestoreItemSelectionRestores the selection and checkstate of the item.
Protected methodRestoreStateCounterpart of SaveState. Restores properties and possibly contents of the ListView.
Protected methodSaveCheckedItemsSaves the checked items.
Protected methodSaveColumnSettingsSaves the column settings.
Protected methodSaveSelectionSaves the current selection and checked items to a temporary List.
Protected methodSaveStateSaves the column properties of the current view, so that it can be restored later.
Protected methodScaleControlScales a control's location, size, padding and margin.
(Overrides ControlScaleControl(SizeF, BoundsSpecified))
Protected methodSelectAllItemsInternalSelects all items.
Public methodSelectedFileChange Gets called if the selected file should change.
Protected methodSelectPidl(ItemIdList) Selects the ListItem that corresponds to the given ItemIdList.
Protected methodSelectPidl(ItemIdList, Boolean) Selects the ListItem that corresponds to the given ItemIdList.
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.
Public methodSetColumnVisibility(SHCOLUMNID, Boolean) Sets the visibility of a column.
Protected methodSetFont Sets the font without adjusting other properties.
(Inherited from SystemListView)
Protected methodSetSortOrder(SHCOLUMNID)Sets and applies the SortColumn in ascending.
Protected methodSetSortOrder(SHCOLUMNID, SortOrder)Sets and applies the sortrder.
Protected methodShowColumn Shows the column with the passed ShellColumnId.
Public methodSmartRefresh Call a smart refresh.
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.
Protected methodUpdateColumnBitmaps Updates the sort icon in the column of the ShellListView.
Protected methodUpdateSubitemsAfterColumnGetsVisible Loads subitems for a column that has been added at the passed position.
Protected methodWndProc Overrides WndProc(Message).
(Overrides ListViewWndProc(Message))
Top
Extension Methods
 NameDescription
Public Extension MethodGetSelfAndDescendants Returns a flattened collection of a control and all of its descendant controls.
(Defined by ExtensionMethods)
Public Extension MethodHandleNeededA Control extension method that ensures that the handle for a control is created.
(Defined by ExtensionMethods)
Public Extension MethodScaledPixelsAn extension method for controls: It scales the passed pixels according to the current dpi the control is displayed with.
(Defined by ExtensionMethods)
Public Extension MethodScaleFontA Control extension method that scales font according to the passed factor.
(Defined by ExtensionMethods)
Top
See Also