Click or drag to resize

PathSelectionList Class

This class is used as a property of the JamShellLink component for managing the list of selected paths that the user selects with shell controls that have the CheckBoxes property set to True. You can modify the list using the AddPathToSelection and RemovePathFromSelection method. You can save or load the list using the SaveToIniFile and LoadFromIniFile methods.
Inheritance Hierarchy

Namespace:  Jam.Shell
Assembly:  ShellBrowser (in ShellBrowser.dll) Version: 6.2
Syntax
[SerializableAttribute]
public class PathSelectionList : BaseSelectionList, 
	IEnumerable<string>, IEnumerable

The PathSelectionList type exposes the following members.

Constructors
  NameDescription
Public methodPathSelectionList
Default constructor.
Top
Properties
  NameDescription
Public propertyAllowDuplicates
Gets or sets a value indicating whether to allow duplicate entries in the list.
(Inherited from PathCollection.)
Public propertyCalculateSelectedFiles
Use CalculateSelectedFiles to control whether the size and count of the selected files should be calculated or not.
(Inherited from BaseSelectionList.)
Public propertyCheckIfExists
If true, paths that do not exist will not be added to the list
(Inherited from PathCollection.)
Public propertyFileCount
Get the total number of selected files.
(Inherited from BaseSelectionList.)
Public propertyFolderCount
Get the total number of selected folders.
(Inherited from BaseSelectionList.)
Public propertyIsLocalPathSelected
Returns true, if files on local drives are selected.
Public propertyIsReadOnly
Gets a value indicating whether the collection is read-only.
(Inherited from PathCollection.)
Public propertyIsUNCPathSelected
Returns true, if files on UNC paths are selected.
Public propertyItem
Returns a path with a certain index.
(Inherited from PathCollection.)
Public propertySize
Get the total size of the selected items.
(Inherited from BaseSelectionList.)
Top
Methods
  NameDescription
