Click or drag to resize

ShellSystemList Class

Use ExplorerBrowser instead

This component embeds the native windows explorer control into a .net component.
Inheritance Hierarchy
SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        Jam.ShellShellSystemList

Namespace: Jam.Shell
Assembly: ShellBrowser (in ShellBrowser.dll) Version: 7.2
Syntax
[ObsoleteAttribute("Use ExplorerBrowser instead", false)]
public class ShellSystemList : Control, 
	IShellControl, IShellControlConnectorTarget, ISupportInitialize, ISupportInitializeNotification

The ShellSystemList type exposes the following members.

Constructors
 NameDescription
Public methodShellSystemList Default constructor
Top
Properties
 NameDescription
Public propertyAllColumns Gets a list of all columns that are supported in the current view. These depend on what the control currently displays. Not supported on Windows XP.
Public propertyBackColor This property is not implemented for the ShellSystemList.
(Overrides ControlBackColor)
Public propertyBackgroundImage This property is not implemented for the ShellSystemList.
(Overrides ControlBackgroundImage)
Public propertyBackgroundImageLayout This property is not implemented for the ShellSystemList.
(Overrides ControlBackgroundImageLayout)
Public propertyCheckModeGets or sets a value defining the current CheckMode.
Public propertyCode exampleColumns Gets the ShellViewColumns the control currently displays. Not supported on Windows XP.
Public propertyContentFilter Gets or sets an ShellItemFilter instance.
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.
Protected propertyCreateParams Gets the required creation parameters when the control handle is created.
(Overrides ControlCreateParams)
Public propertyFileSystemOnly If FileSystemOnly is set to True, objects and virtual folders which do not have a file system path, will not be displayed.
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 propertyFilterRegex Set this property to a regular expression if you want to only show those files that match the regex. This value also changes if the property Filter is set.
Public propertyFocused Gets a value indicating whether a control has input focus.
Public propertyFolderIdList Get or set the ItemIdList of the folder the component currently displays respectively the folder the component shall display.
Public propertyFont This property is not implemented for the ShellSystemList.
(Overrides ControlFont)
Public propertyForeColor This property is not implemented for the ShellSystemList.
(Overrides ControlForeColor)
Protected propertyInEditMode Returns true if the user is currently editing the caption of a listview item.
Public propertyIsInitialized Returns true if the ShellSystemList is property initialization has been performed (after EndInit was called by the Designer generated code)
Public propertyItemCount Gets the number of items the list currently holds.
Public propertyItems The List of items that the ole shell instance displays. One cannot remove several items from this datastructure in order to remove them from the listview.
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 propertySelCount Gets the number of selected items.
Public propertySelected Returns the currently selected item.
Public propertySelectedFiles Returns a list of full paths for the items selected in the view. Objects that do not have a filesystem path, are not within this list.
Public propertySelectedIndex Get the selected index in the SystemShellView. This property is -1, if nothing is selected. Please use SelectedItemIdList if you want to determine if nothing at all is selected, since determining the selected index involves a search via IndexOf(ItemIdList).
Public propertySelectedItemIdList Get the selected item id list in the SystemShellView. This property returns null, if nothing is selected. The setter of this property is protected since the exact ItemIdList that is stored in the explorer ole instance is needed to select the item in the view. It is insufficient to construct a new one with new ItemIdList("fullpath"); and pass that as a value. The instantiated ole window will not select an item that way.
Public propertySelectedPath Get the full path of the selected item. Returns null if nothing is selected.
Public propertyShellControlConnector Connects this control to a ShellControlConnector component, which allows to synchronize several shell controls.
Public propertyShowBackgroundContextMenu If set to true, the Windows Explorer background context menu will be shown if a right click event occurs.
Public propertyShowContextMenu If set to true, the Windows Explorer context menu will be shown if a right click event occurs.
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.
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 propertyShowNetHood If set to 'false', the Network Neighbourhood is not shown in the component, otherwise it is shown (the default value is true).
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 propertySpecialFolder SpecialFolder allows you to set or get the type of the currently listed folder. You can use the ShellFolder constants here.
Public propertyTextColor Get or set the TextColor of the Control
Public propertyThumbnails Obsolete - use View.
Public propertyThumbnailSize Gets or sets the size of the thumbnails. Only applied when View is set to FolderViewMode.Thumbnail
Public propertyTransparent Get or set the transparency value of the Control
Public propertyVersion The current version of the ShellBrowser.
Public propertyView This property allows to set the different view modes of the windows explorer listview control. In comparison to the ShellListView the ShellSystemList provides a greater variety of possibilities.
Public propertyViewFolderFlags Get or set the FolderFlags that specify how the ListView displays its content. The flags can be or'ed together, ie. "FolderFlags.NoColumnHeader | FolderFlags.AbbreviatedNames" in the designer this is specified by a comma-separation Not all of the Flags are supported currently
Top
Methods
 NameDescription
