SftpItemCollection Class

Namespace: Rebex.Net
Assembly: Rebex.Sftp.dll (version 7.0.9147)

Provides a container for a collection of SftpItem objects.

Syntax
public class SftpItemCollection : FileSystemItemCollection, ICollection<FileSystemItem>, IEnumerable<FileSystemItem>, ICollection, ICollection<SftpItem>, IEnumerable<SftpItem>, IEnumerable
Inheritance
Object
FileSystemItemCollection
SftpItemCollection
Implements
Inherited Members

Constructors

Name Description
SftpItemCollection()

Initializes a new instance of the SftpItemCollection class.

Properties

Name Description
Count

Gets the number of elements contained in the collection. Inherited from FileSystemItemCollection.
IsSynchronized

Gets a value indicating whether access to the collection is synchronized (thread-safe).
Item[Int32]

Gets the item at the specified index.
Item[String]

Gets the item of the specified path.
SyncRoot

Gets an object that can be used to synchronize access to the collection. Inherited from FileSystemItemCollection.
UsePath

Gets or sets a value that indicates whether to use a Path or Name for pattern matching and return values in the GetFiles(Regex) method. Inherited from FileSystemItemCollection.

Methods

Name Description
Add(FileSystemItem)

Adds the specified item to the collection. Inherited from FileSystemItemCollection.
Add(SftpItem)

Adds the item to the collection.
AddRange(IEnumerable<FileSystemItem>)

Adds the elements of the specified collection to the end of the FileSystemItemCollection. Inherited from FileSystemItemCollection.
AddRange(IEnumerable<SftpItem>)

Adds the elements of the specified collection to the end of the SftpItemCollection.
CheckItem(FileSystemItem)

Validates whether the item is correct and can be added.
Clear()

Removes all items from the collection. Inherited from FileSystemItemCollection.
Clone()

Creates a shallow copy of the collection.
Contains(FileSystemItem)

Determines whether the item is in the collection. Inherited from FileSystemItemCollection.
Contains(SftpItem)

Determines whether the item is in the collection.
Contains(String)

Determines whether the item with the specified path is in the collection. Inherited from FileSystemItemCollection.
CopyTo(FileSystemItem[], Int32)

Copies the range of elements from the collection to a one-dimensional FileSystemItem array, starting at the specified index of the target array. Inherited from FileSystemItemCollection.
CopyTo(SftpItem[], Int32)

Copies the range of elements from the collection to a one-dimensional SftpItem array, starting at the specified index of the target array.
CopyTo(Array, Int32)

Copies the range of elements from the collection to a compatible one-dimensional Array, starting at the specified index of the target array.
GetEnumerator()

Gets an IEnumerator<T> for the collection.
GetFiles(String)

Returns the names of files in the collection that match the specified search pattern. Inherited from FileSystemItemCollection.
GetFiles(String, Boolean)

Returns the names of files in the collection that match the specified search pattern. Inherited from FileSystemItemCollection.
GetFiles(Regex)

Returns the paths of files in the collection that match the specified search pattern. Inherited from FileSystemItemCollection.
GetTotalSize()

Gets the total size of files contained in the collection. Inherited from FileSystemItemCollection.
Remove(FileSystemItem)

Removes the specified item from the collection. Inherited from FileSystemItemCollection.
Remove(SftpItem)

Removes the specified item from the collection. Fails if not found.
Remove(String)

Removes the item with the specified path from the collection.
RemoveAt(Int32)

Removes the item at the specified index from the collection. Inherited from FileSystemItemCollection.
Sort()

Sorts the items in the entire collection alphabetically. Inherited from FileSystemItemCollection.
Sort(IComparer)

Sorts the elements in the entire collection using the specified comparer. Inherited from FileSystemItemCollection.
Sort(Int32, Int32, IComparer)

Sorts the elements in a section of the collection using the specified comparer. Inherited from FileSystemItemCollection.

Explicit Interface Implementations

Name Description
ICollection<FileSystemItem>.IsReadOnly

Gets a value indicating whether the collection is read-only. Inherited from FileSystemItemCollection.
ICollection<SftpItem>.IsReadOnly

Gets a value indicating whether the collection is read-only.
ICollection<SftpItem>.Remove(SftpItem)

Removes the specified item from the collection.
IEnumerable.GetEnumerator()

Returns an enumerator that can iterate through the collection Inherited from FileSystemItemCollection.