Protected methodAbortSizeCalculation
Aborts the calculation of the selected files size.
(Inherited from BaseSelectionList.)
Public methodAdd(IEnumerable)
Add all items of the given enumrable class to the list.
(Inherited from PathCollection.)
Public methodAdd(String)
Adds the given path to the list of path.
(Inherited from PathCollection.)
Public methodAdd(IEnumerableIJamItemIdList)
Adds the paths of the passed ItemIdLists to the list.
(Inherited from PathCollection.)
Protected methodAddAllExclude
Adds all folders of a given path except the folder passed in p_ExcludeFolder.
Protected methodAddPath
Adds the given path to the list of path. It does not fire the Changing and Change event.
(Inherited from PathCollection.)
Public methodAddPathToSelection
Adds a path to the list of selected paths.
(Overrides BaseSelectionListAddPathToSelection(String).)
Public methodBeginUpdate
Prevent that the SelectionListChanged event is fired until EndUpdate is called. Every call of BeginUpdate() increments an UpdateCounter variable.
(Inherited from PathCollection.)
Public methodStatic memberBoolToSelectionState
Returns a Checkstate for a given Boolean.
Protected methodCalculateAndUpdateSize
Calculates the count and size for the given folder and updates the properties.
(Overrides BaseSelectionListCalculateAndUpdateSize(String, Boolean).)
Public methodClear
Removes all elements from the list
(Inherited from BaseSelectionList.)
Public methodClone
Creates a copy of the current PathCollection
(Inherited from PathCollection.)
Protected methodCompleteChildPathSelected
Checks if a folder path is completly selected.
Protected methodCompletePathSelected
Ensures that the smallest complete selected path is added.
(Overrides BaseSelectionListCompletePathSelected(String).)
Protected methodCompletePathSelectedExclude
Checks the parent folder of a folder is full selected.
Public methodContains
Returns true if the given path is in the list
(Inherited from PathCollection.)
Public methodCopyTo
Copies the elements of the PathCollection to an Array, starting at a particular Array index.
(Inherited from PathCollection.)
Public methodDelete
Removes the path with the given index from the list.
(Inherited from PathCollection.)
Protected methodDeleteEntry(Int32)
Overloaded method DeleteEntry, which deletes an entry at the passed position with default recalculating size and filecount.
Protected methodDeleteEntry(Int32, Boolean)
Deletes an entry at the passed position with recalculating size and filecount, when CalculateSizeAndCount is true.
Public methodDispose
Releases ressources.
(Inherited from PathCollection.)
Protected methodDispose(Boolean)
Releases managed ressources.
(Inherited from BaseSelectionList.)
Public methodEndUpdate
Every call of EndUpdate() decrements the UpdateCounter variable. When the UpdateCounter is 0, then the SelectionListChanged event is fired.
(Overrides PathCollectionEndUpdate.)
Protected methodFinalize
Finalizes an instance of the BaseSelectionList class.
(Inherited from BaseSelectionList.)
Protected methodStatic memberFormatSelectionPath
Unifies the given path and checks if it exists.
Protected methodGetCheckState
For internal use: Check if item is in the selection.
Public methodCode exampleGetFileEnumerator
Returns an Enumerator to use the PathSelectionList in a foreach statement.
Protected methodGetFolderSizeCallback
This callback method is called once the asynchronous calculation of a folder size is finished.
Protected methodGetListItem
Returns an item of the list at the passed index.
(Inherited from BaseSelectionList.)
Public methodIndexOf
Returns the index of the given path.
(Inherited from PathCollection.)
Protected methodIsItemFullSelected
Determines if an item is in the selection list directly, or if one of its parent folders is in the selection list.
Protected methodStatic memberIsLinkedPath
Check if the passed path is a link.
Public methodIsPathSelected
This function returns for the given path, if it is fully, partially or not part of the list of selected files.
Public methodIsUpdating
Query if this instance is currently updating.
(Inherited from PathCollection.)
Public methodObjects
Returns the object associated with a path.
(Inherited from PathCollection.)
Protected methodOnChanged
Fires the Change event.
(Inherited from PathCollection.)
Protected methodOnChanging
Fires the Changing event.
(Inherited from PathCollection.)
Protected methodOnCompletedSizeCalculation
Raises the CompletedSizeCalculation event.
Protected methodOnSelectionChanged
Fires the SelectionChanged event.
Protected methodPathSelected
For internal use: Check if item is in the selection.
(Overrides BaseSelectionListPathSelected(String, Boolean).)
Public methodPathWasRenamed
Searches the path in the selected files and if found, replaces it by the new name within the collection.
(Overrides PathCollectionPathWasRenamed(String, String).)
Public methodRemove
Removes a path from the list.
(Inherited from PathCollection.)
Protected methodRemovePath
Removes the given path.
(Inherited from PathCollection.)
Public methodRemovePathFromSelection
Use this procedure to remove an item from the selection list.
(Overrides BaseSelectionListRemovePathFromSelection(String).)
Protected methodRemoveSubFolders
Remove subfolders of the path from the current selection.
Public methodToString
Override the inherited method ToString().
(Inherited from PathCollection.)
Public methodUpdate
Updates the object associated with a path.
(Inherited from PathCollection.)
Top
Events
  NameDescription
Public eventChange
This event gets fired after items were added or deleted.
(Inherited from PathCollection.)
Public eventChanging
This event gets fired before items are added or deleted.
(Inherited from PathCollection.)
Public eventCompletedSizeCalculation
This event is triggered whenever the calculation of the folder size is finished for a folder.
Public eventSelectionChanged
This event is triggered whenever the selection list is changed.
Top
Fields
  NameDescription
Protected fieldm_FileCount
the current file count.
(Inherited from BaseSelectionList.)
Protected fieldm_FolderCount
the current folder count.
(Inherited from BaseSelectionList.)
Protected fieldm_Size
the current size.
(Inherited from BaseSelectionList.)
Top
See Also