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

SystemObject
  System.Collections.SpecializedNameObjectCollectionBase
    Jam.ShellPathCollection
      Jam.ShellWinFormsPathCollection
        Jam.ShellBaseSelectionList
          Jam.ShellPathSelectionList

Namespace: Jam.Shell
Assembly: ShellBrowser.Winforms (in ShellBrowser.Winforms.dll) Version: 6.3.1

Syntax

C++

Copy

[SerializableAttribute]
public class PathSelectionList : BaseSelectionList, 
	IEnumerable<string>, IEnumerable

<SerializableAttribute>
Public Class PathSelectionList
	Inherits BaseSelectionList
	Implements IEnumerable(Of String), IEnumerable

[SerializableAttribute]
public ref class PathSelectionList : public BaseSelectionList, 
	IEnumerable<String^>, IEnumerable

[<SerializableAttribute>]
type PathSelectionList =  
    class
        inherit BaseSelectionList
        interface IEnumerable<string>
        interface IEnumerable
    end

The PathSelectionList type exposes the following members.

Constructors

	Name	Description
	PathSelectionList	Default constructor.

Top

Properties

	Name	Description
	AllowDuplicates	Gets or sets a value indicating whether to allow duplicate entries in the list. (Inherited from PathCollection.)
	CalculateSelectedFiles	Use CalculateSelectedFiles to control whether the size and count of the selected files should be calculated or not. (Inherited from BaseSelectionList.)
	CheckIfExists	If true, paths that do not exist will not be added to the list (Inherited from PathCollection.)
	FileCount	Get the total number of selected files. (Inherited from BaseSelectionList.)
	FolderCount	Get the total number of selected folders. (Inherited from BaseSelectionList.)
	IsLocalPathSelected	Returns true, if files on local drives are selected.
	IsReadOnly	Gets a value indicating whether the collection is read-only. (Inherited from PathCollection.)
	IsUNCPathSelected	Returns true, if files on UNC paths are selected.
	Item	Returns a path with a certain index. (Inherited from PathCollection.)
	Size	Get the total size of the selected items. (Inherited from BaseSelectionList.)

Top

Methods

	Name	Description
	AbortSizeCalculation	Aborts the calculation of the selected files size. (Inherited from BaseSelectionList.)
	Add(IEnumerable)	Add all items of the given enumrable class to the list. (Inherited from PathCollection.)
	Add(String)	Adds the given path to the list of path. (Inherited from PathCollection.)
	Add(IEnumerableIJamItemIdList)	Adds the paths of the passed ItemIdLists to the list. (Inherited from PathCollection.)
	AddAllExclude	Adds all folders of a given path except the folder passed in p_ExcludeFolder.
	AddPath	Adds the given path to the list of path. It does not fire the Changing and Change event. (Inherited from PathCollection.)
	AddPathToSelection	Adds a path to the list of selected paths. (Overrides BaseSelectionListAddPathToSelection(String).)
	BeginUpdate	Prevent that the SelectionListChanged event is fired until EndUpdate is called. Every call of BeginUpdate() increments an UpdateCounter variable. (Inherited from PathCollection.)
	BoolToSelectionState	Returns a Checkstate for a given Boolean.
	CalculateAndUpdateSize	Calculates the count and size for the given folder and updates the properties. (Overrides BaseSelectionListCalculateAndUpdateSize(String, Boolean).)
	Clear	Removes all elements from the list (Inherited from BaseSelectionList.)
	Clone	Creates a copy of the current PathCollection (Inherited from PathCollection.)
	CompleteChildPathSelected	Checks if a folder path is completly selected.
	CompletePathSelected	Ensures that the smallest complete selected path is added. (Overrides BaseSelectionListCompletePathSelected(String).)
	CompletePathSelectedExclude	Checks the parent folder of a folder is full selected.
	Contains	Returns true if the given path is in the list (Inherited from PathCollection.)
	CopyTo	Copies the elements of the PathCollection to an Array, starting at a particular Array index. (Inherited from PathCollection.)
	Delete	Removes the path with the given index from the list. (Inherited from PathCollection.)
	DeleteEntry(Int32)	Overloaded method DeleteEntry, which deletes an entry at the passed position with default recalculating size and filecount.
	DeleteEntry(Int32, Boolean)	Deletes an entry at the passed position with recalculating size and filecount, when CalculateSizeAndCount is true.
	Dispose	Releases ressources. (Inherited from PathCollection.)
	Dispose(Boolean)	Releases managed ressources. (Inherited from BaseSelectionList.)
	EndUpdate	Every call of EndUpdate() decrements the UpdateCounter variable. When the UpdateCounter is 0, then the SelectionListChanged event is fired. (Overrides PathCollectionEndUpdate.)
	Finalize	Finalizes an instance of the BaseSelectionList class. (Inherited from BaseSelectionList.)
	FormatSelectionPath	Unifies the given path and checks if it exists.
	GetCheckState	For internal use: Check if item is in the selection.
	GetFileEnumerator	Returns an Enumerator to use the PathSelectionList in a foreach statement.
	GetFolderSizeCallback	This callback method is called once the asynchronous calculation of a folder size is finished.
	GetListItem	Returns an item of the list at the passed index. (Inherited from BaseSelectionList.)
	IndexOf	Returns the index of the given path. (Inherited from PathCollection.)
	IsItemFullSelected	Determines if an item is in the selection list directly, or if one of its parent folders is in the selection list.
	IsLinkedPath	Check if the passed path is a link.
	IsPathSelected	This function returns for the given path, if it is fully, partially or not part of the list of selected files.
	IsUpdating	Query if this instance is currently updating. (Inherited from PathCollection.)
	Objects	Returns the object associated with a path. (Inherited from PathCollection.)
	OnChanged	Fires the Change event. (Inherited from PathCollection.)
	OnChanging	Fires the Changing event. (Inherited from PathCollection.)
	OnCompletedSizeCalculation	Raises the CompletedSizeCalculation event.
	OnSelectionChanged	Fires the SelectionChanged event.
	PathSelected	For internal use: Check if item is in the selection. (Overrides BaseSelectionListPathSelected(String, Boolean).)
	PathWasRenamed	Searches the path in the selected files and if found, replaces it by the new name within the collection. (Overrides PathCollectionPathWasRenamed(String, String).)
	Remove	Removes a path from the list. (Inherited from PathCollection.)
	RemovePath	Removes the given path. (Inherited from PathCollection.)
	RemovePathFromSelection	Use this procedure to remove an item from the selection list. (Overrides BaseSelectionListRemovePathFromSelection(String).)
	RemoveSubFolders	Remove subfolders of the path from the current selection.
	ToString	Override the inherited method ToString(). (Inherited from PathCollection.)
	Update	Updates the object associated with a path. (Inherited from PathCollection.)

Top

Events

	Name	Description
	Change	This event gets fired after items were added or deleted. (Inherited from PathCollection.)
	Changing	This event gets fired before items are added or deleted. (Inherited from PathCollection.)
	CompletedSizeCalculation	This event is triggered whenever the calculation of the folder size is finished for a folder.
	SelectionChanged	This event is triggered whenever the selection list is changed.

Top

Fields

	Name	Description
	m_FileCount	the current file count. (Inherited from BaseSelectionList.)
	m_FolderCount	the current folder count. (Inherited from BaseSelectionList.)
	m_Size	the current size. (Inherited from BaseSelectionList.)

Top

Reference

Jam.Shell Namespace