Click or drag to resize

ShellListBaseItem Class

Base class for list items used in derived classes. An instance usually represents an item of the windows shell namespace.
Inheritance Hierarchy

Namespace:  Jam.Shell
Assembly:  ShellBrowser (in ShellBrowser.dll) Version: 6.1
Syntax
[SerializableAttribute]
public abstract class ShellListBaseItem : ListViewItem, 
	IShellItem, IJamShellItemVisuals, IJamShellItemOperations, ICheckableItem

The ShellListBaseItem type exposes the following members.

Constructors
  NameDescription
Protected methodShellListBaseItem
The default constructor.
Top
Properties
  NameDescription
Public propertyAbsoluteItemIdList
Lazy loads and caches the ItemIdList corresponding to the complete path of the ListItem.
Public propertyChecked
This property calls CheckState and returns true only if the item is CheckState.Checked and false if in CheckState.Grayed or CheckState.UnChecked.
Public propertyCheckState
If the CheckBoxes property of the ShellListView is true then this property can be used to get or set the check state. If the value that is set changes the item's checkstate, and a ShellControlConnector is assigned to the ShellListView the item is contained in, the SelectionList will be updated accordingly.
Public propertyColumnInfoAvailable
Returns true if the columns have been added as subitems
Public propertyCut
Defines if the item's image should be shown ghosted or not.
Public propertyDetailsCompleted
Returns true if item details have already been loaded.
Public propertyFullPath
Use to get the full path of this item.
Protected propertyItemIdListWorkItem
Holds a WorkItem running for this instance.
Public propertyOverlayImage
The index of the overlay image in the system image list that should be shown in front of the normal icon.
Protected propertyQueuedCompleteDetailsWorkItem
Holds an already queued workitem to complete the item details, to avoid queuing more than 1 workitem per item.
Public propertyRelativeItemIdList
Get the relative PIDL of the current item.
Public propertyShellListView
The same instance as ListView but typed as JamBaseShellListView.
Protected propertyTooltipWorkItem
Cache for the TooltipWorkItem to make sure only one is running at a time.
Protected propertyVariantColumnTexts
This array holds the column texts of the item. It`s filled in FillSubitems.
Top
Methods
  NameDescription
Protected methodAfterRename
Refreshes the item`s ItemIdLists, text and executes the PathWasRenamed methods
Public methodCompleteDetails
Completes the details of the ShellListBaseItem, given that it's ListView property is set, ie. the item has been added to the listview. Consider calling CompleteDetails(JamBaseShellListView) if the Item has not yet been added to the ListView.
Public methodCompleteDetails(JamBaseShellListView)
Completes the details of the ShellListBaseItem
Protected methodGetThumbnailCallback
This method is called when the thumbnail image is rendered completely
Public methodGetVariantValue
Gets the value for the specified column as variant.
Public methodInvertCheckState
This method inverts the CheckState of the ShellListItem instance. If the Item was checked it's state will be set to unchecked. If it was Grayed or UnChecked it will be Checked afterwards. If the Item is not associated (contained) in a ShellListView or the ShellListView has no ShellControlConnector assigned, this method does nothing and returns immediately. Furthermore the ListView needs to have the CheckBoxes property enabled.
Protected methodInvokeSetCut
Sets Cut property through BeginInvoke
Protected methodInvokeSetImageIndex
Sets the ImageIndex property through BeginInvoke
Protected methodInvokeSetOverlayIndex
Sets the OverlayImage index property through BeginInvoke
Protected methodInvokeSetThumbnailImage
Invokes SetThumbnailBitmap(ImageList, Bitmap, ShellBrowser) from the gui thread, this adds the bitmap to the imagecollection of the imagelist, sets the image index of this item accordingly. Queues another work-item to obtain a real thumbnail later on
Public methodRefreshCheckState
Refreshes the value of the CheckState CheckSate property by starting an asynchronous operation. Calling this method has no effect if the item is not part of a list, or has no ShellControlConnector assigned.
Protected methodRefreshGhostedState
Refreshes the ghosted state of the item, e.g. after a SmartRefresh.
Protected methodRefreshOverlayImageIndex
Refreshes the overlay image index of the item.
Public methodReload
Reloads the item. If an ItemIdList is passed it is refreshed and used as new absolute ItemIdList for the item.
Protected methodRemoveSubItem
Removes the subitem at the passed postion.
Public methodRename
Renames the item.
Protected methodSetImageIndex
Protected methodSetThumbnailBitmap
Adds the bitmap to the imagecollection of the imagelist, sets the image index of this item accordingly. Queues another work-item to obtain a real thumbnail later on
Top
Fields
  NameDescription
Protected fieldm_AbsoluteItemIdList
Absolute ItemIdList of this item.
Protected fieldm_ItemState
Stores the state of the item. DetailsCompleted and Cut
Protected fieldm_OverlayImage
Used to store the value of the OverlayImage OverlayImage property, the index of the overlay item in the system image list of this item.
Protected fieldm_RelativeItemIdList
ItemIdList of this item relative to the folder p_Path ItemIdList.
Protected fieldm_VariantColumnTexts
This list holds the column texts of the item. It`s filled in FillSubitems.
Top
See Also