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.
| C# | Visual Basic | Visual C++ |
public class PathSelectionList : BaseSelectionList, IEnumerable<string>, IEnumerable
Public Class PathSelectionList _ Inherits BaseSelectionList _ Implements IEnumerable(Of String), IEnumerable
public ref class PathSelectionList : public BaseSelectionList, IEnumerable<String^>, IEnumerable
| All Members | Constructors | Methods | Properties | Events | |
| Icon | Member | Description |
|---|---|---|
| PathSelectionList()()() | Initializes a new instance of the PathSelectionList class | |
| AbortSizeCalculation()()() |
Aborts the calculation of the selected files size.
(Inherited from BaseSelectionList.) | |
| Add(String) |
Adds the given path to the list of path.
(Inherited from PathCollection.) | |
| Add(IEnumerable) |
Add all items of the given enumrable class to the list.
(Inherited from PathCollection.) | |
| AddAllExclude(String, String) |
Adds all folders of a given path except the folder passed in p_ExcludeFolder.
| |
| AddPath(String) |
Adds the given path to the list of path. It does not fire the Changing and Change event.
(Inherited from PathCollection.) | |
| AddPathToSelection(String) |
Adds a path to the list of selected paths.
(Overrides BaseSelectionList.AddPathToSelection(String).) | |
| BaseAdd(String, Object) |
Adds an entry with the specified key and value into the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| BaseClear()()() |
Removes all entries from the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| BaseGet(String) |
Gets the value of the first entry with the specified key from the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| BaseGet(Int32) |
Gets the value of the entry at the specified index of the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| BaseGetAllKeys()()() |
Returns a String array that contains all the keys in the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| BaseGetAllValues()()() |
Returns an Object array that contains all the values in the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| BaseGetAllValues(Type) |
Returns an array of the specified type that contains all the values in the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| BaseGetKey(Int32) |
Gets the key of the entry at the specified index of the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| BaseHasKeys()()() |
Gets a value indicating whether the NameObjectCollectionBase instance contains entries whose keys are not null.
(Inherited from NameObjectCollectionBase.) | |
| BaseRemove(String) |
Removes the entries with the specified key from the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| BaseRemoveAt(Int32) |
Removes the entry at the specified index of the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| BaseSet(String, Object) |
Sets the value of the first entry with the specified key in the NameObjectCollectionBase instance, if found; otherwise, adds an entry with the specified key and value into the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| BaseSet(Int32, Object) |
Sets the value of the entry at the specified index of the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| BeginUpdate()()() |
Prevent that the SelectionListChanged event is fired until EndUpdate is called. Every call of BeginUpdate() increments an UpdateCounter variable.
| |
| BoolToSelectionState(Boolean) |
Returns a Checkstate for a given Boolean.
| |
| CalculateAndUpdateSize(String, Boolean) |
Calculates the count and size for the given folder and updates the properties.
(Overrides BaseSelectionList.CalculateAndUpdateSize(String, Boolean).) | |
| CalculateSelectedFiles |
Use CalculateSelectedFiles to control whether the size and count of the selected files should be calculated or not.
(Inherited from BaseSelectionList.) | |
| 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.) | |
| CheckIfExists |
If true, paths that do not exist will not be added to the list
(Inherited from PathCollection.) | |
| Clear()()() |
Removes all elements from the list
(Inherited from BaseSelectionList.) | |
| Clone()()() |
Creates a copy of the current PathCollection
(Inherited from PathCollection.) | |
| CompleteChildPathSelected(String) |
Checks if a folder path is completly selected.
| |
| CompletedSizeCalculation |
This event is triggered whenever the calculation of the folder size is finished for a folder.
| |
| CompletePathSelected(String) |
Ensures that the smallest complete selected path is added.
(Overrides BaseSelectionList.CompletePathSelected(String).) | |
| CompletePathSelectedExclude(String, String) |
Checks the parent folder of a folder is full selected.
| |
| Contains(String) |
Returns true if the given path is in the list
(Inherited from PathCollection.) | |
| CopyTo(array<String>[]()[], Int32) |
Copies the elements of the PathCollection to an Array, starting at a particular Array index.
(Inherited from PathCollection.) | |
| Count |
Gets the number of key/value pairs contained in the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| Delete(Int32) |
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.
| |
| EndUpdate()()() |
Every call of EndUpdate() decrements the UpdateCounter variable. When the UpdateCounter is 0, then the SelectionListChanged event is fired.
| |
| Equals(Object) | (Inherited from Object.) | |
| FileCount |
Get the total number of selected files.
(Inherited from BaseSelectionList.) | |
| Finalize()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| FolderCount |
Get the total number of selected folders.
(Inherited from BaseSelectionList.) | |
| FormatSelectionPath(String%) |
Unifies the given path and checks if it exists.
| |
| GetCheckState(String, Boolean%) |
For internal use: Check if item is in the selection.
| |
| GetEnumerator()()() |
Returns an enumerator that iterates through the NameObjectCollectionBase.
(Inherited from NameObjectCollectionBase.) | |
| GetFileEnumerator()()() |
Returns an Enumerator to use the PathSelectionList in a foreach statement.
| |
| GetFolderSizeCB(String, Int64, Int32, Int32, Object) |
This callback method is called once the asynchronous calculation of a folder size is finished.
| |
| GetHashCode()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetListItem(Int32) |
Returns an item of the list at the passed index.
(Inherited from BaseSelectionList.) | |
| GetObjectData(SerializationInfo, StreamingContext) |
Implements the ISerializable interface and returns the data needed to serialize the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| GetType()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
| IndexOf(String) |
Returns the index of the given path.
(Inherited from PathCollection.) | |
| IsItemFullSelected(String) |
returns True if an item is in the selection list directly, or if one of its parent folders is in the selection list
| |
| IsLinkedPath(String) |
Check if the passed path is a link.
| |
| IsLocalPathSelected |
Returns true, if files on local drives are selected.
| |
| IsPathSelected(String) |
This function returns for the given path, if it is fully, partially or not part of the list of selected files.
| |
| 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[([(Int32])]) |
Returns a path with a certain index.
(Inherited from PathCollection.) | |
| Keys |
Gets a NameObjectCollectionBase..::.KeysCollection instance that contains all the keys in the NameObjectCollectionBase instance.
(Inherited from NameObjectCollectionBase.) | |
| MemberwiseClone()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| Objects(Int32) |
Returns the object associated with a path.
(Inherited from PathCollection.) | |
| OnChanged()()() |
Fires the Change event
(Inherited from PathCollection.) | |
| OnChanging()()() |
Fires the Change event
(Inherited from PathCollection.) | |
| OnCompletedSizeCalculation()()() |
Raises the CompletedSizeCalculation event.
| |
| OnDeserialization(Object) |
Implements the ISerializable interface and raises the deserialization event when the deserialization is complete.
(Inherited from NameObjectCollectionBase.) | |
| OnSelectionChanged()()() |
Fires the SelectionChanged event.
| |
| PathSelected(String, Boolean%) |
For internal use: Check if item is in the selection.
(Overrides BaseSelectionList.PathSelected(String, Boolean%).) | |
| PathWasRenamed(String, String) |
Searches the path in the selected files and if found,
replaces it by the new name within the collection.
(Overrides PathCollection.PathWasRenamed(String, String).) | |
| Remove(String) |
Removes a path from the list.
(Inherited from PathCollection.) | |
| RemovePathFromSelection(String) |
Use this procedure to remove an item from the selection list.
(Overrides BaseSelectionList.RemovePathFromSelection(String).) | |
| RemoveSubFolders(String) |
Remove subfolders of the path from the current selection.
| |
| SelectionChanged |
This event is triggered whenever the selection list is changed.
| |
| Size |
Get the total size of the selected items.
(Inherited from BaseSelectionList.) | |
| ToString()()() |
Override the inherited method ToString().
(Inherited from PathCollection.) | |
| Update(Int32, Object) |
Updates the object associated with a path.
(Inherited from PathCollection.) |
| Object | ||||
| NameObjectCollectionBase | ||||
| PathCollection | ||||
| BaseSelectionList | ||||
| PathSelectionList | ||||