Public methodBeginInit Is called by the code generated with the designer.
Public methodContextSensitiveHelp IOleWindow interface implementation (http://msdn.microsoft.com/en-us/library/ms680102(VS.85).aspx)
Public methodCreateDir Creates a new directory in the current folder.
Protected methodCreateHandle Creates a handle for the control
(Overrides ControlCreateHandle)
Public methodDeselectAll Deselect all items in the listview
Public methodDisplayContextMenu Shows the shell context menu for the currently selected items
Public methodEndInit Is called by the designer generated code, triggers the Initialized event.
Protected methodFilterMatch Checks if the regular expresssion matches the object name passed. Immediately returns true if FilterRegex is null to improve performance if no filter e.g. '*' is needed.
Public methodFolderChanged Gets called if the active folder should change. If a ShellControlConnector is assigned to the control, it is notified.
Public methodFullRefresh This method only operates if the Handle has been allocated.
Public methodGetItem Get the ItemIdList at the index specified.
Public methodGetShellItem Get the item at the specified index.
Public methodGetWindow IOleWindow interface implementation (http://msdn.microsoft.com/en-us/library/ms680102(VS.85).aspx)
Public methodGoUp Selects the parent folder in the SystemListView.
Protected methodIncludeObjectInList Returns true if the object referenced by the item id list should be shown in the list according to the show options and filters that are eventually set.
Public methodIndexOf(ItemIdList) Searches for the index of the ItemIdList within the shell-list. This function has O(n) complexity, since it iterates through all items within the list
Public methodIndexOf(String) Searches for the index of the given path within the shell-list. This function has O(n) complexity, since it iterates through all items within the list
Protected methodInformPathChanged Inform of the ShellControlConnector that the path currently displayed has changed.
Public methodInvokeCommandOnFolder Use InvokeCommandOnFolder to execute a command of the context menu for the listed folder.
Public methodInvokeCommandOnSelected Invokes a ShellCommand on the selected item(s) of the ListView.
Public methodIsColumnAvailable Determines whether the SHCOLUMNID passed is supported by the current view, no matter if it is currently displayed or not. Not supported on Windows XP.
Public methodIsSelected Returns true if the item with the passed index is selected.
Protected methodOnAddItem Issues the AddItem event.
Protected methodOnBeforeFullRefresh Issues the BeforeFullRefresh event.
Protected methodOnEnter Raises the Enter event.
(Overrides ControlOnEnter(EventArgs))
Protected methodOnHandleCreated Raises the HandleCreated event.
(Overrides ControlOnHandleCreated(EventArgs))
Protected methodOnKeyDown Raises the System.Windows.Forms.KeyDown event.
(Overrides ControlOnKeyDown(KeyEventArgs))
Protected methodOnKeyUp Raises the System.Windows.Forms.KeyUp event.
(Overrides ControlOnKeyUp(KeyEventArgs))
Protected methodOnMouseDoubleClick Raises the System.Windows.Forms.Control.MouseDoubleClick event. This method is called from the ListViewNativeWindow.WndProc function.
(Overrides ControlOnMouseDoubleClick(MouseEventArgs))
Protected methodOnOperation Fires an event if an operation was performed on the ShellListView.
Protected methodOnPathChanged Issues the PathChanged event.
Protected methodOnPopulated Issues the Populated event.
Protected methodOnResize This method overrides OnResize to also notify the com object (shellview) if the component was resized.
(Overrides ControlOnResize(EventArgs))
Protected methodProcessCmdKey In case the cursor keys are pressed, the message is forwarded to the shellview...s
(Overrides ControlProcessCmdKey(Message, Keys))
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.
Public methodSelectAll Select all items in the listview.
Public methodSelectedFileChange Gets called if the selected file should change.
Public methodSelectItem The item of the given index gets selected.
Protected methodSelectParent Selects the parent folder and calls a FullRefresh.
Public methodSmartRefresh Refreshes the control. Same as FullRefresh for the ShellSystemList.
Top
Events
 NameDescription
Public eventAddItem This event occurs if a SystemListItem is to be added to the list. If the "CanAdd" property of the event args is set to false in an event handler, the item will not be added to the listview.
Public eventBeforeFullRefresh This event occurs right before the FullRefresh method is called.
Public eventDefaultAction This event occurs if the user triggers the default command, e.g. double clicked on an item.
Public eventInitialized This event occurs after the Designer generated code has set all required properties.
Public eventOperationPerformed This event is fired after a ShellSystemList executed a shell operation like pasting.
Public eventPathChanged This event occurs if the path changed that the systemlistview displays.
Public eventPopulated This event occurs if the listview gets populated.
Public eventSelectionChanged This event occurs, if a selection changed in the listview
Public eventShowOptionChanged This event is fired after an option changed. It happens if ShowHidden, ShowNetHood, ShowRecycleBin, ShowFiles or ShowFolders was changed.
Public eventViewChanged This event happens if the View of the ImageList changed, either because it was set explicitly or if the user used the context menu to change to a different view.
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