ShellSystemList Class |
Note: This API is now obsolete.
Namespace: Jam.Shell
The ShellSystemList type exposes the following members.
Name | Description | |
---|---|---|
ShellSystemList |
Default constructor
|
Name | Description | |
---|---|---|
AllColumns |
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.
| |
BackColor |
This property is not implemented for the ShellSystemList.
(Overrides ControlBackColor.) | |
BackgroundImage |
This property is not implemented for the ShellSystemList.
(Overrides ControlBackgroundImage.) | |
BackgroundImageLayout |
This property is not implemented for the ShellSystemList.
(Overrides ControlBackgroundImageLayout.) | |
CheckMode | Gets or sets a value defining the current CheckMode. | |
Columns |
Gets the ShellViewColumns the control currently displays.
Not supported on Windows XP.
| |
ContentFilter |
Gets or sets an ShellItemFilter instance.
| |
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 |
Gets the required creation parameters when the control handle is created.
(Overrides ControlCreateParams.) | |
FileSystemOnly |
If FileSystemOnly is set to True, objects and virtual folders which do not have a file system path, will not be displayed.
| |
Filter |
You can use a single pattern, e.g. '*.doc' or concatenate several patterns using semicolons to separate them, e.g. '*.exe;*.com'.
| |
FilterRegex |
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.
| |
Focused |
Gets a value indicating whether a control has input focus.
| |
FolderIdList |
Get or set the ItemIdList of the folder the component currently displays respectively
the folder the component shall display.
| |
Font |
This property is not implemented for the ShellSystemList.
(Overrides ControlFont.) | |
ForeColor |
This property is not implemented for the ShellSystemList.
(Overrides ControlForeColor.) | |
InEditMode |
Returns true if the user is currently editing the caption of a listview item.
| |
IsInitialized |
Returns true if the ShellSystemList is property initialization has
been performed (after EndInit was called by the Designer generated code)
| |
ItemCount |
Gets the number of items the list currently holds.
| |
Items |
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.
| |
Path |
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.
| |
SelCount |
Gets the number of selected items.
| |
Selected |
Returns the currently selected item.
| |
SelectedFiles |
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.
| |
SelectedIndex |
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).
| |
SelectedItemIdList |
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.
| |
SelectedPath |
Get the full path of the selected item. Returns null if nothing is selected.
| |
ShellControlConnector |
Connects this control to a ShellControlConnector component, which allows to synchronize several shell controls.
| |
ShowBackgroundContextMenu |
If set to true, the Windows Explorer background context menu will be shown if a right click event occurs.
| |
ShowContextMenu |
If set to true, the Windows Explorer 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.
| |
ShowFiles |
If set to true, files will be shown in the control.
If set to false, files will not be visible in the control.
| |
ShowFolders |
The property ShowFolders allows you to include the folders in the ShellListView, similar to FrontPage 2000.
| |
ShowHidden |
Is set to 'true', hidden elements will also be shown.
| |
ShowNetHood |
If set to 'false', the Network Neighbourhood is not shown in the component,
otherwise it is shown (the default value is true).
| |
ShowRecycleBin |
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).
| |
SpecialFolder |
SpecialFolder allows you to set or get the type of the currently listed folder.
You can use the ShellFolder constants here.
| |
TextColor |
Get or set the TextColor of the Control
| |
Thumbnails |
Obsolete - use View.
| |
ThumbnailSize |
Gets or sets the size of the thumbnails. Only applied when View is set to FolderViewMode.Thumbnail
| |
Transparent |
Get or set the transparency value of the Control
| |
Version |
The current version of the ShellBrowser.
| |
View |
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.
| |
ViewFolderFlags |
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
|
Name | Description | |
---|---|---|
BeginInit |
Is called by the code generated with the designer.
| |
ContextSensitiveHelp |
IOleWindow interface implementation (http://msdn.microsoft.com/en-us/library/ms680102(VS.85).aspx)
| |
CreateDir |
Creates a new directory in the current folder.
| |
CreateHandle |
Creates a handle for the control
(Overrides ControlCreateHandle.) | |
DeselectAll |
Deselect all items in the listview
| |
DisplayContextMenu |
Shows the shell context menu for the currently selected items
| |
EndInit |
Is called by the designer generated code, triggers the Initialized event.
| |
FilterMatch |
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.
| |
FolderChanged |
Gets called if the active folder should change.
If a ShellControlConnector is assigned to the control, it is notified.
| |
FullRefresh |
This method only operates if the Handle has been allocated.
| |
GetItem |
Get the ItemIdList at the index specified.
| |
GetShellItem |
Get the item at the specified index.
| |
GetWindow |
IOleWindow interface implementation (http://msdn.microsoft.com/en-us/library/ms680102(VS.85).aspx)
| |
GoUp |
Selects the parent folder in the SystemListView.
| |
IncludeObjectInList |
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.
| |
IndexOf(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
| |
IndexOf(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
| |
InformPathChanged |
Inform of the ShellControlConnector that the
path currently displayed has changed.
| |
InvokeCommandOnFolder |
Use InvokeCommandOnFolder to execute a command of the context menu for the listed folder.
| |
InvokeCommandOnSelected |
Invokes a ShellCommand on the selected item(s) of the ListView.
| |
IsColumnAvailable |
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.
| |
IsSelected |
Returns true if the item with the passed index is selected.
| |
OnAddItem |
Issues the AddItem event.
| |
OnBeforeFullRefresh |
Issues the BeforeFullRefresh event.
| |
OnEnter |
Raises the Enter event.
(Overrides ControlOnEnter(EventArgs).) | |
OnHandleCreated |
Raises the HandleCreated event.
(Overrides ControlOnHandleCreated(EventArgs).) | |
OnKeyDown |
Raises the System.Windows.Forms.KeyDown event.
(Overrides ControlOnKeyDown(KeyEventArgs).) | |
OnKeyUp |
Raises the System.Windows.Forms.KeyUp event.
(Overrides ControlOnKeyUp(KeyEventArgs).) | |
OnMouseDoubleClick |
Raises the System.Windows.Forms.Control.MouseDoubleClick event.
This method is called from the ListViewNativeWindow.WndProc
function.
(Overrides ControlOnMouseDoubleClick(MouseEventArgs).) | |
OnOperation |
Fires an event if an operation was performed on the ShellListView.
| |
OnPathChanged |
Issues the PathChanged event.
| |
OnPopulated |
Issues the Populated event.
| |
OnResize |
This method overrides OnResize to also notify the com object (shellview) if
the component was resized.
(Overrides ControlOnResize(EventArgs).) | |
ProcessCmdKey |
In case the cursor keys are pressed, the message is forwarded to the shellview...s
(Overrides ControlProcessCmdKey(Message, Keys).) | |
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. | |
SelectAll |
Select all items in the listview.
| |
SelectedFileChange |
Gets called if the selected file should change.
| |
SelectItem |
The item of the given index gets selected.
| |
SelectParent |
Selects the parent folder and calls a FullRefresh.
| |
SmartRefresh |
Refreshes the control. Same as FullRefresh for the ShellSystemList.
|
Name | Description | |
---|---|---|
AddItem |
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.
| |
BeforeFullRefresh |
This event occurs right before the FullRefresh method is called.
| |
DefaultAction |
This event occurs if the user triggers the default command,
e.g. double clicked on an item.
| |
Initialized |
This event occurs after the Designer generated code has set all
required properties.
| |
OperationPerformed |
This event is fired after a ShellSystemList executed a shell operation like pasting.
| |
PathChanged |
This event occurs if the path changed that the systemlistview displays.
| |
Populated |
This event occurs if the listview gets populated.
| |
SelectionChanged |
This event occurs, if a selection changed in the listview
| |
ShowOptionChanged |
This event is fired after an option changed. It happens if
ShowHidden, ShowNetHood,
ShowRecycleBin, ShowFiles or ShowFolders was changed.
| |
ViewChanged |
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.
|
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.) |