JamBaseShellListView Class |
Namespace: Jam.Shell
The JamBaseShellListView type exposes the following members.
Name | Description | |
---|---|---|
JamBaseShellListView |
Constructor for the JamBaseShellListView.
|
Name | Description | |
---|---|---|
ActiveImageList | Gets the ImageList that is currently used. | |
AllowDrag |
Use this property to turn on or off drag support with the Windows Explorer.
| |
AllowDrop |
Use this property to turn on or off drop support with the Windows Explorer.
(Overrides ControlAllowDrop.) | |
AutomaticRefresh |
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.
| |
AutomaticRefresh_Internal |
Indicates whether automatic refresh is enabled or not.
| |
AutoSizeColumn |
Adjust the size of the given column so that it fills the remaining horizontal space.
| |
BackgroundContextMenu |
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.
(Inherited from SystemListView.) | |
CheckBoxes |
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.
| |
CheckBoxMode | Use this property to display checkboxes for the control. | |
CheckedItems |
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.
| |
CollectSelectedPaths | true if m_SelectedFiles should contain whole paths instead of files only. | |
Columns |
Gets the collection of all column headers that appear in the control.
| |
ContextMenuRenderMode | Gets or sets the ToolStripRenderMode of the BackgroundContextMenu and the HeaderContextMenu. | |
ContextMenuStrip |
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.
| |
CreateParams |
Overwriting the CreateParams property to set the WS_VISIBLE flag; bug #8960
(Inherited from SystemListView.) | |
DesignMode | Gets a value indicating whether the design mode. | |
DetectLeftClick |
Local variable to detect whether the mouse is clicked or dragged
| |
DetectRightClick |
Local variable to detect whether the mouse is clicked or dragged
| |
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. | |
DropItem |
Gets or sets the item on that a current drag and drop operation would be executed.
| |
DroppedDataObject | During a drag and drop operation this member contains the IDataObject that is dragged over the control. Filled in DragEnter. | |
FastFolderThumbnails |
In Thumbnail view, only load thumbnails that are already in the thumbnail cache for folders.
Default value true will avoid potentially huge delays that are caused by live folder thumbnails reflecting the contents of the folder.
| |
Font |
The font used to display text in the control.
(Overrides ControlFont.) | |
HeaderMenuStrip |
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.
| |
HeaderRectangle |
Returns the area occupied by the ListView header.
(Inherited from SystemListView.) | |
HideSelection |
Gets or sets a value indicating whether the selected item in the control
remains highlighted when the control loses focus.
(Inherited from SystemListView.) | |
Initialized_Internal |
Internal attribute is used by classes deriving from JamBaseShellListView.
| |
InternalColumns |
Gets the columns as JamShellColumnCollection.
| |
IsEditing | Gets a value indicating whether this object is currently in edit-mode. | |
IsInitialized |
Gets a value indicating whether the component is initialized.
| |
IsInitializing |
The value this property is true between the calls BeginInit() and EndInit()
of the ISupportInitialize interface.
| |
LargeCustomImages | Gets or sets an ImageList holding images that can be used as custom images in small viewstates. | |
LargeImageList | Gets or sets a list of large images. | |
NoFillOnStartup |
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.
| |
NumShellColumns |
The number of system columns without the columns added by the user.
| |
PastedFiles | Contains the files that were pasted during a Paste operation. | |
ReadOnly |
If true, the folder actions changing the contents of the folder are not allowed.
E.g.: Adding, removing or renaming files via context menu, DragDrop, Copy/Paste.
| |
SelectedFiles |
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.
| |
SelectedFiles_Internal | Simple getter/setter for m_SelectedFiles, for use by deriving classes. | |
ShellBrowser |
Gets or sets the shellbrowser instance.
| |
ShellChangeNotifier |
Returns the reference to the ShellChangeNotifier that
is associated with this instance.
| |
ShellContextMenu |
Indicates whether the Windows ShellContextMenu should be shown or not.
| |
ShellControlConnector |
Connects this control to a ShellControlConnector component, which allows to synchronize several shell controls.
| |
ShellDragDrop | Activates/deactivates the internal drag drop handling of the component. (Inherited from SystemListView.) | |
ShowContextMenu |
If set to true, the context menu will be shown if a right click event occurs.
| |
ShowErrorMessages |
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.
| |
ShowExtraLargeIcons |
Obsolete: Use ViewState.ExtraLargeIcons instead.
| |
ShowInfoToolTips |
Whether to show the informational shell tooltips, the default is true
| |
ShowShellContextMenuOnTop |
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.
| |
SmallCustomImages | Gets or sets an ImageList holding images that can be used as custom images in small viewstates. | |
SmallImageList | Gets or sets a list of small images. | |
SortColumn |
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.
| |
SortColumnShellID |
Gets or sets the current sort order.
| |
Sorting |
Gets or sets the sort order for items in the control.
| |
ThumbnailBorderColor |
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.
| |
ThumbnailMode | Gets or sets preferences whether to display file icons or thumbnails in the list. | |
Thumbnails |
Obsolete: Use ViewState.Thumbnails instead.
| |
ThumbnailSize |
Use the ThumbnailSize property to get or set the size in pixels of the thumbnail images.
| |
UsedShColumnIds | Obsolete.
Returns an array of the currently used ShColumnIds.
| |
UseSlowInfoTip |
If true, the slow tooltip that contains additional information like the folder size is used.
Setting this value to false increases the performance.
| |
UseSystemFont |
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.) | |
UseSystemStyles |
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.) | |
Version |
The current version of the ShellBrowser.
| |
VerticalScrollPos |
Gets or sets the vertical scroll position.
| |
View |
Overrides the ListView.View property. Use ViewState instead.
| |
ViewState |
Gets or sets how items are displayed in the ListView control.
| |
VirtualListSize |
Not supported.
| |
VirtualMode |
Not supported.
|
Name | Description | |
---|---|---|
AddShellColumn(Int32) |
Adds a shell column to the list view.
| |
AddShellColumn(Int32, Int32) | Adds a shell column with the given width to the list view. | |
BaseOnDragDrop |
Calls the original inherited OnDragDrop method.
| |
BeforeShellCommandAssigned |
For use by subcontrols, that need to check the availability of the BeforeShellCommand event.
| |
BeginInit |
Signals the object that initialization is starting.
| |
Clear |
Removes all items and columns from the control.
| |
ClearColumns |
Clears the current columns and the header context menu. Please use this method instead of ListView.Columns.Clear()>.
| |
Compare |
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); } } | |
CustomCompare |
Compares the given items by the content of the subitems at the SortColumn index.
| |
DisplayBackgroundContextMenu |
Shows the BackgroundContextMenu if it is non-null.
| |
DisplayContextMenu |
Shows the shell context menu for the currently selected items
| |
DisplayContextMenu(Point) |
Shows the shell context menu for the currently selected items
| |
DisplayHeaderContextMenu | Empty handler of the HeaderRightClick event. This needs to be implemented by the deriving classes. | |
Dispose |
Releases the unmanaged resources used by the ListView and optionally releases the managed resources.
(Overrides ListViewDispose(Boolean).) | |
DoAutoSizeColumn |
Autosizes the column that is set in AutoSizeColumn.
| |
DoBeforeShowContextMenu |
Calls the BeforeShowContextMenu event if assigned.
| |
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.
| |
FinalizeColumnVisibilityChange |
Finalizes the column visibility change. The sort column is checked and the column order updated.
| |
FindContextMenuPosition |
finds the position where to display the context menu based
upon the currently selected items and their positions
| |
FindItemIdList | Searches for the first list item with the given ItemIdList. | |
FindPath | Returns the ListItem for the given path. | |
FolderChanged |
Gets called if the active folder should change.
| |
FullRefresh |
Call a full refresh.
| |
GetColumnHeaderCollectionType |
Gets the type of the column header collection.
| |
GetColumnOrder |
Retrieve the order in which columns appear.
(Inherited from SystemListView.) | |
GetIndexOfShColumnId(SHCOLUMNID) |
Returns the local index for the given ShellColumnID (if the column is existing and visible)
| |
GetIndexOfShColumnId(SHCOLUMNID, Boolean) |
Returns the local index for the given ShellColumnID.
| |
GetItemCollectionType |
Gets the type of the Item Collection. It is used to create the correct JamBaseShellListViewShellListViewItemCollectionT for the inheriting classes.
| |
GetListViewItemSorter |
Return an instance of IComparer that should be used for sorting the lists in subclasses
| |
GetSelectedItemCollectionType |
Gets the type of the Selected Item Collection. It is used to create the correct JamBaseShellListViewShellListViewSelectedItemCollectionT for the inheriting classes.
| |
GetSelectedItemIdLists | Gets the items the command will be executed upon. | |
GetSubItemBounds |
Retrieve the bounds of a ListViewSubItem
(Inherited from SystemListView.) | |
GetUIObject |
Get the UI object.
| |
GoUp |
Goes up one directory level.
| |
HideColumn |
Hides the column with the passed SHCOLUMNID.
| |
InitColumns |
Initializes the columns.
| |
InvalidateSortColumns | For internal use: invalidates the current sort column. | |
InvokeCommandOnSelected |
Invokes the given command on the selected items.
See ShellCommand class for a list of possible commands.
| |
InvokeCommandOnSelectedReadOnly |
Guarding/helper method for InvokeCommandOnSelected(ShellCommand) suppressing exceptions when executing commands that don't work in readonly mode.
| |
IsColumnVisible(Int32) |
Returns whether the given column id is currently visible or not.
| |
IsColumnVisible(SHCOLUMNID) |
Returns whether the given SHColumnId is currently visible or not.
| |
IsColumnVisibleByDefault |
Determines whether the column with the specified shellcolumnId is a column shown by default.
| |
IsCustomColumn |
Checks whether the given column index is a custom or shell column
| |
IsEmpty |
Checks if the list is empty.
| |
ItemOfPidl |
Returns the ListItem for the given ItemIdList
| |
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
| |
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
| |
OnAfterInvokeCommand | Is called after the command has been called. | |
OnAfterLabelEdit |
Override the OnAfterLabelEdit event, to rename files or folders in the file system, when the have been renamed in the ShellListView.
(Overrides ListViewOnAfterLabelEdit(LabelEditEventArgs).) | |
OnBeforeInvokeCommand | Is called before the command is called. | |
OnBeforeLabelEdit |
Override the OnBeforeLabelEdit event, to prepare renaming a file or folder in the ShellListView.
(Overrides ListViewOnBeforeLabelEdit(LabelEditEventArgs).) | |
OnBeforeShellColumnChanged |
Calls the BeforeShellColumnChanged event if it is assigned.
| |
OnBeforeShellDrop |
Calls the BeforeShellDrop event if it is assigned.
| |
OnBeforeShowContextMenu | Calls the BeforeShowContextMenu event. | |
OnCheckStateChanged |
Fires an event if the CheckState of an item has changed.
| |
OnColumnClick |
Sort the column, which is clicked.
(Overrides ListViewOnColumnClick(ColumnClickEventArgs).) | |
OnColumnWidthChanged |
Tracks column widths. Raises the System.Windows.Forms.ListView.ColumnWidthChanged event.
(Overrides ListViewOnColumnWidthChanged(ColumnWidthChangedEventArgs).) | |
OnColumnWidthChanging |
Prevents changes at designtime.
Raises the ColumnWidthChanging event.
(Overrides ListViewOnColumnWidthChanging(ColumnWidthChangingEventArgs).) | |
OnCreateColumns |
Fires an event after the columns have been created
| |
OnCreateControl |
Raises the CreateControl method.
(Overrides ControlOnCreateControl.) | |
OnDragDrop |
This member overrides OnDragDrop(DragEventArgs) and resets the drag effect.
(Overrides ControlOnDragDrop(DragEventArgs).) | |
OnDragEnter |
This member overrides OnDragEnter(DragEventArgs) and adds drag images and cursors.
(Overrides ControlOnDragEnter(DragEventArgs).) | |
OnDragLeave | This member overrides OnDragLeave(EventArgs) and resets the
DropTargetHelper. (Overrides ControlOnDragLeave(EventArgs).) | |
OnDragOver |
This member overrides OnDragOver(DragEventArgs) and adds drag images and cursors.
(Overrides ControlOnDragOver(DragEventArgs).) | |
OnHandleCreated |
Handles the OnHandleCreated event and e.g. initializes the image list
(Overrides SystemListViewOnHandleCreated(EventArgs).) | |
OnHandleDestroyed | Tracks the handle destruction. (Overrides ListViewOnHandleDestroyed(EventArgs).) | |
OnHeaderContextMenuClick |
Eventhandler for a HeaderContextMenuClick.
| |
OnHeaderRightClick |
Raises the HeaderRightClick-Event
(Inherited from SystemListView.) | |
OnItemChecked | Calls raising of the OnItemCheckedEvent. | |
OnItemDrag |
This member overrides OnItemDrag(ItemDragEventArgs) (Overrides ListViewOnItemDrag(ItemDragEventArgs).) | |
OnItemShowToolTip | This method is extended to show tool tip texts of the particular shell objects. (Overrides SystemListViewOnItemShowToolTip(SystemListViewShowToolTipEventArgs).) | |
OnLoadItem |
Calls the LoadItem event with the passed parameters.
| |
OnMouseDown |
Raises the System.Windows.Forms.Control.MouseDown event.
(Overrides ControlOnMouseDown(MouseEventArgs).) | |
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 ControlOnMouseUp(MouseEventArgs).) | |
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.
| |
OnOperation(ShellOperation, StringCollection, String, Exception) |
Helper function for OnOperation(ShellOperation, PathCollection, String, Exception)
to avoid type conversion.
| |
OnResize |
Raises the OnResize event.
(Overrides ListViewOnResize(EventArgs).) | |
OnShowOptionChanged | Calls the ShowOptionChanged event if it is assigned. | |
PrepareMultiObjects | Obsolete.
Prepares the selected items in the list for being used with the m_ShellBrowser, an instance of ShellBrowser.
| |
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. | |
Refresh(RefreshLevel, ItemIdList) | This method indicates that the control should perform a refresh of its contents. | |
RemoveItemFromList |
Removes the list element from the list
| |
ResetColumns |
Resets the columns to the initial state.
| |
ResetItems |
Resets the items and their subitems.
| |
RestoreItemSelection | Restores the selection and checkstate of the item. | |
RestoreState | Counterpart of SaveState. Restores properties and possibly contents of the ListView. | |
SaveCheckedItems | Saves the checked items. | |
SaveColumnSettings | Saves the column settings. | |
SaveSelection | Saves the current selection and checked items to a temporary List. | |
SaveState | Saves the column properties of the current view, so that it can be restored later. | |
ScaleControl | Scales a control's location, size, padding and margin. (Overrides ControlScaleControl(SizeF, BoundsSpecified).) | |
SelectAllItemsInternal | Selects all items. | |
SelectedFileChange |
Gets called if the selected file should change.
| |
SelectPidl(ItemIdList) |
Selects the ListItem that corresponds to the given ItemIdList.
| |
SelectPidl(ItemIdList, Boolean) |
Selects the ListItem that corresponds to the given ItemIdList.
| |
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.
| |
SetColumnVisibility(SHCOLUMNID, Boolean) |
Sets the visibility of a column.
| |
SetFont |
Sets the font without adjusting other properties.
(Inherited from SystemListView.) | |
SetSortOrder(SHCOLUMNID) | Sets and applies the SortColumn in ascending. | |
SetSortOrder(SHCOLUMNID, SortOrder) | Sets and applies the sortrder. | |
ShowColumn |
Shows the column with the passed ShellColumnId.
| |
SmartRefresh |
Call a smart refresh.
| |
Sort |
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.
| |
UpdateColumnBitmaps |
Updates the sort icon in the column of the ShellListView.
| |
UpdateSubitemsAfterColumnGetsVisible |
Loads subitems for a column that has been added at the passed position.
| |
WndProc |
Overrides
WndProc(Message).
(Overrides ListViewWndProc(Message).) |
Name | Description | |
---|---|---|
BeforeInvokeCommandOnSelected |
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.) | |
BeforeShellColumnChanged |
This event is fired when a column is selected/deselected from the context menu of the list header.
| |
BeforeShellCommand |
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
| |
BeforeShellDrop |
This event is fired before a ListView that inherits from JamBaseShellListView executes a shell drop.
| |
BeforeShowContextMenu |
This event is called before the ShellContextMenu is displayed.
You may use it to cancel the context menu appearing or to modify the custom menu entries in the ContextMenuStrip.
| |
CheckStateChanged |
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.
| |
CreatedColumns |
This event is fired after the columns were created.
| |
HeaderRightClick |
The event is triggered when the user right clicks on the column headers.
(Inherited from SystemListView.) | |
Initialized |
This event is fired after the initialization of the component.
| |
ItemChecked | Occurs when the checked state of an item was changed by the user. | |
ItemShowToolTip |
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.) | |
LoadItem |
This event is called, when the data for an item is loaded.
| |
OperationPerformed |
This event is fired after a JamBaseShellListView executed a shell operation like copying.
| |
ShowOptionChanged |
This event is fired after a display option, like e.g. the ViewState changed.
| |
ThumbnailUpdated | This event is fired for each item in Thumbnail view. It can be used to update the thumbnail. |
Name | Description | |
---|---|---|
JamHiddenColumnWidth |
used to mark hidden columns in the array of saved column widths
| |
m_InitialSortColumnIndex | Zero-based index of the initial sort column. -2 means: Default value not overriden or already applied | |
m_SortColumnIndex |
The current sort order as index of column.
| |
m_SortColumnShellIndex |
The shell index of the sort column. Default is 0 - the name column.
| |
m_SortOrder |
The initial sort order.
|
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.) |