home *** CD-ROM | disk | FTP | other *** search
<?xml version="1.0"?> <doc> <assembly> <name>Xceed.FileSystem</name> </assembly> <members> <member name="T:Xceed.FileSystem.FileSystemException"> <summary> Exception that is thrown when an error occurs in the Xceed.FileSystem namespace. </summary> <remarks><para> This exception serves as the base class for all custom exceptions defined in the Xceed.FileSystem namespace. </para><para> Specializations of the FileSystem object model also throw exceptions that derives from <see langword="FileSystemException"/>. </para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemException.#ctor(System.String)"> <summary> Initializes a new instance of the exception with the specified message text. </summary><param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:Xceed.FileSystem.FileSystemException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the exception with the specified message text and inner exception. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="M:Xceed.FileSystem.FileSystemException.#ctor(System.String,Xceed.FileSystem.FileSystemItem)"> <summary> Initializes a new instance of the exception with the specified message text and FileSystemItem object. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param> </member> <member name="M:Xceed.FileSystem.FileSystemException.#ctor(System.String,Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified message text, FileSystemItem object and inner exception. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="P:Xceed.FileSystem.FileSystemException.Message"> <summary> Gets a message that describes the current exception. </summary> <value>A message that describes the current exception, or an empty string.</value> </member> <member name="P:Xceed.FileSystem.FileSystemException.Item"> <summary> Gets or sets the <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that caused the current exception. </summary> <value>The FileSystemItem object that caused the exception to be thrown. Can be null.</value> </member> <member name="T:Xceed.FileSystem.FileSystemInternalException"> <summary> Exception that is thrown when something unexpected occurs in the Xceed.FileSystem namespace. </summary> <remarks> <para> This exception means that there was an internal failure in the library, and that nothing could be done to prevent it. Such failures should never occur. </para><para> To get more details about what went wrong, you can inspect the <see cref="P:System.Exception.InnerException"/> property. It is a reference to the exception that caused the internal failure. </para><para> If you ever catch this exception in your code, please contact Xceed Software Technical Support immediately. </para> </remarks> </member> <member name="M:Xceed.FileSystem.FileSystemInternalException.#ctor"> <summary> Initializes a new instance of the exception. </summary> </member> <member name="M:Xceed.FileSystem.FileSystemInternalException.#ctor(Xceed.FileSystem.FileSystemItem)"> <summary> Initializes a new instance of the exception with the specified FileSystemItem object. </summary><param name="item">The FileSystemItem object that caused the current exception.</param> </member> <member name="M:Xceed.FileSystem.FileSystemInternalException.#ctor(System.String)"> <summary> Initializes a new instance of the exception with the specified message text. </summary><param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:Xceed.FileSystem.FileSystemInternalException.#ctor(System.String,Xceed.FileSystem.FileSystemItem)"> <summary> Initializes a new instance of the exception with the specified message text and FileSystemItem object. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param> </member> <member name="M:Xceed.FileSystem.FileSystemInternalException.#ctor(System.Exception)"> <summary> Initializes a new instance of the exception with the specified inner exception. </summary><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="M:Xceed.FileSystem.FileSystemInternalException.#ctor(Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified FileSystemItem object and inner exception. </summary><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="M:Xceed.FileSystem.FileSystemInternalException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the exception with the specified message text and inner exception. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="M:Xceed.FileSystem.FileSystemInternalException.#ctor(System.String,Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified message text, FileSystemItem object and inner exception. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="T:Xceed.FileSystem.FileSystemIOException"> <summary> Exception that is thrown when an IO error occurs while reading from or writing to an <see cref="T:Xceed.FileSystem.AbstractFile"/> object. </summary> <remarks> A <see cref="T:System.IO.IOException"/> will almost always be available in the <see cref="P:System.Exception.InnerException"/> property of this exception. This is the IO exception that caused the <see langword="FileSystemIOException"/> to be thrown. </remarks> </member> <member name="M:Xceed.FileSystem.FileSystemIOException.#ctor(Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified FileSystemItem object and inner exception. </summary><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="M:Xceed.FileSystem.FileSystemIOException.#ctor(System.String,Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified message text, FileSystemItem object and inner exception. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="T:Xceed.FileSystem.FileSystemNotSupportedException"> <summary> Exception that is thrown when calling a method or accessing a property that is not supported by a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object. </summary> </member> <member name="M:Xceed.FileSystem.FileSystemNotSupportedException.#ctor(Xceed.FileSystem.FileSystemItem)"> <summary> Initializes a new instance of the exception with the specified FileSystemItem object. </summary><param name="item">The FileSystemItem object that caused the current exception.</param> </member> <member name="M:Xceed.FileSystem.FileSystemNotSupportedException.#ctor(System.String,Xceed.FileSystem.FileSystemItem)"> <summary> Initializes a new instance of the exception with the specified message text and FileSystemItem object. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param> </member> <member name="M:Xceed.FileSystem.FileSystemNotSupportedException.#ctor(Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified FileSystemItem object and inner exception. </summary><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="M:Xceed.FileSystem.FileSystemNotSupportedException.#ctor(System.String,Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified message text, FileSystemItem object and inner exception. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="T:Xceed.FileSystem.ItemAlreadyExistsException"> <summary> Exception that is thrown when performing an operation on a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that already exists. </summary> </member> <member name="M:Xceed.FileSystem.ItemAlreadyExistsException.#ctor(Xceed.FileSystem.FileSystemItem)"> <summary> Initializes a new instance of the exception with the specified FileSystemItem object. </summary><param name="item">The FileSystemItem object that caused the current exception.</param> </member> <member name="M:Xceed.FileSystem.ItemAlreadyExistsException.#ctor(System.String,Xceed.FileSystem.FileSystemItem)"> <summary> Initializes a new instance of the exception with the specified message text and FileSystemItem object. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param> </member> <member name="M:Xceed.FileSystem.ItemAlreadyExistsException.#ctor(Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified FileSystemItem object and inner exception. </summary><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="M:Xceed.FileSystem.ItemAlreadyExistsException.#ctor(System.String,Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified message text, FileSystemItem object and inner exception. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="T:Xceed.FileSystem.ItemDoesNotExistException"> <summary> Exception that is thrown when performing an operation on a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that does not yet exist. </summary> </member> <member name="M:Xceed.FileSystem.ItemDoesNotExistException.#ctor(Xceed.FileSystem.FileSystemItem)"> <summary> Initializes a new instance of the exception with the specified FileSystemItem object. </summary><param name="item">The FileSystemItem object that caused the current exception.</param> </member> <member name="M:Xceed.FileSystem.ItemDoesNotExistException.#ctor(System.String,Xceed.FileSystem.FileSystemItem)"> <summary> Initializes a new instance of the exception with the specified message text and FileSystemItem object. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param> </member> <member name="M:Xceed.FileSystem.ItemDoesNotExistException.#ctor(Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified FileSystemItem object and inner exception. </summary><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="M:Xceed.FileSystem.ItemDoesNotExistException.#ctor(System.String,Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified message text, FileSystemItem object and inner exception. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="T:Xceed.FileSystem.ItemIsReadOnlyException"> <summary> Exception that is thrown when performing an operation on a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that is read only. </summary> </member> <member name="M:Xceed.FileSystem.ItemIsReadOnlyException.#ctor(Xceed.FileSystem.FileSystemItem)"> <summary> Initializes a new instance of the exception with the specified FileSystemItem object. </summary><param name="item">The FileSystemItem object that caused the current exception.</param> </member> <member name="M:Xceed.FileSystem.ItemIsReadOnlyException.#ctor(System.String,Xceed.FileSystem.FileSystemItem)"> <summary> Initializes a new instance of the exception with the specified message text and FileSystemItem object. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param> </member> <member name="M:Xceed.FileSystem.ItemIsReadOnlyException.#ctor(Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified FileSystemItem object and inner exception. </summary><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="M:Xceed.FileSystem.ItemIsReadOnlyException.#ctor(System.String,Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified message text, FileSystemItem object and inner exception. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="T:Xceed.FileSystem.ItemIsRootFolderException"> <summary> Exception that is thrown when performing an illegal operation on a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that is a root folder. </summary> </member> <member name="M:Xceed.FileSystem.ItemIsRootFolderException.#ctor(Xceed.FileSystem.FileSystemItem)"> <summary> Initializes a new instance of the exception with the specified FileSystemItem object. </summary><param name="item">The FileSystemItem object that caused the current exception.</param> </member> <member name="M:Xceed.FileSystem.ItemIsRootFolderException.#ctor(System.String,Xceed.FileSystem.FileSystemItem)"> <summary> Initializes a new instance of the exception with the specified message text and FileSystemItem object. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param> </member> <member name="M:Xceed.FileSystem.ItemIsRootFolderException.#ctor(Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified FileSystemItem object and inner exception. </summary><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="M:Xceed.FileSystem.ItemIsRootFolderException.#ctor(System.String,Xceed.FileSystem.FileSystemItem,System.Exception)"> <summary> Initializes a new instance of the exception with the specified message text, FileSystemItem object and inner exception. </summary><param name="message">The error message that explains the reason for the exception.</param><param name="item">The FileSystemItem object that caused the current exception.</param><param name="inner">The exception that initially caused the current exception to be thrown.</param> </member> <member name="T:Xceed.FileSystem.AndFilter"> <summary> Performs a logical AND operation on a set of <see cref="T:Xceed.FileSystem.Filter"/> objects. </summary> </member> <member name="T:Xceed.FileSystem.Filter"> <summary> The <see langword="Filter"/> class allows to filter a list of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects. </summary> </member> <member name="M:Xceed.FileSystem.Filter.GetFiltersFromParams(System.Object[])"> <summary> Converts a generic array of parameters to an array of <see cref="T:Xceed.FileSystem.Filter"/> objects. </summary> <param name="filters">An array of objects that must be converted to an array of <see cref="T:Xceed.FileSystem.Filter"/> objects.</param> <returns>An array of <see cref="T:Xceed.FileSystem.Filter"/> objects.</returns> <remarks><para> <para> To filter a list of files or folders, you can pass a variable number of objects in the <paramref name="filters"/> parameter. These objects may be of the following types: </para><para> <list type="table"> <listheader> <term>Object type</term> <description>Type of filter applied</description> </listheader> <item> <term><see cref="T:System.String"/></term> <description> The string is assumed to be a file mask, and a <see cref="T:Xceed.FileSystem.NameFilter"/> object is automatically created for the passed string, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:System.IO.FileAttributes"/></term> <description> A <see cref="T:Xceed.FileSystem.AttributeFilter"/> object is automatically created for the provided attributes, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:Xceed.FileSystem.Filter"/></term> <description> The provided <see cref="T:Xceed.FileSystem.Filter"/> object is used as-is. </description> </item> <item> <term>Array of <see cref="T:System.Object"/></term> <description> Each object in the array may be of the types described in this table, and is used accordingly. </description> </item> <item> <term>Other</term> <description> If any other type is found, an exception is thrown. </description> </item> </list> </para> </para></remarks> </member> <member name="M:Xceed.FileSystem.Filter.IsItemMatchingOne(Xceed.FileSystem.FileSystemItem,Xceed.FileSystem.Filter[])"> <summary> Verifies if the <see cref="T:Xceed.FileSystem.FileSystemItem"/> object matches at least one of the provided filters. </summary> <param name="item">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that will be verified.</param> <param name="filters">The array of <see cref="T:Xceed.FileSystem.Filter"/> objects against which <paramref name="item"/> will be verified.</param> <returns><see langword="true"/> if <paramref name="item"/> matches one of the provided filters; <see langword="false"/> otherwise.</returns> </member> <member name="M:Xceed.FileSystem.Filter.IsItemMatchingAll(Xceed.FileSystem.FileSystemItem,Xceed.FileSystem.Filter[])"> <summary> Verifies if the <see cref="T:Xceed.FileSystem.FileSystemItem"/> object matches <b>all</b> of the provided filters. </summary> <param name="item">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that will be verified.</param> <param name="filters">The array of <see cref="T:Xceed.FileSystem.Filter"/> objects against which <paramref name="item"/> will be verified.</param> <returns><see langword="true"/> if <paramref name="item"/> matches <b>all</b> of the provided filters; <see langword="false"/> otherwise.</returns> </member> <member name="M:Xceed.FileSystem.Filter.IsItemMatching(Xceed.FileSystem.FileSystemItem)"> <summary> Gets a boolean value indicating if the item matches one or more of the filters. </summary> <param name="item">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that will being verified.</param> <returns><see langword="true"/> if <paramref name="item"/> matches one or more of the filters; <see langword="false"/> otherwise.</returns> </member> <member name="M:Xceed.FileSystem.Filter.#ctor"> <summary> Default constructor </summary> </member> <member name="M:Xceed.FileSystem.Filter.#ctor(Xceed.FileSystem.FilterScope)"> <summary> </summary> <param name="scope"></param> </member> <member name="M:Xceed.FileSystem.Filter.IsItemInScope(Xceed.FileSystem.FileSystemItem)"> <summary> </summary> <param name="item"></param> <returns></returns> </member> <member name="F:Xceed.FileSystem.Filter.m_licenser"> <summary> The licenser that can be used to verify properties of the license. </summary> </member> <member name="P:Xceed.FileSystem.Filter.Scope"> <summary> Gets or sets the scope of the filter. </summary> <value>A combination of <see cref="T:Xceed.FileSystem.FilterScope"/> values that identify the type of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects that are handled by this filter.</value> </member> <member name="M:Xceed.FileSystem.AndFilter.IsItemMatching(Xceed.FileSystem.FileSystemItem)"> <summary> Gets a boolean value indicating if the item matches <b>all</b> of the filters. </summary> <param name="item">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that will be verified.</param> <returns><see langword="true"/> if <paramref name="item"/> matches <b>all</b> of the filters; <see langword="false"/> otherwise.</returns> </member> <member name="M:Xceed.FileSystem.AndFilter.#ctor(System.Object[])"> <summary> Initializes a new instance of the <see langword="AndFilter"/> class. </summary> <param name="filters">Filters that are part of the logical AND operation.</param> </member> <member name="P:Xceed.FileSystem.AndFilter.Filters"> <summary> Gets an array of <see cref="T:Xceed.FileSystem.Filter"/> objects that are part of the logical AND operation. </summary> <value>An array of <see cref="T:Xceed.FileSystem.Filter"/> objects.</value> </member> <member name="T:Xceed.FileSystem.AttributeFilter"> <summary> Filters a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object based on its attributes. </summary> </member> <member name="M:Xceed.FileSystem.AttributeFilter.IsItemMatching(Xceed.FileSystem.FileSystemItem)"> <summary> Gets a boolean value indicating if the item matches <b>at least one</b> of the file attributes. </summary> <param name="item">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that will be verified.</param> <returns><see langword="true"/> if <paramref name="item"/> matches <b>at least one</b> of the file attributes; <see langword="false"/> otherwise.</returns> </member> <member name="M:Xceed.FileSystem.AttributeFilter.#ctor(System.IO.FileAttributes)"> <summary> Initializes a new instance of the <see langword="AttributeFilter"/> class. </summary> <param name="attributes"><see cref="T:System.IO.FileAttributes"/> fields that represent the attributes used to filter files and folders.</param> </member> <member name="M:Xceed.FileSystem.AttributeFilter.#ctor(System.IO.FileAttributes,Xceed.FileSystem.FilterScope)"> <summary> Initializes a new instance of the <see langword="AttributeFilter"/> class. </summary> <param name="attributes"><see cref="T:System.IO.FileAttributes"/> fields that represent the attributes used to filter files and folders.</param> <param name="scope">Determines whether the filter applies to files, folders or both.</param> </member> <member name="P:Xceed.FileSystem.AttributeFilter.Attributes"> <summary> Gets the file attributes used to filter files and folders. </summary> <value>A combination of <see cref="T:System.IO.FileAttributes"/> fields that represent the attributes used to filter files and folders.</value> </member> <member name="T:Xceed.FileSystem.DateTimeFilter"> <summary> Filters a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object based on its date and time. </summary> </member> <member name="M:Xceed.FileSystem.DateTimeFilter.IsItemMatching(Xceed.FileSystem.FileSystemItem)"> <summary> Gets a boolean value indicating if the item matches the date/time filter. </summary> <param name="item">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that will be verified.</param> <returns><see langword="true"/> if <paramref name="item"/> matches the date/time filter; <see langword="false"/> otherwise.</returns> </member> <member name="M:Xceed.FileSystem.DateTimeFilter.#ctor(System.DateTime,System.DateTime)"> <summary> Initializes a new instance of the <see langword="DateTimeFilter"/> class. </summary> <param name="minValue">A <see cref="T:System.DateTime"/> field that represents the minimum date and time of the filter.</param> <param name="maxValue">A <see cref="T:System.DateTime"/> field that represents the maximum date and time of the filter.</param> <remarks><para>The filter will apply only to files.</para></remarks> </member> <member name="M:Xceed.FileSystem.DateTimeFilter.#ctor(System.DateTime,System.DateTime,Xceed.FileSystem.DateTimeFilter.ApplicableDateTime)"> <summary> Initializes a new instance of the <see langword="DateTimeFilter"/> class, specifying to which type of date/time the filter applies. </summary> <param name="minValue">A <see cref="T:System.DateTime"/> field that represents the minimum date and time of the filter.</param> <param name="maxValue">A <see cref="T:System.DateTime"/> field that represents the maximum date and time of the filter.</param> <param name="applicableDateTimes">Determines to which type of date/time the filter applies.</param> <remarks><para>The filter will apply only to files.</para></remarks> </member> <member name="M:Xceed.FileSystem.DateTimeFilter.#ctor(System.DateTime,System.DateTime,Xceed.FileSystem.FilterScope)"> <summary> Initializes a new instance of the <see langword="DateTimeFilter"/> class, specifying to which type of <see cref="T:Xceed.FileSystem.FileSystemItem"/> object the filter applies. </summary> <param name="minValue">A <see cref="T:System.DateTime"/> field that represents the minimum date and time of the filter.</param> <param name="maxValue">A <see cref="T:System.DateTime"/> field that represents the maximum date and time of the filter.</param> <param name="scope">Determines whether the filter applies to files, folders or both.</param> </member> <member name="M:Xceed.FileSystem.DateTimeFilter.#ctor(System.DateTime,System.DateTime,Xceed.FileSystem.DateTimeFilter.ApplicableDateTime,Xceed.FileSystem.FilterScope)"> <summary> Initializes a new instance of the <see langword="DateTimeFilter"/> class, specifying to which type of date/time and <see cref="T:Xceed.FileSystem.FileSystemItem"/> object the filter applies. </summary> <param name="minValue">A <see cref="T:System.DateTime"/> field that represents the minimum date and time of the filter.</param> <param name="maxValue">A <see cref="T:System.DateTime"/> field that represents the maximum date and time of the filter.</param> <param name="applicableDateTimes">Determines to which type of date/time the filter applies.</param> <param name="scope">Determines whether the filter applies to files, folders or both.</param> </member> <member name="P:Xceed.FileSystem.DateTimeFilter.MinDateTime"> <summary> Gets the minimum date and time value of the filter. </summary> <value>A <see cref="T:System.DateTime"/> that represents the minimum date and time of the filter.</value> </member> <member name="P:Xceed.FileSystem.DateTimeFilter.MaxDateTime"> <summary> Gets the maximum date and time value of the filter. </summary> <value>A <see cref="T:System.DateTime"/> that represents the maximum date and time of the filter.</value> </member> <member name="P:Xceed.FileSystem.DateTimeFilter.ApplicableDateTimes"> <summary> Gets the dates and times used to filter files and folders. </summary> <value>A combination of <see cref="T:System.DateTime"/> fields that represent the dates and times used to filter files and folders.</value> </member> <member name="T:Xceed.FileSystem.DateTimeFilter.ApplicableDateTime"> <summary> Specifies which type of date/time will be filtered by a <see cref="T:Xceed.FileSystem.DateTimeFilter"/> class. </summary> </member> <member name="F:Xceed.FileSystem.DateTimeFilter.ApplicableDateTime.Creation"> <summary>The filter will apply only to the creation date/time.</summary> </member> <member name="F:Xceed.FileSystem.DateTimeFilter.ApplicableDateTime.LastWrite"> <summary>The filter will apply only to the last modified date/time.</summary> </member> <member name="F:Xceed.FileSystem.DateTimeFilter.ApplicableDateTime.LastAccess"> <summary>The filter will apply only to the last accessed date/time.</summary> </member> <member name="F:Xceed.FileSystem.DateTimeFilter.ApplicableDateTime.All"> <summary>The filter will apply to all date/times.</summary> </member> <member name="T:Xceed.FileSystem.NameFilter"> <summary> Filters a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object based on its name. </summary> </member> <member name="M:Xceed.FileSystem.NameFilter.IsItemMatching(Xceed.FileSystem.FileSystemItem)"> <summary> Gets a boolean value indicating if the item matches <b>at least one</b> of the name filters. </summary> <param name="item">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that will be verified.</param> <returns><see langword="true"/> if <paramref name="item"/> matches <b>at least one</b> of the name filters; <see langword="false"/> otherwise.</returns> </member> <member name="M:Xceed.FileSystem.NameFilter.#ctor(System.String)"> <summary> Initializes a new instance of the <see langword="NameFilter"/> class. </summary> <param name="mask">Mask to use to filter file names (e.g. "*.txt", "a??.txt", etc.)</param> <remarks><para> By default, the mask is not case sensitive. To make it case sensitive, just prepend '>' to the <paramref name="mask"/> parameter. </para></remarks> </member> <member name="M:Xceed.FileSystem.NameFilter.#ctor(System.String,Xceed.FileSystem.FilterScope)"> <summary> Initializes a new instance of the <see langword="NameFilter"/> class. </summary> <param name="mask">Mask to use to filter file names (e.g. "*.txt", "a??.txt", etc.)</param> <param name="scope">Determines whether the scope applies to files, folders or both.</param> <remarks><para> By default, the mask is not case sensitive. To make it case sensitive, just prepend '>' to the <paramref name="mask"/> parameter. </para></remarks> </member> <member name="P:Xceed.FileSystem.NameFilter.Masks"> <summary> Gets an array of string masks that are used to filter the files and folders. </summary> <value>An array of string masks.</value> </member> <member name="P:Xceed.FileSystem.NameFilter.CaseSensitive"> <summary> Gets a value indicating whether the file or folder name matching is case-sensitive. </summary> <value><see langword="true"/> if the file or folder name is case-sesitive; <see langword="false"/> otherwise.</value> </member> <member name="T:Xceed.FileSystem.NotFilter"> <summary> Performs a logical NOT operation on a <see cref="P:Xceed.FileSystem.NotFilter.Filter"/> object. </summary> </member> <member name="M:Xceed.FileSystem.NotFilter.IsItemMatching(Xceed.FileSystem.FileSystemItem)"> <summary> Gets a boolean value indicating if the item does <b>not</b> match the filter. </summary> <param name="item">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that will be verified.</param> <returns><see langword="true"/> if <paramref name="item"/> does <b>not</b> match the filter; <see langword="false"/> otherwise.</returns> </member> <member name="M:Xceed.FileSystem.NotFilter.#ctor(System.Object)"> <summary> Initializes a new instance of the <see langword="NotFilter"/> class. </summary> <param name="filter">Filter who's result must be inverted.</param> </member> <member name="M:Xceed.FileSystem.NotFilter.#ctor(Xceed.FileSystem.Filter)"> <summary> Initializes a new instance of the <see langword="NotFilter"/> class. </summary> <param name="filter">Filter who's result must be inverted.</param> </member> <member name="F:Xceed.FileSystem.NotFilter.m_filter"> <summary> The original filter used to build this <see cref="T:Xceed.FileSystem.NotFilter"/> object. </summary> </member> <member name="P:Xceed.FileSystem.NotFilter.Filter"> <summary> Gets the <see cref="P:Xceed.FileSystem.NotFilter.Filter"/> object that is used for the logical NOT operation. </summary> <value>A reference to a <see cref="P:Xceed.FileSystem.NotFilter.Filter"/> object.</value> </member> <member name="T:Xceed.FileSystem.OrFilter"> <summary> Performs a logical OR operation on a set of <see cref="T:Xceed.FileSystem.Filter"/> objects. </summary> </member> <member name="M:Xceed.FileSystem.OrFilter.IsItemMatching(Xceed.FileSystem.FileSystemItem)"> <summary> Gets a boolean value indicating if the item matches <b>at least one</b> of the filters. </summary> <param name="item">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that will be verified.</param> <returns><see langword="true"/> if <paramref name="item"/> matches <b>at least one</b> of the filters; <see langword="false"/> otherwise.</returns> </member> <member name="M:Xceed.FileSystem.OrFilter.#ctor(System.Object[])"> <summary> Initializes a new instance of the <see langword="OrFilter"/> class. </summary> <param name="filters">Filters that are part of the logical OR operation.</param> </member> <member name="P:Xceed.FileSystem.OrFilter.Filters"> <summary> Gets an array of <see cref="T:Xceed.FileSystem.Filter"/> objects that are part of the logical OR operation. </summary> <value>A reference to a <see cref="T:Xceed.FileSystem.Filter"/> object.</value> </member> <member name="T:Xceed.FileSystem.SizeFilter"> <summary> Filters a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object based on its size. </summary> </member> <member name="M:Xceed.FileSystem.SizeFilter.IsItemMatching(Xceed.FileSystem.FileSystemItem)"> <summary> Gets a boolean value indicating if the item matches the size filter. </summary> <param name="item">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that will be verified.</param> <returns><see langword="true"/> if <paramref name="item"/> matches the size filter; <see langword="false"/> otherwise.</returns> </member> <member name="M:Xceed.FileSystem.SizeFilter.#ctor(System.Int64,System.Int64)"> <summary> Initializes a new instance of the <see langword="SizeFilter"/> class. </summary> <param name="minSize">A value that represents the minimum size of the filter.</param> <param name="maxSize">A value that represents the maximum size of the filter.</param> </member> <member name="P:Xceed.FileSystem.SizeFilter.MinSize"> <summary> Gets the minimum size value of the filter. </summary> <value>The minimum size value, in bytes, of the filter.</value> </member> <member name="P:Xceed.FileSystem.SizeFilter.MaxSize"> <summary> Gets the maximum size value of the filter. </summary> <value>The maximum size value, in bytes, of the filter.</value> </member> <member name="T:Xceed.Utils.Exceptions.ExceptionFilter"> <summary> Exposes utility methods for filtering exceptions. </summary> </member> <member name="M:Xceed.Utils.Exceptions.ExceptionFilter.IsPublicException(System.Exception)"> <summary> Determines if an exception can be thrown by a public method. </summary> <param name="exception">The exception to evaluate.</param> <returns>true if the exception can be thrown as-is; false if the exception should be converted.</returns> <remarks> Every public method should have a final exception handler for any un-caught exceptions that should call this method to determine if the exception can be thrown as-is to the caller (i.e. if the exception makes sense to the caller), or if it should be wrapped in a more meaningful exception for the caller. </remarks> <example> The following example illustrate how to implement this: <code> public void MyMethod() { try { DoSomething(); DoSomethingElse(); } catch( SomeSpecificException e ) { HandleTheException(); } catch( Exception e ) { if( <B>ExceptionFilter.IsPublicException( e )</B> ) throw; // Simply pass the exception as-is to the caller throw new MyUnexpectedException( "Something unexpected happened.", e ); } } </code> </example> </member> <member name="T:Xceed.Utils.Files.FileMatching"> <summary> Summary description for FileMatching. </summary> </member> <member name="M:Xceed.Utils.Files.FileMatching.MatchName(System.String,System.String,System.Boolean)"> <summary> Checks if a wildcard with no path matches a name with no path. </summary> <param name="fileName">File name to match.</param> <param name="wildcards">Wildcard to match.</param> <param name="caseSensitive">Indicates if the comparison should be case-sensitive.</param> <returns>true if the wildcard matches the name; false otherwise.</returns> </member> <member name="T:Xceed.Utils.Licensing.LicenseErrorCode"> <summary> The different errors a XceedLicenseManagerException can receive in one of the constructor. </summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseErrorCode.InvalidProductCode"> <summary> The product code is not valid. The product code must be a value defined in the LicenseProduct enumeration. </summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseErrorCode.InvalidOriginCode"> <summary> The origin code is not valid. The origin code must be a value defined in the LicenseOrigin enumeration. </summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseErrorCode.InvalidVersion"> <summary> The version number is not valid. A version number (major or minor) must be between 0 and 9 inclusive. </summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseErrorCode.BufferTooSmall"> <summary> The length of the output buffer is too small. </summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseErrorCode.UnsupportedKey"> <summary> The license key version is not supported by this version of the XceedLicenseManager. </summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseErrorCode.InvalidKeyLength"> <summary>The length of the license key is not valid.</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseErrorCode.ChecksumFailed"> <summary>The checksum verification of the license key failed.</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseErrorCode.ProductMismatch"> <summary> The 3-letter product ID does not match the encoded product code. </summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseErrorCode.VersionMismatch"> <summary> The readable version number does not match the encoded version number. </summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseErrorCode.WriteRegistry"> <summary> Unable to write the license key to the local registry. </summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseErrorCode.ReadRegistry"> <summary> Requested license key has not been found in the local registry. </summary> </member> <member name="T:Xceed.Utils.Licensing.LicenseOrigin"> <summary> The enum ELicenseOrigin contains numeric ids for applications that can generate license keys. </summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.TrialVersion"> <summary>Trial version</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.TrialRenew1"> <summary>Trial version renewal (1st time)</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.TrialRenew2"> <summary>Trial version renewal (2nd time)</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.TrialRenew3"> <summary>Trial version renewal (3rd time)</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.TrialRenew4"> <summary>Trial version renewal (4th time)</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.TrialRenew5"> <summary>Trial version renewal (5th time)</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.TrialRenew6"> <summary>Trial version renewal (6th time)</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.TrialRenew7"> <summary>Trial version renewal (7th time)</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.TrialRenew8"> <summary>Trial version renewal (8th time)</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.TrialRenew9"> <summary>Trial version renewal (9th time)</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.FirstTrialValue"> <summary>The first valid trial value</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.LastTrialValue"> <summary>The last valid trial value</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.CommanderReseller"> <summary>Commander - For a reseller</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.CommanderDirect"> <summary>Commander - Direct sale</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.WebSite"> <summary>Web Site</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.LockSmith"> <summary>LockSmith Utility</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.Columbo"> <summary>Columbo</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.FirstOrigin"> <summary>The first valid origin value</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.LastOrigin"> <summary>The last valid origin value</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseOrigin.InvalidOrigin"> <summary>The invalid origin value</summary> </member> <member name="T:Xceed.Utils.Licensing.LicenseProduct"> <summary> Contains numeric ids for each product sold by Xceed Software Inc. </summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseProduct.XceedZip"> <summary>Xceed Zip Compression Library</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseProduct.XceedZipSfx"> <summary>Xceed Zip Compression Library with SFX</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseProduct.XceedBackup"> <summary>Xceed Backup Library</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseProduct.XceedWinsock"> <summary>Xceed Winsock Library</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseProduct.XceedFtp"> <summary>Xceed FTP Library</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseProduct.XceedCompress"> <summary>Xceed Data Compression Library</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseProduct.XceedEncode"> <summary>Xceed Binary Encoding Library</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseProduct.XceedEncrypt"> <summary>Xceed Encryption Library</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseProduct.XceedFtpBiz"> <summary>Xceed FTP Library For BizTalk Server</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseProduct.XceedZipNET"> <summary>Xceed Zip for .NET</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseProduct.FirstProduct"> <summary>The first valid product value</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseProduct.LastProduct"> <summary>The last valid product value</summary> </member> <member name="F:Xceed.Utils.Licensing.LicenseProduct.InvalidProduct"> <summary>The invalid product value</summary> </member> <member name="T:Xceed.Utils.Licensing.XceedLicense"> <summary> License object created from a License key. </summary> <remarks> The product's "Licenser" will expose an instance of this class. </remarks> </member> <member name="M:Xceed.Utils.Licensing.XceedLicense.#ctor(System.String)"> <summary> Construct a new license using the license key. </summary> <param name="licenseKey">The license key associated with the class/control.</param> </member> <member name="P:Xceed.Utils.Licensing.XceedLicense.LicenseKey"> <summary> The Xceed license key (AAANN-XXXXX-XXXXX-XXXX) </summary> </member> <member name="P:Xceed.Utils.Licensing.XceedLicense.IsTrial"> <summary> Is this license a trial version? </summary> </member> <member name="P:Xceed.Utils.Licensing.XceedLicense.VersionMajor"> <summary> The major version contained in the license. </summary> </member> <member name="P:Xceed.Utils.Licensing.XceedLicense.VersionMinor"> <summary> The minor version contained in the license. </summary> </member> <member name="P:Xceed.Utils.Licensing.XceedLicense.NbLicenses"> <summary> The number of licenses contained in the license key. </summary> <remarks> Will return 255 for a site license </remarks> </member> <member name="P:Xceed.Utils.Licensing.XceedLicense.IsSiteLicense"> <summary> Is this license valid for a site? </summary> </member> <member name="T:Xceed.Utils.Licensing.XceedLicenseManager"> <summary> Provides everything needed to manage license keys for .NET Components. Those license keys adhere to the new requirements of the new packaging (Windows Installer, ESD, etc.) for all Xceed Software Components. </summary> <remarks> Currently only the AnalyzeLicense method is implemented - The textual representation of the license key is: PPPAB-XXXXX-XXXXX-XXXV . PPP is a 3-letter Product Identifier (ZIP, BKP, WSL, FTP, etc.) . AB is the version number Major.Minor (A.B) . XXXXX-XXXXX-XXX is a sequence of 13 alpha-numeric characters representing encoded information about this license key. . V is an alpha-numeric character representing the version number of the license key. This will always be the last character of the license key string. - The dashes '-' are NOT part of the physical license key. They are only used for readability when the license key is displayed to a user. - Every alpha-numeric character (X) represents a sequence of 5 bits in a lookup table. So, the 13 Xs represent a total of 65 bits with the following mapping: 0 - 1 - 2 - 3 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 c s d p v s n d o c s o d n s v p d c s n o d s o v d c s p n d s o v s c d n s 4 - 5 - 6 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 n p d v s c n d s o v d s p c d s n v d s p d c s . d are 14 bits => number of days elapsed since January 1st 2001 . s are 16 bits <= unique seed for this license key . p are 6 bits => product code for which this license key applies . v are 7 bits => version number of the product for which this key applies . n are 8 bits => number of licenses allowed . o are 6 bits => origin code of the application that generated this key . c are 8 bits => checksum of the entire license key. - The bits with '=>' read from left-to-right, and the bits with '<=' read from right-to-left. - The date represented by 'd' corresponds to the date when the key was generated, if this is a non-trial key. - The date represented by 'd' corresponds to the expiration date of the key, if this is a trial key. - For a non-trial key, the unique seed represented by 's' corresponds to a number that is provided by the application that generated this license key, which must be unique for the date represented by 'd' and the application represented by 'o'. - For a trial key, the unique seed represented by 's' corresponds to a machine-specific ID from the machine on which the trial product has been installed. - The product code represented by 'p' corresponds to the product for which this license key is valid. - The version represented by 'v' corresponds to the version number of the product 'p' for which this license key is valid. It contains a Major.Minor version number, represented as v/10.v%10 (e.g. 42 means 4.2). - The number of licenses represented by 'n' corresponds to a site license when it's value is 0xFF (255). - The origin code represented by 'o' corresponds to the application that generated this license key, if this is a non-trial key. In this case, the code must be a value between 10 and 63 inclusive. - The origin code represents the number of times the license key has been renewed, if this is a trial key. In this case, the code must be a value between 0 and 9 inclusive. - The checksum represented by 'c' corresponds to an 8-bit checksum of the other bits, including the 'PPPAB' portion of the license key. - To be considered valid, the checksum must resolve correctly, AND the product/version identified by 'p' and 'v' must match the product/version identified by 'PPPAB'. </remarks> </member> <member name="F:Xceed.Utils.Licensing.XceedLicenseManager.RawKeyStringLen"> <summary>The license key length excluding dashes '-'</summary> </member> <member name="F:Xceed.Utils.Licensing.XceedLicenseManager.LicKeyVersion"> <summary>License key version number ('V')</summary> </member> <member name="F:Xceed.Utils.Licensing.XceedLicenseManager.BitCount"> <summary>Number of bits required for the encoded part</summary> </member> <member name="F:Xceed.Utils.Licensing.XceedLicenseManager.NbLookupChar"> <summary>2 ^ BITSPERCHAR</summary> </member> <member name="F:Xceed.Utils.Licensing.XceedLicenseManager.AdlerNMax"> <summary>NMAX is the largest n such that 255n(n+1)/2 + (n+1)(BASE-1) <= 2^32-1</summary> </member> <member name="F:Xceed.Utils.Licensing.XceedLicenseManager.AdlerBase"> <summary>largest prime smaller than 65536</summary> </member> <member name="F:Xceed.Utils.Licensing.XceedLicenseManager.AlphaNumLookup"> <summary> Represents the lookup table for alpha-numeric characters represented by 'X' in the license key. Each character corresponds to a 5-bit value (00..31) in the binary key. The value of the character corresponds to its position in the string m_AlphaNumLookup. </summary> </member> <member name="F:Xceed.Utils.Licensing.XceedLicenseManager.ProductIds"> <summary> Contains string literals for the PPP portion of the license key. </summary> </member> <member name="T:Xceed.Utils.Licensing.XceedLicenseManagerException"> <summary> Exception that is thrown when there is a problem creating or analyzing the license key. </summary> </member> <member name="M:Xceed.Utils.Licensing.XceedLicenseManagerException.#ctor(Xceed.Utils.Licensing.LicenseErrorCode)"> <summary> Initializes a new instance of the exception with the specified error code. <param name="errorCode">The error code that explains the reason for the exception.</param> </summary> </member> <member name="T:Xceed.Utils.Licensing.XceedLicenseProvider"> <summary> This license provider extracts the license key from the registry and saves it in the LicenseContext. No validation are performed at design-time/compilation time. At run-time, the license key is "restored" and validated. </summary> <remarks> This is an abstract class. The implementor must override: ProductCodeName : the string "ZIN" in ZIN10-HRGSJ-17UWN-K4XA AllowedVersions : a string array containing all the versions of the product supported by this version. These "version strings" are the registry key names that will be used to query the license key from the registry (under the ZIN key for instance). The derived class should be used by a "Licenser" that uses the derived LicenseProvider and creates a License using LicenserManager.Validate. Each public classes of the library should have a private member of type "Licenser". This member can be static but must be created in the public constructors if we wan't to avoid a "Static initialization failed" exception. </remarks> <example> internal class CompressionLicenseProvider : XceedLicenseProvider { public override string ProductCodeName { get { return "ZIN"; } } public override string[] AllowedVersion { get { return new string[] { "1.1", "1.0" }; } } } </example> </member> <member name="M:Xceed.Utils.Licensing.XceedLicenseProvider.GetLicense(System.ComponentModel.LicenseContext,System.Type,System.Object,System.Boolean)"> <summary> Returns a valid license. In design-time, it will check in the registry and always return a valid license. In run-time, it will check in the application file and validate the extracted license key. </summary> <param name="context"></param> <param name="type"></param> <param name="instance"></param> <param name="allowExceptions"></param> <returns>A valid license or null otherwise</returns> </member> <member name="P:Xceed.Utils.Licensing.XceedLicenseProvider.ProductId"> <summary> The code name of the product </summary> </member> <member name="P:Xceed.Utils.Licensing.XceedLicenseProvider.AllowedVersions"> <summary> All the version number supported by this version of the product. </summary> <remarks> The versions should be in descending order beginning with the current version. </remarks> </member> <member name="T:Xceed.Utils.Strings.StringCheck"> <summary> Summary description for StringCheck. </summary> </member> <member name="T:Xceed.FileSystem.AbstractFile"> <summary> Represents a generic file and exposes properties and methods that allow file-oriented operations to be performed. </summary> </member> <member name="T:Xceed.FileSystem.FileSystemItem"> <summary> Root class for all types of items that can exist in a generic (abstract) folder. For example, a file and a folder. </summary> </member> <member name="M:Xceed.FileSystem.FileSystemItem.#ctor"> <summary> Initializes a new instance of the <see cref="T:Xceed.FileSystem.FileSystemItem"/> class. </summary> </member> <member name="M:Xceed.FileSystem.FileSystemItem.Refresh"> <overloads><summary>Re-reads the information from the physical item.</summary></overloads> <summary> Re-reads the information from the physical item. </summary><remarks><para> When a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object's properties, such as <see cref="P:Xceed.FileSystem.FileSystemItem.Attributes"/> or <see cref="P:Xceed.FileSystem.FileSystemItem.CreationDateTime"/>, are first accessed, a snapshot of the underlying physical item's properties is taken. This snapshot is <b>not</b> automatically updated whenever the physical item's properties change. </para><para> <see langword="Refresh"/> re-reads the information from the physical item and updates the snapshot. </para><para> <b>Note: </b><see langword="Refresh"/> should be called before accessing a property, or the information returned could be outdated. </para></remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The item represented by this <see cref="T:Xceed.FileSystem.FileSystemItem"/> does not physically exist. </exception> </member> <member name="M:Xceed.FileSystem.FileSystemItem.Refresh(Xceed.FileSystem.FileSystemEvents,System.Object)"> <summary> Re-reads the information from the physical item and raises events during the process. </summary> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <remarks><para>When a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object's properties, such as <see cref="P:Xceed.FileSystem.FileSystemItem.Attributes"/> or <see cref="P:Xceed.FileSystem.FileSystemItem.CreationDateTime"/>, are first accessed, a snapshot of the underlying physical item's properties is taken. This snapshot is <b>not</b> automatically updated whenever the physical item's properties change.</para><para> <see langword="Refresh"/> re-reads the information from the physical item and updates the snapshot.</para><para><b>Note: </b><see langword="Refresh"/> should be called before accessing a property, or the information returned could be outdated.</para></remarks> <exception cref="T:Xceed.FileSystem.ItemDoesNotExistException">The item represented by this <see cref="T:Xceed.FileSystem.FileSystemItem"/> does not physically exist.</exception> </member> <member name="M:Xceed.FileSystem.FileSystemItem.Create"> <overloads><summary>Creates the physical item represented by the <see cref="T:Xceed.FileSystem.FileSystemItem"/> object.</summary></overloads> <summary> Creates the physical item represented by this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object. </summary><remarks><para> If this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object represents a file, an empty file is created. If it represents a folder, a folder is created. </para><para> If the physical item already exists, an exception is thrown. </para><para> If the physical folder in which the new item is to be created does not exist, it is created. </para><para> The current property values (such as <see cref="P:Xceed.FileSystem.FileSystemItem.Attributes"/>) are applied to the newly created item. </para></remarks><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> The physical item already exists. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The physical item is a root folder. </exception> </member> <member name="M:Xceed.FileSystem.FileSystemItem.Create(Xceed.FileSystem.FileSystemEvents,System.Object)"> <summary> Creates the physical item represented by this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object and raises events during the process. </summary> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <remarks><para>If this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object represents a file, an empty file is created. If it represents a folder, a folder is created.</para> <para>If the physical item already exists, an exception is thrown.</para><para> If the physical folder in which the new item is to be created does not exist, it is created.</para><para>The current property values (such as <see cref="P:Xceed.FileSystem.FileSystemItem.Attributes"/>) are applied to the newly created item.</para></remarks> <exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException">The physical item already exists.</exception> <exception cref="T:Xceed.FileSystem.ItemIsRootFolderException">The physical item is a root folder.</exception> </member> <member name="M:Xceed.FileSystem.FileSystemItem.ListCreate(Xceed.FileSystem.FileSystemEventsSession)"> <summary> Creates each item in the <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object's list. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> </member> <member name="M:Xceed.FileSystem.FileSystemItem.Delete"> <overloads><summary>Permanently deletes the physical item.</summary></overloads> <summary> Permanently deletes the physical item. </summary><include file="FileSystemItem.xml" path="FileSystemItem/PublicMethods/Delete/Common/Params/*"/><remarks> <para> If this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object represents a file, the file is deleted. If it represents a folder, the folder <b>and all it's content</b> is deleted. </para><para> If the physical item does not exist, an exception is thrown. </para> </remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The item represented by this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object does not physically exist. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The physical item is a root folder. </exception> </member> <member name="M:Xceed.FileSystem.FileSystemItem.Delete(Xceed.FileSystem.FileSystemEvents,System.Object)"> <summary> Permanently deletes the physical item, and raises events during the process. </summary><include file="FileSystemItem.xml" path="FileSystemItem/PublicMethods/Delete/Common/Params/*"/><param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param><param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param><remarks> <para> If this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object represents a file, the file is deleted. If it represents a folder, the folder <b>and all it's content</b> is deleted. </para><para> If the physical item does not exist, an exception is thrown. </para> </remarks><event cref="F:Xceed.FileSystem.FileSystemEvents.ScanningFolder"> A folder is being scanned for items to be deleted. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ItemProgression"> Every time an item is about to be deleted, reports how many items have been deleted and the total number of items that must be deleted. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ItemException"> When an exception occurs while deleting an item, reports the exception and allows to recover from the exception and continue deleting the items. </event><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The item represented by this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object does not physically exist. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The physical item is a root folder. </exception> </member> <member name="M:Xceed.FileSystem.FileSystemItem.ListDelete(Xceed.FileSystem.FileSystemEventsSession)"> <summary> Deletes each item in the <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object's list. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> </member> <member name="M:Xceed.FileSystem.FileSystemItem.CopyTo(Xceed.FileSystem.AbstractFolder,System.Boolean)"> <overloads><summary>Copies the item, or it's content to the destination.</summary></overloads> <summary> Copies the item to another folder. </summary><param name="destinationFolder">An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object into which the item will be copied. Cannot be <see langword="null"/>.</param><param name="replaceExistingFiles"><see langword="true"/> if existing items in the destination should be replaced; <see langword="false"/> otherwise.</param><returns>A <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that represents the newly copied item.</returns><remarks> <para> If the physical folder specified by <paramref name="destinationFolder"/> does not exist, it is created. </para><para> If this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object represents a file, the physical file is immediately copied to the destination folder. </para><para> If it represents a folder, the folder <b>and all it's content</b> (files and subfolders) is immediately copied to the destination. </para><para> When <paramref name="replaceExistingFiles"/> is <see langword="true"/>, any item in the destination that has the same name as an item being copied is automatically replaced. </para><para> When <paramref name="replaceExistingFiles"/> is <see langword="false"/>, an exception is thrown whenever the destination contains an item with the same name as an item being copied. </para> </remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The item represented by this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object does not physically exist. </exception><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> The destination item already exists, and <paramref name="replaceExistingFiles"/> is <see langword="false"/>. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The destination item already exists, <paramref name="replaceExistingFiles"/> is <see langword="true"/>, but the destination item has the <see langword="ReadOnly"/> attribute. </exception><exception cref="T:Xceed.FileSystem.FileSystemIOException"> The source item could not be read from, or the destination item could not be written to. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The item is a root folder. You should consider using <see cref="M:Xceed.FileSystem.AbstractFolder.CopyFilesTo(Xceed.FileSystem.AbstractFolder,System.Boolean,System.Boolean,System.Object[])"/> to copy the content of a root folder. </exception> </member> <member name="M:Xceed.FileSystem.FileSystemItem.CopyTo(Xceed.FileSystem.FileSystemEvents,System.Object,Xceed.FileSystem.AbstractFolder,System.Boolean)"> <summary> Copies the item to another folder, and raises events during the process. </summary><param name="destinationFolder">An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object into which the item will be copied. Cannot be <see langword="null"/>.</param><param name="replaceExistingFiles"><see langword="true"/> if existing items in the destination should be replaced; <see langword="false"/> otherwise.</param><returns>A <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that represents the newly copied item.</returns><param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param><param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param><remarks> <para> If the physical folder specified by <paramref name="destinationFolder"/> does not exist, it is created. </para><para> If this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object represents a file, the physical file is immediately copied to the destination folder. </para><para> If it represents a folder, the folder <b>and all it's content</b> (files and subfolders) is immediately copied to the destination. </para><para> When <paramref name="replaceExistingFiles"/> is <see langword="true"/>, any item in the destination that has the same name as an item being copied is automatically replaced. </para><para> When <paramref name="replaceExistingFiles"/> is <see langword="false"/>, an exception is thrown whenever the destination contains an item with the same name as an item being copied. </para> </remarks><event cref="F:Xceed.FileSystem.FileSystemEvents.ScanningFolder"> A folder is being scanned for items to be copied. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ItemProgression"> Every time an item is about to be copied, reports how many items have been copied and the total number of items that must be copied. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ByteProgression"> Every 32k, reports how many bytes have been and must be copied for the current item, as well as for the entire set of items that are being copied. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ItemException"> When an exception occurs while copying an item, reports the exception and allows to recover from the exception and continue copying the items. </event><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The item represented by this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object does not physically exist. </exception><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> The destination item already exists, and <paramref name="replaceExistingFiles"/> is <see langword="false"/>. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The destination item already exists, <paramref name="replaceExistingFiles"/> is <see langword="true"/>, but the destination item has the <see langword="ReadOnly"/> attribute. </exception><exception cref="T:Xceed.FileSystem.FileSystemIOException"> The source item could not be read from, or the destination item could not be written to. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The item is a root folder. You should consider using <see cref="M:Xceed.FileSystem.AbstractFolder.CopyFilesTo(Xceed.FileSystem.AbstractFolder,System.Boolean,System.Boolean,System.Object[])"/> to copy the content of a root folder. </exception> </member> <member name="M:Xceed.FileSystem.FileSystemItem.ListCopyTo(Xceed.FileSystem.FileSystemEventsSession,System.Boolean)"> <summary> Copies each item in the <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object's list to each item's destination. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="replaceExistingFiles"><see langword="true"/> if existing items in the destination should be replaced; <see langword="false"/> otherwise.</param> <returns>A reference to a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object representing the target item of the <b>first</b> <see cref="T:Xceed.FileSystem.ItemPair"/>.</returns> </member> <member name="M:Xceed.FileSystem.FileSystemItem.MoveTo(Xceed.FileSystem.AbstractFolder,System.Boolean)"> <overloads><summary>Moves the item, or it's content to the destination.</summary></overloads> <summary> Moves the item to another folder. </summary><param name="destinationFolder">An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object into which the item will be moved. Cannot be <see langword="null"/>.</param><param name="replaceExistingFiles"><see langword="true"/> if existing items in the destination should be replaced; <see langword="false"/> otherwise.</param><returns>A <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that represents the newly moved item.</returns><remarks> <para> If the physical folder specified by <paramref name="destinationFolder"/> does not exist, it is created. </para><para> If this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object represents a file, the physical file is immediately moved to the destination folder. </para><para> If it represents a folder, the folder <b>and all it's content</b> (files and subfolders) is immediately moved to the destination. </para><para> When <paramref name="replaceExistingFiles"/> is <see langword="true"/>, any item in the destination that has the same name as an item being moved is automatically replaced. </para><para> When <paramref name="replaceExistingFiles"/> is <see langword="false"/>, an exception is thrown whenever the destination contains an item with the same name as an item being moved. </para> </remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The item represented by this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object does not physically exist. </exception><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> The destination item already exists, and <paramref name="replaceExistingFiles"/> is <see langword="false"/>. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The destination item already exists, <paramref name="replaceExistingFiles"/> is <see langword="true"/>, but the destination item has the <see langword="ReadOnly"/> attribute. Or the source item has the <see langword="ReadOnly"/> attribute, and cannot be deleted. </exception><exception cref="T:Xceed.FileSystem.FileSystemIOException"> The source item could not be read from, or the destination item could not be written to. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The item is a root folder. You should consider using <see cref="M:Xceed.FileSystem.AbstractFolder.MoveFilesTo(Xceed.FileSystem.AbstractFolder,System.Boolean,System.Boolean,System.Object[])"/> to move the content of a root folder. </exception> </member> <member name="M:Xceed.FileSystem.FileSystemItem.MoveTo(Xceed.FileSystem.FileSystemEvents,System.Object,Xceed.FileSystem.AbstractFolder,System.Boolean)"> <summary> Moves the item to another folder, and raises events during the process. </summary><param name="destinationFolder">An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object into which the item will be moved. Cannot be <see langword="null"/>.</param><param name="replaceExistingFiles"><see langword="true"/> if existing items in the destination should be replaced; <see langword="false"/> otherwise.</param><returns>A <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that represents the newly moved item.</returns><param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param><param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param><remarks> <para> If the physical folder specified by <paramref name="destinationFolder"/> does not exist, it is created. </para><para> If this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object represents a file, the physical file is immediately moved to the destination folder. </para><para> If it represents a folder, the folder <b>and all it's content</b> (files and subfolders) is immediately moved to the destination. </para><para> When <paramref name="replaceExistingFiles"/> is <see langword="true"/>, any item in the destination that has the same name as an item being moved is automatically replaced. </para><para> When <paramref name="replaceExistingFiles"/> is <see langword="false"/>, an exception is thrown whenever the destination contains an item with the same name as an item being moved. </para> </remarks><event cref="F:Xceed.FileSystem.FileSystemEvents.ScanningFolder"> A folder is being scanned for items to be moved. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ItemProgression"> Every time an item is about to be moved, reports how many items have been moved and the total number of items that must be moved. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ByteProgression"> Every 32k, reports how many bytes have been and must be moved for the current item, as well as for the entire set of items that are being moved. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ItemException"> When an exception occurs while moving an item, reports the exception and allows to recover from the exception and continue moving the items. </event><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The item represented by this <see cref="T:Xceed.FileSystem.FileSystemItem"/> object does not physically exist. </exception><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> The destination item already exists, and <paramref name="replaceExistingFiles"/> is <see langword="false"/>. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The destination item already exists, <paramref name="replaceExistingFiles"/> is <see langword="true"/>, but the destination item has the <see langword="ReadOnly"/> attribute. Or the source item has the <see langword="ReadOnly"/> attribute, and cannot be deleted. </exception><exception cref="T:Xceed.FileSystem.FileSystemIOException"> The source item could not be read from, or the destination item could not be written to. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The item is a root folder. You should consider using <see cref="M:Xceed.FileSystem.AbstractFolder.MoveFilesTo(Xceed.FileSystem.AbstractFolder,System.Boolean,System.Boolean,System.Object[])"/> to move the content of a root folder. </exception> </member> <member name="M:Xceed.FileSystem.FileSystemItem.ListMoveTo(Xceed.FileSystem.FileSystemEventsSession,System.Boolean)"> <summary> Moves each item in the <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object's list to each item's destination. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="replaceExistingFiles"><see langword="true"/> if existing items in the destination should be replaced; <see langword="false"/> otherwise.</param> <returns>A reference to a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object representing the target item of the <b>last</b> <see cref="T:Xceed.FileSystem.ItemPair"/>.</returns> </member> <member name="M:Xceed.FileSystem.FileSystemItem.ToString"> <summary> Returns the full name of the item. </summary><returns>A string that represents the full name of the item.</returns><seealso cref="P:Xceed.FileSystem.FileSystemItem.FullName"/> </member> <member name="M:Xceed.FileSystem.FileSystemItem.ApplyPropertiesTo(Xceed.FileSystem.FileSystemItem)"> <overloads><summary>Copies the item's properties to another item.</summary></overloads> <summary> Copies the item's properties to another item. </summary><param name="targetItem">A <see cref="T:Xceed.FileSystem.FileSystemItem"/> object to which the current item's properties must be copied. Cannot be <see langword="null"/>.</param><remarks><para> If the current item does not exist, its cached properties are copied to the destination. If it does exist, its physical properties are copied. </para><para> If the target item does not exist, it caches the values of the properties. If it does exist, its physical properties are changed immediately. </para><para> This method only copies the properties that are supported by the source and target items. No exception will be thrown if one of the items does not support one of the copied properties. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> does <b>not</b> need to be called before calling this method. This method will always copy the up-to-date property values to the target item. </para></remarks><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The target item has the <see langword="ReadOnly"/> attribute, preventing it from being modified. </exception> </member> <member name="M:Xceed.FileSystem.FileSystemItem.ApplyPropertiesTo(Xceed.FileSystem.FileSystemEvents,System.Object,Xceed.FileSystem.FileSystemItem)"> <summary> Copies the item's properties to another item and raises events during the process. </summary> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <param name="targetItem">A <see cref="T:Xceed.FileSystem.FileSystemItem"/> object to which the current item's properties must be copied. Cannot be <see langword="null"/>.</param> <remarks><para>If the current item does not exist, its cached properties are copied to the destination. If it does exist, its physical properties are copied.</para><para> If the target item does not exist, it caches the values of the properties. If it does exist, its physical properties are changed immediately.</para><para> This method only copies the properties that are supported by the source and target items. No exception will be thrown if one of the items does not support one of the copied properties.</para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> does <b>not</b> need to be called before calling this method. This method will always copy the up-to-date property values to the target item.</para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemItem.DoRefresh(Xceed.FileSystem.FileSystemEventsSession)"> <summary> Re-reads the information from the physical item. This method must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <remarks><para>When a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object's properties, such as <see cref="P:Xceed.FileSystem.FileSystemItem.Attributes"/> or <see cref="P:Xceed.FileSystem.FileSystemItem.CreationDateTime"/>, are first accessed, a snapshot of the underlying physical item's properties should be taken. This snapshot should <b>not</b> be automatically updated whenever the physical item's properties change.</para><para> <see langword="Refresh"/> should re-read the information from the physical item and updates the snapshot.</para><para> <b>Note: </b><see langword="Refresh"/> should be called before accessing a property, or the information returned could be outdated.</para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemItem.DoCreate(Xceed.FileSystem.FileSystemEventsSession)"> <summary> Creates the physical item represented by the <see cref="T:Xceed.FileSystem.FileSystemItem"/> object. This method must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <remarks><para> If the parents of the <see cref="T:Xceed.FileSystem.FileSystemItem"/> object do not exist upon creation of the item, an exception should be thrown.</para><para> If an exception is thrown during the creation of the item, the physical item should not be deleted automatically. </para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemItem.EnsureDateIsValid(System.DateTime)"> <summary> Ensures that the <see cref="T:System.DateTime"/> value is valid. </summary> <param name="value">The <see cref="T:System.DateTime"/> value to validate.</param> <remarks><para> This method should be overridden only in the case where the physical item ( file or folder ) supports a specific date/time interval for our <see cref="T:System.DateTime"/> values ( creation, modified, accessed ). </para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemItem.DoDelete(Xceed.FileSystem.FileSystemEventsSession)"> <summary> Permanently deletes the physical item. This method must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <remarks><para> If this method is called for an <see cref="T:Xceed.FileSystem.AbstractFolder"/> object, all children should have been previously deleted or the folder be empty or an exception should be thrown.</para><para> All metadata ( attributes, size, etc... ) associated with the <see cref="T:Xceed.FileSystem.FileSystemItem"/> object should be reset to their default values after the item is deleted. </para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemItem.DoCopyTo(Xceed.FileSystem.FileSystemEventsSession,Xceed.FileSystem.FileSystemItem,System.Boolean)"> <summary> Copies the item to another folder. This method must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="destination">An <see cref="T:Xceed.FileSystem.FileSystemItem"/> object into which the item will be copied. Should not be <see langword="null"/>.</param> <param name="replaceExistingFiles"><see langword="true"/> if existing items in the destination should be replaced; <see langword="false"/> otherwise.</param> <remarks><para> If the destination does not exists, it should be created. </para><para> If an error occurs during the copying process of a file, the destination should not be automatically deleted. </para><para> If the destination is created during the process, the metadata of the source item should be applied to the destination by calling <see cref="M:Xceed.FileSystem.FileSystemItem.ApplyPropertiesTo(Xceed.FileSystem.FileSystemItem)"/>. </para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemItem.DoApplyPropertiesTo(Xceed.FileSystem.FileSystemEventsSession,Xceed.FileSystem.FileSystemItem)"> <summary> Copies the item's properties to another item. This method must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="targetItem">A <see cref="T:Xceed.FileSystem.FileSystemItem"/> object to which the current item's properties must be copied. Should not be <see langword="null"/>.</param> <remarks><para> This method should be overridden only in the case where the physical item ( file or folder ) supports specific meta-data ( other than attributes, dates, size, etc... ). The overriding method should eventually call the base implementation found in the <see cref="T:Xceed.FileSystem.FileSystemItem"/> class in order to address the regular FileSystemItem meta-data. </para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemItem.IsSameAs(Xceed.FileSystem.FileSystemItem)"> <summary> Gets a boolean value indicating if the source and target items are the same. This method must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <param name="target">A <see cref="T:Xceed.FileSystem.FileSystemItem"/> object representing the destination item.</param> <remarks><para> If the target item is <see langword="null"/>, this method should return <see langword="false"/> </para></remarks> <returns><see langword="true"/> if the source and target <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects are the same; <see langword="false"/> otherwise.</returns> </member> <member name="M:Xceed.FileSystem.FileSystemItem.IsPathRooted(System.String)"> <summary> Returns a boolean value indicating if the path passed is rooted in the environment of the <see cref="T:Xceed.FileSystem.FileSystemItem"/> object we are dealing with. This method must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <param name="path">The path to verify.</param> <returns><see langword="true"/> if the path is rooted; <see langword="false"/> otherwise.</returns> </member> <member name="M:Xceed.FileSystem.FileSystemItem.BuildList(Xceed.FileSystem.FileSystemEventsSession,Xceed.FileSystem.FileSystemItem,System.Boolean,System.Boolean,System.Boolean,Xceed.FileSystem.Filter[])"> <summary> Builds a list of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to process. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="destination">The eventual target for the item that will be procesed. For example, the desination folder for a folder that will be copied.</param> <param name="forward"><see langword="true"/> if folders will be added to the list of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to process first; <see langword="false"/> if files will be added to the list first.</param> <param name="recursive"><see langword="true"/> if items in subfolders should be added to the list of items to process; <see langword="false"/> otherwise.</param> <param name="includeFolders"><see langword="true"/> if folders will be included in the list of items to process; <see langword="false"/> otherwise.</param> <param name="filters">An array of objects that can be used to filter the list of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to process.</param> <remarks><para> This method is overridden in both the <see cref="T:Xceed.FileSystem.AbstractFolder"/> and <see cref="T:Xceed.FileSystem.AbstractFile"/> classes and <b>does not</b> need to be overridden in more specific implementations. </para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemItem.BuildListForCreate(Xceed.FileSystem.FileSystemEventsSession)"> <summary> Handles the special cases in regards to building the list of items to process when creating a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> </member> <member name="F:Xceed.FileSystem.FileSystemItem.m_licenser"> <summary> The licenser that can be used to verify properties of the license. </summary> </member> <member name="P:Xceed.FileSystem.FileSystemItem.Name"> <summary> Gets or sets the short name of the item. </summary><value>A string that represents the short name of the item.</value><remarks><para> The short name consists of the item's name without a path. </para><para> For example, the short name of a file named "c:\foo\bar.txt" is "bar.txt", and the short name of a folder named "c:\foo\" is "foo". </para><para> When assigning a new name to this property, the physical item is immediately renamed if it exists. If it does not exist, the new name is cached and will be applied whenever this item is created. In either cases, if a physical item with the same name already exists, an exception is thrown. </para><para> The short name of an item must <b>not</b> end with a path separator character regardless of whether it represents a file or a folder. </para><para> The separator character is defined in <see cref="F:System.IO.Path.DirectorySeparatorChar"/> and <see cref="F:System.IO.Path.AltDirectorySeparatorChar"/>. </para></remarks><exception cref="T:System.ArgumentException"> The new name assigned to the item is an empty string, contains only white space, contains a path, or contains invalid characters as defined in <see cref="P:Xceed.FileSystem.FileSystemItem.InvalidChars"/>. </exception><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> The new name corresponds to a physical item that already exists. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.FileSystemItem.FullName"> <summary> Gets the full name of the item. </summary><value>A string that represents the full name of the item.</value><remarks><para> The full name consists of the item's name fully-qualified with a path. For example: "c:\foo\bar.txt", "c:\foo\". </para><para> If the item represents a file, its name does <b>not</b> end with a path separator character. </para><para> If the item represents a folder, its name <b>does</b> end with a path separator character. </para><para> The separator character is defined in <see cref="F:System.IO.Path.DirectorySeparatorChar"/> and <see cref="F:System.IO.Path.AltDirectorySeparatorChar"/>. </para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemItem.Attributes"> <summary> Gets or sets the attributes of the item. </summary><value>A combination of <see cref="T:System.IO.FileAttributes"/> values that represents the attributes of the item.</value><remarks><para> When changing the item's attributes through this property, the physical item is immediately modified if it exists. If it does not exist, the attributes are cached and will be applied whenever this item is created. </para><para> Some types of items may not expose attributes. In this case, an exception is thrown when trying to read or modify the attributes. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated. </para></remarks><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The item does not expose attributes, or does not support one of the assigned attributes. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The physical item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.FileSystemItem.CreationDateTime"> <summary> Gets or sets the creation date and time of the item. </summary><value>The date and time when the item was created.</value><remarks><para> When changing the item's creation date through this property, the physical item is immediately modified if it exists. If it does not exist, the date is cached and will be applied whenever this item is created. </para><para> Some types of items may not expose a creation date and time. In this case, an exception is thrown when trying to read or modify the creation date. </para><para> Other types of items that do expose a creation date and time may not have the information available. In this case, <see cref="F:System.DateTime.MinValue"/> is returned. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated. </para></remarks><exception cref="T:System.ArgumentException"> The provided creation date is not valid for this item. </exception><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The item does not expose a creation date. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The item has the <see langword="ReadOnly"/> attribute, preventing it from being modified. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.FileSystemItem.LastWriteDateTime"> <summary> Gets or sets the modification date and time of the item. </summary><value>The date and time when the item was modified.</value><remarks><para> When changing the item's modification date through this property, the physical item is immediately modified if it exists. If it does not exist, the date is cached and will be applied whenever this item is created. </para><para> Some types of items may not expose a modification date and time. In this case, an exception is thrown when trying to read or modify the modification date. </para><para> Other types of items that do expose a modification date and time may not have the information available. In this case, <see cref="F:System.DateTime.MinValue"/> is returned. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated. </para></remarks><exception cref="T:System.ArgumentException"> The provided modification date is not valid for this item. </exception><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The item does not expose a modification date. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The item has the <see langword="ReadOnly"/> attribute, preventing it from being modified. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.FileSystemItem.LastAccessDateTime"> <summary> Gets or sets the last access date and time of the item. </summary><value>The date and time when the item was last accessed.</value><remarks><para> When changing the item's access date through this property, the physical item is immediately modified if it exists. If it does not exist, the date is cached and will be applied whenever this item is created. </para><para> Some types of items may not expose a last access date and time. In this case, an exception is thrown when trying to read or modify the access date. </para><para> Other types of items that do expose a last access date and time may not have the information available. In this case, <see cref="F:System.DateTime.MinValue"/> is returned. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated. </para></remarks><exception cref="T:System.ArgumentException"> The provided last access date is not valid for this item. </exception><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The item does not expose a last access date. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The item has the <see langword="ReadOnly"/> attribute, preventing it from being modified. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The physical item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.FileSystemItem.ParentFolder"> <summary> Gets a reference to the parent folder of this item. </summary><value>An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object that represents the folder that contains the item, or <see langword="null"/> if the item does not have a parent.</value><remarks><para> If the current item is the root of a folder hierarchy, it has no parent folder. In this case, the <see langword="ParentFolder"/> property returns <see langword="null"/>. </para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemItem.RootFolder"> <summary> Gets a reference to the root folder of this item. </summary><value>An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object that represents the folder at the root of the path of this item, or <see langword="null"/> if a root folder is not available.</value><remarks><para> A root folder represents the starting point of a folder hierarchy. On a physical disk, it is usually represented by a drive letter ("C:\") or UNC root ("\\server\share\"). </para><para> Some specializations of the <see cref="T:Xceed.FileSystem.AbstractFolder"/> class may define a specialized class that represents a root folder, exposing properties and methods that apply only to a root. </para><para> Therefore, the <see langword="RootFolder"/> property may return an <see cref="T:Xceed.FileSystem.AbstractFolder"/> instance that is in fact a specialized class representing the root. </para><para> If the current item is the root of a folder hierarchy, the <see langword="RootFolder"/> property returns a reference to itself, or a reference to a specialized object that represents the root folder with more details. </para><para> If a root folder is not available, the <see langword="RootFolder"/> property returns <see langword="null"/>. </para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemItem.Exists"> <summary> Gets a boolean value indicating if the item physically exists. </summary><value><see langword="true"/> if the item physically exists; <see langword="false"/> otherwise.</value><remarks><para> This property should be evaluated before calling a method that needs to access the underlying physical item (For example, <see cref="M:Xceed.FileSystem.FileSystemItem.CopyTo(Xceed.FileSystem.AbstractFolder,System.Boolean)"/>), otherwise these methods will throw an exception. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> does <b>not</b> need to be called before accessing this property. The property will always reflect the physical item's existence. </para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemItem.InvalidChars"> <summary> Gets the characters that are invalid in file and folder names. </summary> <value>An array of characters containing the characters that are invalid in file and folder names.</value> </member> <member name="P:Xceed.FileSystem.FileSystemItem.DoName"> <summary> Gets or sets the short name of the item. This property must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <value>A string that represents the short name of the item.</value> <remarks><para>When assigning a new name to this property, the physical item should be immediately renamed if it exists. If it does not exist, the new name should be cached and applied whenever this item is created. In either cases, if a physical item with the same name already exists, an exception should be thrown.</para> <para>The short name of an item should not end with a path separator character regardless of whether it represents a file or a folder.</para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemItem.DoFullName"> <summary> Gets the full name of the item. This property must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <value>A string that represents the full name of the item.</value> <remarks><para>The full name should consist of the item's name fully-qualified with a path. For example: "c:\foo\bar.txt", "c:\foo\".</para><para> If the item represents a file, its name should not end with a path separator character.</para><para> If the item represents a folder, its name should end with a path separator character.</para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemItem.DoAttributes"> <summary> Gets or sets the attributes of the item. This property must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <value>A combination of <see cref="T:System.IO.FileAttributes"/> values that represents the attributes of the item.</value> <remarks><para>When changing the item's attributes through this property, the physical item should be immediately modified if it exists. If it does not exist, the attributes should be cached and applied whenever this item is created.</para><para> Some types of items may not expose attributes. In this case, an exception should be thrown when trying to read or modify the attributes.</para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated. </para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemItem.DoCreationDateTime"> <summary> Gets or sets the creation date and time of the item. This property must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <value>The date and time when the item was created.</value> <remarks><para>When changing the item's creation date through this property, the physical item should be immediately modified if it exists. If it does not exist, the date should be cached and applied whenever this item is created.</para><para> Some types of items may not expose a creation date and time. In this case, an exception should be thrown when trying to read or modify the creation date.</para><para> Other types of items that do expose a creation date and time may not have the information available. In this case, <see cref="F:System.DateTime.MinValue"/> should be returned.</para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated.</para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemItem.DoLastWriteDateTime"> <summary> Gets or sets the modification date and time of the item. This property must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <value>The date and time when the item was modified.</value> <remarks><para>When changing the item's modification date through this property, the physical item should be immediately modified if it exists. If it does not exist, the date should be cached and applied whenever this item is created.</para><para> Some types of items may not expose a modification date and time. In this case, an exception should be thrown when trying to read or modify the modification date.</para><para> Other types of items that do expose a modification date and time may not have the information available. In this case, <see cref="F:System.DateTime.MinValue"/> should be returned.</para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated.</para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemItem.DoLastAccessDateTime"> <summary> Gets or sets the last access date and time of the item. This property must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <value>The date and time when the item was last accessed.</value> <remarks><para>When changing the item's access date through this property, the physical item should be immediately modified if it exists. If it does not exist, the date should be cached and applied whenever this item is created.</para><para> Some types of items may not expose a last access date and time. In this case, an exception should be thrown when trying to read or modify the access date.</para><para> Other types of items that do expose a last access date and time may not have the information available. In this case, <see cref="F:System.DateTime.MinValue"/> should be returned.</para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated.</para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemItem.DoParentFolder"> <summary> Gets a reference to the parent folder of this item. This property must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <value>An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object that represents the folder that contains the item, or <see langword="null"/> if the item does not have a parent.</value> <remarks><para>If the current item is the root of a folder hierarchy, it has no parent folder. In this case, the <see langword="ParentFolder"/> property should return <see langword="null"/>.</para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemItem.DoRootFolder"> <summary> Gets a reference to the root folder of this item. This property must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <value>An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object that represents the folder at the root of the path of this item, or <see langword="null"/> if a root folder is not available.</value> <remarks><para>A root folder should represent the starting point of a folder hierarchy. On a physical disk, it is usually represented by a drive letter ("C:\") or UNC root ("\\server\share\").</para><para> If the current item is the root of a folder hierarchy, the <see langword="RootFolder"/> property should return a reference to itself.</para><para> If a root folder is not available, the <see langword="RootFolder"/> property should return <see langword="null"/>.</para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemItem.DoExists"> <summary> Gets a boolean value indicating if the item physically exists. This property must be overridden when deriving from the <see cref="T:Xceed.FileSystem.AbstractFolder"/> or <see cref="T:Xceed.FileSystem.AbstractFile"/> classes. </summary> <value><see langword="true"/> if the item physically exists; <see langword="false"/> otherwise.</value> <remarks><para>This property should be evaluated before calling a method that needs to access the underlying physical item, otherwise an exception should be raised from the method.</para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> does not need to be called before accessing this property. The property should always reflect the physical item's existence.</para></remarks> </member> <member name="M:Xceed.FileSystem.AbstractFile.OpenRead"> <overloads><summary>Opens the file for reading.</summary></overloads> <summary> Opens the file for reading. </summary><returns>A <see cref="T:System.IO.Stream"/> object that can be used to read data from the file.</returns><remarks> <para> The returned stream is guaranteed to be readable, but may or may not be seekable. </para> <para> The file will be opened with <see cref="F:System.IO.FileShare.Read"/> shared access. </para> </remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The file represented by this <see cref="T:Xceed.FileSystem.AbstractFile"/> object does not physically exist. </exception><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The file cannot be opened for reading. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFile.OpenRead(System.IO.FileShare)"> <summary> Opens the file for reading with the specified file sharing mode. </summary><returns>A <see cref="T:System.IO.Stream"/> object that can be used to read data from the file.</returns><param name="share">A <see cref="T:System.IO.FileShare"/> constant that determines how the file will be shared by different processes.</param><remarks> <para> The returned stream is guaranteed to be readable, but may or may not be seekable. </para> <para> The <paramref name="share"/> parameter allows you to control how the file is shared by different processes. Some specializations of the <see cref="T:Xceed.FileSystem.AbstractFile"/> class may not support any or all of the values defined in this enumeration. In this case, an exception is thrown. </para> </remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The file represented by this <see cref="T:Xceed.FileSystem.AbstractFile"/> object does not physically exist. </exception><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The file cannot be opened for reading, or the provided <paramref name="share"/> value is not supported by this file. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFile.OpenRead(Xceed.FileSystem.FileSystemEvents,System.Object)"> <summary> Opens the file for reading and raises events during the process. </summary> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <returns>A <see cref="T:System.IO.Stream"/> object that can be used to read data from the file.</returns> <remarks><para>The file will be opened with <see cref="F:System.IO.FileShare.Read"/> shared access.</para> <para>The returned stream is guaranteed to be readable, but may or may not be seekable.</para></remarks> <exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The file represented by this <see cref="T:Xceed.FileSystem.AbstractFile"/> object does not physically exist.</exception> <exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The file cannot be opened for reading.</exception> </member> <member name="M:Xceed.FileSystem.AbstractFile.OpenRead(Xceed.FileSystem.FileSystemEvents,System.Object,System.IO.FileShare)"> <summary> Opens the file for reading with the specified file sharing mode and raises events during the process. </summary> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <param name="share">A <see cref="T:System.IO.FileShare"/> constant that determines how the file will be shared by different processes.</param> <returns>A <see cref="T:System.IO.Stream"/> object that can be used to read data from the file.</returns> <remarks><para>The returned stream is guaranteed to be readable, but may or may not be seekable.</para> <para>The <paramref name="share"/> parameter allows you to control how the file is shared by different processes. Some specializations of the <see cref="T:Xceed.FileSystem.AbstractFile"/> class may not support any or all of the values defined in this enumeration. In this case, an exception is thrown.</para> </remarks> <exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The file represented by this <see cref="T:Xceed.FileSystem.AbstractFile"/> object does not physically exist.</exception> <exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The file cannot be opened for reading, or the provided <paramref name="share"/> value is not supported by this file.</exception> </member> <member name="M:Xceed.FileSystem.AbstractFile.OpenWrite(System.Boolean)"> <overloads><summary>Opens the file for writing.</summary></overloads> <summary> Opens the file for writing. </summary><param name="overwrite"><see langword="true"/> if existing data for the item should be replaced; <see langword="false"/> if existing data should be preserved, appending new data at the end.</param><returns>A <see cref="T:System.IO.Stream"/> object that can be used to write data to the file.</returns><remarks> <para> The returned stream is guaranteed to be writable, but may or may not be seekable. </para> <para> The file will be opened with <see cref="F:System.IO.FileShare.None"/> shared access. </para> </remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The file represented by this <see cref="T:Xceed.FileSystem.AbstractFile"/> object does not physically exist. </exception><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The file cannot be opened for writing. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFile.OpenWrite(System.Boolean,System.IO.FileShare)"> <summary> Opens the file for writing with the specified file sharing mode. </summary><param name="overwrite"><see langword="true"/> if existing data for the item should be replaced; <see langword="false"/> if existing data should be preserved, appending new data at the end.</param><returns>A <see cref="T:System.IO.Stream"/> object that can be used to write data to the file.</returns><param name="share">A <see cref="T:System.IO.FileShare"/> constant that determines how the file will be shared by different processes.</param><remarks> <para> The returned stream is guaranteed to be writable, but may or may not be seekable. </para> <para> The <paramref name="share"/> parameter allows you to control how the file is shared by different processes. Some specializations of the <see cref="T:Xceed.FileSystem.AbstractFile"/> class may not support any or all of the values defined in this enumeration. In this case, an exception is thrown. </para><para> Some File implementations may not support appending or overwriting. In this case, an exception is thrown. </para><para> If there is no existing data, the parameter <paramref name="overwrite"/> is ignored. </para> </remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The file represented by this <see cref="T:Xceed.FileSystem.AbstractFile"/> object does not physically exist. </exception><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The file cannot be opened for writing, does not support appending or overwriting, or the provided <paramref name="share"/> value is not supported by this file. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFile.OpenWrite(Xceed.FileSystem.FileSystemEvents,System.Object,System.Boolean)"> <summary> Opens the file for writing and raises events during the process. </summary> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <param name="overwrite"><see langword="true"/> if existing data for the item should be replaced; <see langword="false"/> if existing data should be preserved, appending new data at the end.</param> <returns>A <see cref="T:System.IO.Stream"/> object that can be used to write data to the file.</returns> <remarks><para>The returned stream is guaranteed to be writable, but may or may not be seekable.</para> <para>The file will be opened with <see cref="F:System.IO.FileShare.None"/> shared access.</para></remarks> <exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The file represented by this <see cref="T:Xceed.FileSystem.AbstractFile"/> object does not physically exist.</exception> <exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The file cannot be opened for writing.</exception> </member> <member name="M:Xceed.FileSystem.AbstractFile.OpenWrite(Xceed.FileSystem.FileSystemEvents,System.Object,System.Boolean,System.IO.FileShare)"> <summary> Opens the file for writing with the specified file sharing mode and raises events during the process. </summary> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <param name="overwrite"><see langword="true"/> if existing data for the item should be replaced; <see langword="false"/> if existing data should be preserved, appending new data at the end.</param> <param name="share">A <see cref="T:System.IO.FileShare"/> constant that determines how the file will be shared by different processes.</param> <returns>A <see cref="T:System.IO.Stream"/> object that can be used to write data to the file.</returns> <remarks><para>The returned stream is guaranteed to be writable, but may or may not be seekable.</para> <para>The <paramref name="share"/> parameter allows you to control how the file is shared by different processes. Some specializations of the <see cref="T:Xceed.FileSystem.AbstractFile"/> class may not support any or all of the values defined in this enumeration. In this case, an exception is thrown.</para> <para>Some File implementations may not support appending or overwriting. In this case, an exception is thrown.</para> <para>If there is no existing data, the parameter <paramref name="overwrite"/> is ignored.</para></remarks> <exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The file represented by this <see cref="T:Xceed.FileSystem.AbstractFile"/> object does not physically exist.</exception> <exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The file cannot be opened for writing, does not support appending or overwriting, or the provided <paramref name="share"/> value is not supported by this file.</exception> </member> <member name="M:Xceed.FileSystem.AbstractFile.CopyTo(Xceed.FileSystem.AbstractFile,System.Boolean)"> <summary> Copies the file's data to another file. </summary><param name="destinationFile">An <see cref="T:Xceed.FileSystem.AbstractFile"/> object that represents the file to which the current file's data must be copied. Cannot be <see langword="null"/>.</param><param name="replaceIfExists"><see langword="true"/> if the destination file should be replaced if it exists; <see langword="false"/> otherwise.</param><returns> A reference to a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that represents the destination file. </returns><remarks> <para> This method only copies the <b>data</b> of a file to another file. </para><para> If the file specified by <paramref name="destinationFile"/> does not exist, it is created. If it does exist, an exception is thrown if <paramref name="replaceIfExists"/> is <see langword="false"/>, or it is overwritten if <paramref name="replaceIfExists"/> is <see langword="true"/>. </para> </remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The file represented by this <see cref="T:Xceed.FileSystem.AbstractFile"/> does not physically exist. </exception><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> The destination file already exists, and <paramref name="replaceIfExists"/> is <see langword="false"/>. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The destination file already exists, <paramref name="replaceIfExists"/> is <see langword="true"/> but the destination file has the <see langword="ReadOnly"/> attribute. </exception><exception cref="T:Xceed.FileSystem.FileSystemIOException"> The source file could not be read from, or the destination file could not be written to. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFile.CopyTo(Xceed.FileSystem.FileSystemEvents,System.Object,Xceed.FileSystem.AbstractFile,System.Boolean)"> <summary> Copies the file's data to another file, and raises events during the process. </summary><param name="destinationFile">An <see cref="T:Xceed.FileSystem.AbstractFile"/> object that represents the file to which the current file's data must be copied. Cannot be <see langword="null"/>.</param><param name="replaceIfExists"><see langword="true"/> if the destination file should be replaced if it exists; <see langword="false"/> otherwise.</param><returns> A reference to a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that represents the destination file. </returns><param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param><param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param><remarks> <para> This method only copies the <b>data</b> of a file to another file. </para><para> If the file specified by <paramref name="destinationFile"/> does not exist, it is created. If it does exist, an exception is thrown if <paramref name="replaceIfExists"/> is <see langword="false"/>, or it is overwritten if <paramref name="replaceIfExists"/> is <see langword="true"/>. </para> </remarks><event cref="F:Xceed.FileSystem.FileSystemEvents.ByteProgression"> Every 32k, reports how many bytes have been and must be copied for the current file. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ItemException"> When an exception occurs while copying the file, reports the exception and allows recovery from the exception and continues copying the file. </event><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The file represented by this <see cref="T:Xceed.FileSystem.AbstractFile"/> does not physically exist. </exception><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> The destination file already exists, and <paramref name="replaceIfExists"/> is <see langword="false"/>. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The destination file already exists, <paramref name="replaceIfExists"/> is <see langword="true"/> but the destination file has the <see langword="ReadOnly"/> attribute. </exception><exception cref="T:Xceed.FileSystem.FileSystemIOException"> The source file could not be read from, or the destination file could not be written to. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFile.MoveTo(Xceed.FileSystem.AbstractFile,System.Boolean)"> <summary> Moves the contents of the <see cref="T:Xceed.FileSystem.AbstractFile"/> object to the target <see cref="T:Xceed.FileSystem.AbstractFile"/> object. </summary> <param name="destinationFile">An <see cref="T:Xceed.FileSystem.AbstractFile"/> object into which the contents of the item will be moved. Cannot be <see langword="null"/>.</param> <param name="replaceIfExists"><see langword="true"/> if existing items in the destination should be replaced; <see langword="false"/> otherwise.</param> <remarks><para>If the physical file specified by <paramref name="destinationFile"/> does not exist, it is created.</para></remarks> <returns>A <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that represents the newly moved item.</returns> <exception cref="T:Xceed.FileSystem.ItemDoesNotExistException">The file represented by this <see cref="T:Xceed.FileSystem.AbstractFile"/> object does not physically exist.</exception> <exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException">The destination file already exists, and <paramref name="replaceIfExists"/>is <see langword="false"/>.</exception> <exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException">The destination file already exists, <paramref name="replaceIfExists"/> is <see langword="true"/>, but the destination file has the <see langword="ReadOnly"/> attribute. Or the source file has the <see langword="ReadOnly"/> attribute, and cannot be deleted.</exception> <exception cref="T:Xceed.FileSystem.FileSystemIOException">The source file could not be read from, or the destination file could not be written to.</exception> </member> <member name="M:Xceed.FileSystem.AbstractFile.MoveTo(Xceed.FileSystem.FileSystemEvents,System.Object,Xceed.FileSystem.AbstractFile,System.Boolean)"> <summary> Moves the contents of the <see cref="T:Xceed.FileSystem.AbstractFile"/> object to the target <see cref="T:Xceed.FileSystem.AbstractFile"/> object and raises events during the process. </summary> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <param name="destinationFile">An <see cref="T:Xceed.FileSystem.AbstractFile"/> object into which the contents of the item will be moved. Cannot be <see langword="null"/>.</param> <param name="replaceIfExists"><see langword="true"/> if existing items in the destination should be replaced; <see langword="false"/> otherwise.</param> <remarks><para>If the physical file specified by <paramref name="destinationFile"/> does not exist, it is created.</para></remarks> <returns>A <see cref="T:Xceed.FileSystem.FileSystemItem"/> object that represents the newly moved item.</returns> <exception cref="T:Xceed.FileSystem.ItemDoesNotExistException">The file represented by this <see cref="T:Xceed.FileSystem.AbstractFile"/> object does not physically exist.</exception> <exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException">The destination file already exists, and <paramref name="replaceIfExists"/>is <see langword="false"/>.</exception> <exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException">The destination file already exists, <paramref name="replaceIfExists"/> is <see langword="true"/>, but the destination file has the <see langword="ReadOnly"/> attribute. Or the source file has the <see langword="ReadOnly"/> attribute, and cannot be deleted.</exception> <exception cref="T:Xceed.FileSystem.FileSystemIOException">The source file could not be read from, or the destination file could not be written to.</exception> <event cref="F:Xceed.FileSystem.FileSystemEvents.ItemProgression">Every time an item is about to be moved, reports how many items have been moved and the total number of items that must be moved.</event> <event cref="F:Xceed.FileSystem.FileSystemEvents.ByteProgression">Every 32k, reports how many bytes have been and must be moved for the current item, as well as for the entire set of items that are being moved.</event> <event cref="F:Xceed.FileSystem.FileSystemEvents.ItemException">When an exception occurs while moving an item, reports the exception and allows to recover from the exception and continue moving the items. </event> </member> <member name="M:Xceed.FileSystem.AbstractFile.DoCopyTo(Xceed.FileSystem.FileSystemEventsSession,Xceed.FileSystem.FileSystemItem,System.Boolean)"> <summary> Copies the file into the destination. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="destination">An <see cref="T:Xceed.FileSystem.FileSystemItem"/> object into which the file will be copied. Cannot be <see langword="null"/>.</param> <param name="replaceExistingFiles"><see langword="true"/> if existing items in the destination should be replaced; <see langword="false"/> otherwise.</param> <exception cref="T:Xceed.FileSystem.ItemDoesNotExistException">The physical file does not exist.</exception> <exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException">The source and target files are the same item.</exception> <exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException">The desination exists and <paramref name="replaceExistingFiles"/> is set to <see langword="false"/>.</exception> <exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException">The destination already exists but is read-only.</exception> </member> <member name="M:Xceed.FileSystem.AbstractFile.DoOpenRead(Xceed.FileSystem.FileSystemEventsSession,System.IO.FileShare)"> <overloads><summary>Opens the file for reading.</summary></overloads> <summary> Opens the file for reading. This method must be overridden when deriving from this class. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="share">A <see cref="T:System.IO.FileShare"/> constant that determines how the file will be shared by different processes.</param> <remarks><para> The returned stream should be guaranteed to be readable, but does not have to be seekable. </para><para> The <paramref name="share"/> parameter should allow control over how the file is shared by different processes. If the values defined in this enumeration are not supported, an exception should thrown.</para></remarks> <returns>A <see cref="T:System.IO.Stream"/> object that can be used to read data from the file.</returns> </member> <member name="M:Xceed.FileSystem.AbstractFile.DoOpenWrite(Xceed.FileSystem.FileSystemEventsSession,System.Boolean,System.IO.FileShare)"> <overloads><summary>Opens the file for writing.</summary></overloads> <summary> Opens the file for writing. This method must be overridden when deriving from this class. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="overwrite"><see langword="true"/> if existing data for the file should be replaced; <see langword="false"/> if existing data should be preserved, appending new data at the end.</param> <param name="share">A <see cref="T:System.IO.FileShare"/> constant that determines how the file will be shared by different processes.</param> <remarks><para>The returned stream should be guaranteed to be writable, but does not have to be seekable.</para><para> The <paramref name="share"/> parameter should allow control over how the file is shared by different processes. If the values defined in this enumeration are not supported, an exception should be thrown.</para><para> If the File implementation does not support appending or overwriting, an exception should be thrown.</para><para> If there is no existing data, the parameter <paramref name="overwrite"/> should be ignored.</para></remarks> <returns>A <see cref="T:System.IO.Stream"/> object that can be used to write data to the file.</returns> </member> <member name="M:Xceed.FileSystem.AbstractFile.BuildList(Xceed.FileSystem.FileSystemEventsSession,Xceed.FileSystem.FileSystemItem,System.Boolean,System.Boolean,System.Boolean,Xceed.FileSystem.Filter[])"> <summary> Builds a list of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to process. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="destination">The eventual target for the item that will be procesed. For example, the desination folder for a folder that will be copied.</param> <param name="forward"><see langword="true"/> if folders will be added to the list of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to process first; <see langword="false"/> if files will be added to the list first.</param> <param name="recursive"><see langword="true"/> if items in subfolders should be added to the list of items to process; <see langword="false"/> otherwise.</param> <param name="includeFolders"><see langword="true"/> if folders will be included in the list of items to process; <see langword="false"/> otherwise.</param> <param name="filters">An array of objects that can be used to filter the list of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to process.</param> </member> <member name="P:Xceed.FileSystem.AbstractFile.Size"> <summary> Gets the size of the file in bytes. </summary><value>A value representing the file size in bytes.</value><remarks><para> Some types of files may not have the size information available. In this case, <see langword="-1"/> is returned. </para><para> If the file does not physically exist, an exception is thrown. </para> <para><b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated.</para></remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The file represented by this <see cref="T:Xceed.FileSystem.AbstractFile"/> does not physically exist. </exception> </member> <member name="P:Xceed.FileSystem.AbstractFile.DoSize"> <summary> Gets the size of the file in bytes. This property must be overridden when deriving from this class. </summary> <value>A value representing the file size in bytes.</value> <remarks><para>Some types of files may not have the size information available. In this case, <see langword="-1"/> should be returned.</para><para> If the file does not physically exist, an exception should be thrown.</para> <para><b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated. </para></remarks> </member> <member name="T:Xceed.FileSystem.AbstractFolder"> <summary> Represents a generic folder, and exposes properties and methods that allow folder-oriented operations to be performed. </summary> </member> <member name="M:Xceed.FileSystem.AbstractFolder.CreateFile(System.String,System.Boolean)"> <summary> Creates a new file in the folder. </summary><param name="relativeName">Relative name of the new file.</param><param name="replaceIfExists"><see langword="true"/> if the new file should replace an existing file; <see langword="false"/> otherwise.</param><returns>An <see cref="T:Xceed.FileSystem.AbstractFile"/> object representing the newly created file.</returns><remarks><para> The <paramref name="relativeName"/> parameter can include relative path information, in which ".." means "previous folder". For example: "foo/bar.txt", "../bar.txt", etc. </para><para> If a file named <paramref name="relativeName"/> already exist in the destination folder and <paramref name="replaceIfExists"/> is <see langword="false"/>, an exception is thrown. If <paramref name="replaceIfExists"/> is <see langword="true"/>, the existing file is replaced by the newly created one. </para><para> If the physical folder in which the new file is to be created does not exist, it is created. </para><para> The current property values (such as <see cref="P:Xceed.FileSystem.FileSystemItem.Attributes"/>) are applied to the newly created file. </para></remarks><exception cref="T:System.ArgumentException"> The <paramref name="relativeName"/> parameter is an empty string, contains only white space, or contains invalid characters as defined in <see cref="P:Xceed.FileSystem.FileSystemItem.InvalidChars"/>. </exception><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> The destination file already exists, and <paramref name="replaceIfExists"/> is <see langword="false"/>. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The destination file already exists, <paramref name="replaceIfExists"/> is <see langword="true"/>, but the destination file has the <see langword="ReadOnly"/> attribute. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.CreateFile(Xceed.FileSystem.FileSystemEvents,System.Object,System.String,System.Boolean)"> <summary> Creates a new file in the folder and raises events during the process. </summary> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <param name="relativeName">Relative name of the new file.</param> <param name="replaceIfExists"><see langword="true"/> if the new file should replace an existing file; <see langword="false"/> otherwise.</param> <returns>An <see cref="T:Xceed.FileSystem.AbstractFile"/> object representing the newly created file.</returns> <remarks><para>The <paramref name="relativeName"/> parameter can include relative path information, in which ".." means "previous folder". For example: "foo/bar.txt", "../bar.txt", etc.</para><para> If a file named <paramref name="relativeName"/> already exist in the destination folder and <paramref name="replaceIfExists"/> is <see langword="false"/>, an exception is thrown. If <paramref name="replaceIfExists"/> is <see langword="true"/>, the existing file is replaced by the newly created one. </para><para>If the physical folder in which the new file is to be created does not exist, it is created.</para><para>The current property values (such as <see cref="P:Xceed.FileSystem.FileSystemItem.Attributes"/>) are applied to the newly created file.</para></remarks> <exception cref="T:System.ArgumentException">The <paramref name="relativeName"/> parameter is an empty string, contains only white space, or contains invalid characters as defined in <see cref="P:Xceed.FileSystem.FileSystemItem.InvalidChars"/>.</exception> <exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException">The destination file already exists, and <paramref name="replaceIfExists"/> is <see langword="false"/>.</exception> <exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException">The destination file already exists, <paramref name="replaceIfExists"/> is <see langword="true"/>, but the destination file has the <see langword="ReadOnly"/> attribute.</exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.CreateFolder(System.String)"> <summary> Creates a new folder in the folder. </summary><param name="relativeName">Relative name of the new folder.</param><returns>An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object representing the newly created folder.</returns><remarks><para> The <paramref name="relativeName"/> parameter can include relative path information, in which ".." means "previous folder". For example: "foo/bar", "../bar", etc. </para><para> If a folder named <paramref name="relativeName"/> already exist, this method does nothing. </para><para> If the physical folder in which the new folder is to be created does not exist, it is created. </para><para> The current property values (such as <see cref="P:Xceed.FileSystem.FileSystemItem.Attributes"/>) are applied to the newly created folder. </para></remarks><exception cref="T:System.ArgumentException"> The <paramref name="relativeName"/> parameter is an empty string, contains only white space, or contains invalid characters as defined in <see cref="P:Xceed.FileSystem.FileSystemItem.InvalidChars"/>. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.CreateFolder(Xceed.FileSystem.FileSystemEvents,System.Object,System.String)"> <summary> Creates a new folder in the folder and raises events during the process. </summary> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <param name="relativeName">Relative name of the new file.</param> <returns>An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object representing the newly created folder.</returns> <remarks><para>The <paramref name="relativeName"/> parameter can include relative path information, in which ".." means "previous folder". For example: "foo/bar", "../bar", etc.</para><para>If a folder named <paramref name="relativeName"/> already exist, this method does nothing. </para><para>If the physical folder in which the new folder is to be created does not exist, it is created.</para><para>The current property values (such as <see cref="P:Xceed.FileSystem.FileSystemItem.Attributes"/>) are applied to the newly created folder.</para></remarks> <exception cref="T:System.ArgumentException">The <paramref name="relativeName"/> parameter is an empty string, contains only white space, or contains invalid characters as defined in <see cref="P:Xceed.FileSystem.FileSystemItem.InvalidChars"/>.</exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.GetFile(System.String)"> <summary> Returns an <see cref="T:Xceed.FileSystem.AbstractFile"/> object that represents a file contained in the folder. </summary><param name="relativeName">Relative name of the file to retrieve.</param><returns>An <see cref="T:Xceed.FileSystem.AbstractFile"/> object representing the file named <paramref name="relativeName"/>.</returns><remarks><para> The <paramref name="relativeName"/> parameter can include relative path information, in which ".." means "previous folder". For example: "foo/bar.txt", "../bar.txt", etc. </para><para> This method allows to get a reference to an <see cref="T:Xceed.FileSystem.AbstractFile"/> object for a file that exists, as well as for a file that does not exist. Further, the folder on which this method is called may not exist. </para></remarks><exception cref="T:System.ArgumentException"> The <paramref name="relativeName"/> parameter is an empty string, contains only white space, or contains invalid characters as defined in <see cref="P:Xceed.FileSystem.FileSystemItem.InvalidChars"/>. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.GetFile(Xceed.FileSystem.FileSystemEvents,System.Object,System.String)"> <summary> Returns an <see cref="T:Xceed.FileSystem.AbstractFile"/> object that represents a file contained in the folder and raises events during the process. </summary> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <param name="relativeName">Relative name of the file to retrieve.</param> <returns>An <see cref="T:Xceed.FileSystem.AbstractFile"/> object representing the file named <paramref name="relativeName"/>.</returns> <remarks><para> The <paramref name="relativeName"/> parameter can include relative path information, in which ".." means "previous folder". For example: "foo/bar.txt", "../bar.txt", etc.</para><para> This method allows to get a reference to an <see cref="T:Xceed.FileSystem.AbstractFile"/> object for a file that exists, as well as for a file that does not exist. Further, the folder on which this method is called may not exist.</para></remarks> <exception cref="T:System.ArgumentException">The <paramref name="relativeName"/> parameter is an empty string, contains only white space, or contains invalid characters as defined in <see cref="P:Xceed.FileSystem.FileSystemItem.InvalidChars"/>.</exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.GetFolder(System.String)"> <summary> Returns an <see cref="T:Xceed.FileSystem.AbstractFolder"/> object that represents a folder contained in the folder. </summary><param name="relativeName">Relative name of the folder to retrieve.</param><returns>An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object representing the folder named <paramref name="relativeName"/>.</returns><remarks><para> The <paramref name="relativeName"/> parameter can include relative path information, in which ".." means "previous folder". For example: "foo/bar", "../bar", etc. </para><para> This method allows to get a reference to an <see cref="T:Xceed.FileSystem.AbstractFolder"/> object for a folder that exists, as well as for a folder that does not exist. Further, the folder on which this method is called may not exist. </para></remarks><exception cref="T:System.ArgumentException"> The <paramref name="relativeName"/> parameter is an empty string, contains only white space, or contains invalid characters as defined in <see cref="P:Xceed.FileSystem.FileSystemItem.InvalidChars"/>. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.GetFolder(Xceed.FileSystem.FileSystemEvents,System.Object,System.String)"> <summary> Returns an <see cref="T:Xceed.FileSystem.AbstractFolder"/> object that represents a folder contained in the folder and raises events during the process. </summary> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <param name="relativeName">Relative name of the folder to retrieve.</param> <returns>An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object representing the folder named <paramref name="relativeName"/>.</returns> <remarks><para> The <paramref name="relativeName"/> parameter can include relative path information, in which ".." means "previous folder". For example: "foo/bar", "../bar", etc.</para><para> This method allows to get a reference to an <see cref="T:Xceed.FileSystem.AbstractFolder"/> object for a folder that exists, as well as for a folder that does not exist. Further, the folder on which this method is called may not exist.</para></remarks> <exception cref="T:System.ArgumentException">The <paramref name="relativeName"/> parameter is an empty string, contains only white space, or contains invalid characters as defined in <see cref="P:Xceed.FileSystem.FileSystemItem.InvalidChars"/>.</exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.GetFiles(System.Boolean,System.Object[])"> <summary> Returns a filtered list of files contained in the folder. </summary><param name="recursive"><see langword="true"/> if files contained in the subfolders should be returned; <see langword="false"/> if only files that are immediate children of the folder should be returned.</param><param name="filters">An array of objects that can be used to filter the list of files returned.</param><returns>An array of <see cref="T:Xceed.FileSystem.AbstractFile"/> objects representing the files that match the specified <paramref name="filters"/>.</returns><remarks> <para> To filter a list of files or folders, you can pass a variable number of objects in the <paramref name="filters"/> parameter. These objects may be of the following types: </para><para> <list type="table"> <listheader> <term>Object type</term> <description>Type of filter applied</description> </listheader> <item> <term><see cref="T:System.String"/></term> <description> The string is assumed to be a file mask, and a <see cref="T:Xceed.FileSystem.NameFilter"/> object is automatically created for the passed string, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:System.IO.FileAttributes"/></term> <description> A <see cref="T:Xceed.FileSystem.AttributeFilter"/> object is automatically created for the provided attributes, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:Xceed.FileSystem.Filter"/></term> <description> The provided <see cref="T:Xceed.FileSystem.Filter"/> object is used as-is. </description> </item> <item> <term>Array of <see cref="T:System.Object"/></term> <description> Each object in the array may be of the types described in this table, and is used accordingly. </description> </item> <item> <term>Other</term> <description> If any other type is found, an exception is thrown. </description> </item> </list> </para> </remarks><exception cref="T:System.ArgumentException"> An invalid type was passed in the <paramref name="filters"/> parameter. </exception><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The folder represented by this <see cref="T:Xceed.FileSystem.AbstractFolder"/> does not physically exist. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.GetFiles(Xceed.FileSystem.FileSystemEvents,System.Object,System.Boolean,System.Object[])"> <summary> Returns a filtered list of files contained in the folder, and raises events during the process. </summary><param name="recursive"><see langword="true"/> if files contained in the subfolders should be returned; <see langword="false"/> if only files that are immediate children of the folder should be returned.</param><param name="filters">An array of objects that can be used to filter the list of files returned.</param><returns>An array of <see cref="T:Xceed.FileSystem.AbstractFile"/> objects representing the files that match the specified <paramref name="filters"/>.</returns><param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param><param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param><remarks> <para> To filter a list of files or folders, you can pass a variable number of objects in the <paramref name="filters"/> parameter. These objects may be of the following types: </para><para> <list type="table"> <listheader> <term>Object type</term> <description>Type of filter applied</description> </listheader> <item> <term><see cref="T:System.String"/></term> <description> The string is assumed to be a file mask, and a <see cref="T:Xceed.FileSystem.NameFilter"/> object is automatically created for the passed string, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:System.IO.FileAttributes"/></term> <description> A <see cref="T:Xceed.FileSystem.AttributeFilter"/> object is automatically created for the provided attributes, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:Xceed.FileSystem.Filter"/></term> <description> The provided <see cref="T:Xceed.FileSystem.Filter"/> object is used as-is. </description> </item> <item> <term>Array of <see cref="T:System.Object"/></term> <description> Each object in the array may be of the types described in this table, and is used accordingly. </description> </item> <item> <term>Other</term> <description> If any other type is found, an exception is thrown. </description> </item> </list> </para> </remarks><event cref="F:Xceed.FileSystem.FileSystemEvents.ScanningFolder"> A folder is being scanned for files to be returned. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ItemException"> When an exception occurs while scanning a folder, reports the exception and allows to recover from the exception and continue building the list of files. </event><exception cref="T:System.ArgumentException"> An invalid type was passed in the <paramref name="filters"/> parameter. </exception><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The folder represented by this <see cref="T:Xceed.FileSystem.AbstractFolder"/> does not physically exist. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.GetFolders(System.Boolean,System.Object[])"> <summary> Returns a filtered list of folders contained in the folder. </summary><param name="recursive"><see langword="true"/> if folders contained in the subfolders should be returned; <see langword="false"/> if only folders that are immediate children of the folder should be returned.</param><param name="filters">An array of objects that can be used to filter the list of folders returned.</param><returns>An array of <see cref="T:Xceed.FileSystem.AbstractFolder"/> objects representing the folders that match the specified <paramref name="filters"/>.</returns><remarks> <para> To filter a list of files or folders, you can pass a variable number of objects in the <paramref name="filters"/> parameter. These objects may be of the following types: </para><para> <list type="table"> <listheader> <term>Object type</term> <description>Type of filter applied</description> </listheader> <item> <term><see cref="T:System.String"/></term> <description> The string is assumed to be a file mask, and a <see cref="T:Xceed.FileSystem.NameFilter"/> object is automatically created for the passed string, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:System.IO.FileAttributes"/></term> <description> A <see cref="T:Xceed.FileSystem.AttributeFilter"/> object is automatically created for the provided attributes, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:Xceed.FileSystem.Filter"/></term> <description> The provided <see cref="T:Xceed.FileSystem.Filter"/> object is used as-is. </description> </item> <item> <term>Array of <see cref="T:System.Object"/></term> <description> Each object in the array may be of the types described in this table, and is used accordingly. </description> </item> <item> <term>Other</term> <description> If any other type is found, an exception is thrown. </description> </item> </list> </para><para> Note that when passing a string, for example "folder", as the folder to retrieve in the <paramref name="filters"/> parameter, a <see cref="T:Xceed.FileSystem.NameFilter"/> class will be created around the string. By default, the <see cref="T:Xceed.FileSystem.FilterScope"/> of the <see langword="NameFilter"/> class is <see cref="F:Xceed.FileSystem.FilterScope.File"/>. This means that only files will be filter and <b>all</b> folders will be returned. </para><para> In order to filter folders, a <see cref="T:Xceed.FileSystem.NameFilter"/> class needs to be constructed around the string and the <see cref="T:Xceed.FileSystem.FilterScope"/> must be set to <see cref="F:Xceed.FileSystem.FilterScope.Folder"/>. For example:</para><para><code> GetFolders( true, new NameFilter( "folder", FilterScope.Folder ) ); </code></para> </remarks><exception cref="T:System.ArgumentException"> An invalid type was passed in the <paramref name="filters"/> parameter. </exception><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The folder represented by this <see cref="T:Xceed.FileSystem.AbstractFolder"/> does not physically exist. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.GetFolders(Xceed.FileSystem.FileSystemEvents,System.Object,System.Boolean,System.Object[])"> <summary> Returns a filtered list of folders contained in the folder, and raises events during the process. </summary><param name="recursive"><see langword="true"/> if folders contained in the subfolders should be returned; <see langword="false"/> if only folders that are immediate children of the folder should be returned.</param><param name="filters">An array of objects that can be used to filter the list of folders returned.</param><returns>An array of <see cref="T:Xceed.FileSystem.AbstractFolder"/> objects representing the folders that match the specified <paramref name="filters"/>.</returns><param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param><param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param><remarks> <para> To filter a list of files or folders, you can pass a variable number of objects in the <paramref name="filters"/> parameter. These objects may be of the following types: </para><para> <list type="table"> <listheader> <term>Object type</term> <description>Type of filter applied</description> </listheader> <item> <term><see cref="T:System.String"/></term> <description> The string is assumed to be a file mask, and a <see cref="T:Xceed.FileSystem.NameFilter"/> object is automatically created for the passed string, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:System.IO.FileAttributes"/></term> <description> A <see cref="T:Xceed.FileSystem.AttributeFilter"/> object is automatically created for the provided attributes, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:Xceed.FileSystem.Filter"/></term> <description> The provided <see cref="T:Xceed.FileSystem.Filter"/> object is used as-is. </description> </item> <item> <term>Array of <see cref="T:System.Object"/></term> <description> Each object in the array may be of the types described in this table, and is used accordingly. </description> </item> <item> <term>Other</term> <description> If any other type is found, an exception is thrown. </description> </item> </list> </para><para> Note that when passing a string, for example "folder", as the folder to retrieve in the <paramref name="filters"/> parameter, a <see cref="T:Xceed.FileSystem.NameFilter"/> class will be created around the string. By default, the <see cref="T:Xceed.FileSystem.FilterScope"/> of the <see langword="NameFilter"/> class is <see cref="F:Xceed.FileSystem.FilterScope.File"/>. This means that only files will be filter and <b>all</b> folders will be returned. </para><para> In order to filter folders, a <see cref="T:Xceed.FileSystem.NameFilter"/> class needs to be constructed around the string and the <see cref="T:Xceed.FileSystem.FilterScope"/> must be set to <see cref="F:Xceed.FileSystem.FilterScope.Folder"/>. For example:</para><para><code> GetFolders( true, new NameFilter( "folder", FilterScope.Folder ) ); </code></para> </remarks><event cref="F:Xceed.FileSystem.FileSystemEvents.ScanningFolder"> A folder is being scanned for folders to be returned. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ItemException"> When an exception occurs while scanning a folder, reports the exception and allows to recover from the exception and continue building the list of folders. </event><exception cref="T:System.ArgumentException"> An invalid type was passed in the <paramref name="filters"/> parameter. </exception><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The folder represented by this <see cref="T:Xceed.FileSystem.AbstractFolder"/> does not physically exist. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.GetItems(System.Boolean)"> <summary> Returns a list of items contained in the folder. </summary><param name="recursive"><see langword="true"/> if items contained in the subfolders should be returned; <see langword="false"/> if only items that are immediate children of the folder should be returned.</param><returns>An array of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects representing the items contained in the folder.</returns><remarks> <!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><include file="AbstractFolder.xml" path="AbstractFolder/PublicMethods/GetItems/Common/Remarks/*"/> </remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The folder represented by this <see cref="T:Xceed.FileSystem.AbstractFolder"/> does not physically exist. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.GetItems(Xceed.FileSystem.FileSystemEvents,System.Object,System.Boolean)"> <summary> Returns a list of items contained in the folder, and raises events during the process. </summary><param name="recursive"><see langword="true"/> if items contained in the subfolders should be returned; <see langword="false"/> if only items that are immediate children of the folder should be returned.</param><returns>An array of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects representing the items contained in the folder.</returns><param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param><param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param><remarks> <!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><!-- No matching elements were found for the following include tag --><include file="AbstractFolder.xml" path="AbstractFolder/PublicMethods/GetItems/Common/Remarks/*"/> </remarks><event cref="F:Xceed.FileSystem.FileSystemEvents.ScanningFolder"> A folder is being scanned for items to be returned. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ItemException"> When an exception occurs while scanning a folder, reports the exception and allows to recover from the exception and continue building the list of items. </event><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The folder represented by this <see cref="T:Xceed.FileSystem.AbstractFolder"/> does not physically exist. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.CopyFilesTo(Xceed.FileSystem.AbstractFolder,System.Boolean,System.Boolean,System.Object[])"> <summary> Copies the folder's content to another folder. </summary><param name="destinationFolder">An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object into which the folder's content must be copied. Cannot be <see langword="null"/>.</param><param name="recursive"><see langword="true"/> if the content of the folders contained in the subfolders should be copied; <see langword="false"/> if only the current folder's content should be copied.</param><param name="replaceExistingFiles"><see langword="true"/> if existing files in the destination should be replaced; <see langword="false"/> otherwise.</param><param name="filters">An array of objects that can be used to filter the items to be copied.</param><remarks> <para> If the physical folder specified by <paramref name="destinationFolder"/> does not exist, it is created. </para><para> The folder's content (files and subfolders) that matches the provided <paramref name="filters"/> is immediately copied to the destination. </para><para> When <paramref name="replacingExistingFiles"/> is <see langword="true"/>, any file in the destination that has the same name as a file being copied is automatically replaced. </para><para> When <paramref name="replacingExistingFiles"/> is <see langword="false"/>, an exception is thrown whenever the destination contains a file with the same name as a file being copied. </para><para> To filter a list of files or folders, you can pass a variable number of objects in the <paramref name="filters"/> parameter. These objects may be of the following types: </para><para> <list type="table"> <listheader> <term>Object type</term> <description>Type of filter applied</description> </listheader> <item> <term><see cref="T:System.String"/></term> <description> The string is assumed to be a file mask, and a <see cref="T:Xceed.FileSystem.NameFilter"/> object is automatically created for the passed string, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:System.IO.FileAttributes"/></term> <description> A <see cref="T:Xceed.FileSystem.AttributeFilter"/> object is automatically created for the provided attributes, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:Xceed.FileSystem.Filter"/></term> <description> The provided <see cref="T:Xceed.FileSystem.Filter"/> object is used as-is. </description> </item> <item> <term>Array of <see cref="T:System.Object"/></term> <description> Each object in the array may be of the types described in this table, and is used accordingly. </description> </item> <item> <term>Other</term> <description> If any other type is found, an exception is thrown. </description> </item> </list> </para> </remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The folder represented by this <see cref="T:Xceed.FileSystem.AbstractFolder"/> does not physically exist. </exception><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> One of the destination files already exists, and <paramref name="replaceExistingFiles"/> is <see langword="false"/>. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> One of the destination files already exists, <paramref name="replaceExistingFiles"/> is <see langword="true"/>, but the destination file has the <see langword="ReadOnly"/> attribute. </exception><exception cref="T:Xceed.FileSystem.FileSystemIOException"> The source file could not be read from, or the destination file could not be written to. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.CopyFilesTo(Xceed.FileSystem.FileSystemEvents,System.Object,Xceed.FileSystem.AbstractFolder,System.Boolean,System.Boolean,System.Object[])"> <summary> Copies the folder's content to another folder, and raises events during the process. </summary><param name="destinationFolder">An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object into which the folder's content must be copied. Cannot be <see langword="null"/>.</param><param name="recursive"><see langword="true"/> if the content of the folders contained in the subfolders should be copied; <see langword="false"/> if only the current folder's content should be copied.</param><param name="replaceExistingFiles"><see langword="true"/> if existing files in the destination should be replaced; <see langword="false"/> otherwise.</param><param name="filters">An array of objects that can be used to filter the items to be copied.</param><param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param><param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param><remarks> <para> If the physical folder specified by <paramref name="destinationFolder"/> does not exist, it is created. </para><para> The folder's content (files and subfolders) that matches the provided <paramref name="filters"/> is immediately copied to the destination. </para><para> When <paramref name="replacingExistingFiles"/> is <see langword="true"/>, any file in the destination that has the same name as a file being copied is automatically replaced. </para><para> When <paramref name="replacingExistingFiles"/> is <see langword="false"/>, an exception is thrown whenever the destination contains a file with the same name as a file being copied. </para><para> To filter a list of files or folders, you can pass a variable number of objects in the <paramref name="filters"/> parameter. These objects may be of the following types: </para><para> <list type="table"> <listheader> <term>Object type</term> <description>Type of filter applied</description> </listheader> <item> <term><see cref="T:System.String"/></term> <description> The string is assumed to be a file mask, and a <see cref="T:Xceed.FileSystem.NameFilter"/> object is automatically created for the passed string, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:System.IO.FileAttributes"/></term> <description> A <see cref="T:Xceed.FileSystem.AttributeFilter"/> object is automatically created for the provided attributes, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:Xceed.FileSystem.Filter"/></term> <description> The provided <see cref="T:Xceed.FileSystem.Filter"/> object is used as-is. </description> </item> <item> <term>Array of <see cref="T:System.Object"/></term> <description> Each object in the array may be of the types described in this table, and is used accordingly. </description> </item> <item> <term>Other</term> <description> If any other type is found, an exception is thrown. </description> </item> </list> </para> </remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The folder represented by this <see cref="T:Xceed.FileSystem.AbstractFolder"/> does not physically exist. </exception><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> One of the destination files already exists, and <paramref name="replaceExistingFiles"/> is <see langword="false"/>. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> One of the destination files already exists, <paramref name="replaceExistingFiles"/> is <see langword="true"/>, but the destination file has the <see langword="ReadOnly"/> attribute. </exception><exception cref="T:Xceed.FileSystem.FileSystemIOException"> The source file could not be read from, or the destination file could not be written to. </exception><event cref="F:Xceed.FileSystem.FileSystemEvents.ScanningFolder"> A folder is being scanned for files to be copied. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ItemProgression"> Every time a file is about to be copied, reports how many files have been copied and the total number of files that must be copied. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ByteProgression"> Every 32k, reports how many bytes have been and must be copied for the current file, as well as for the entire set of files that are being copied. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ItemException"> When an exception occurs while copying a file, reports the exception and allows to recover from the exception and continue copying the files. </event> </member> <member name="M:Xceed.FileSystem.AbstractFolder.MoveFilesTo(Xceed.FileSystem.AbstractFolder,System.Boolean,System.Boolean,System.Object[])"> <summary> Moves the folder's content to another folder. </summary><param name="destinationFolder">An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object into which the folder's content must be moved. Cannot be <see langword="null"/>.</param><param name="recursive"><see langword="true"/> if the content of the folders contained in the subfolders should be moved; <see langword="false"/> if only the current folder's content should be moved.</param><param name="replaceExistingFiles"><see langword="true"/> if existing files in the destination should be replaced; <see langword="false"/> otherwise.</param><param name="filters">An array of objects that can be used to filter the items to be moved.</param><remarks> <para> If the physical folder specified by <paramref name="destinationFolder"/> does not exist, it is created. </para><para> The folder's content (files and subfolders) that matches the provided <paramref name="filters"/> is immediately moved to the destination. </para><para> When <paramref name="replacingExistingFiles"/> is <see langword="true"/>, any file in the destination that has the same name as a file being moved is automatically replaced. </para><para> When <paramref name="replacingExistingFiles"/> is <see langword="false"/>, an exception is thrown whenever the destination contains a file with the same name as a file being moved. </para><para> To filter a list of files or folders, you can pass a variable number of objects in the <paramref name="filters"/> parameter. These objects may be of the following types: </para><para> <list type="table"> <listheader> <term>Object type</term> <description>Type of filter applied</description> </listheader> <item> <term><see cref="T:System.String"/></term> <description> The string is assumed to be a file mask, and a <see cref="T:Xceed.FileSystem.NameFilter"/> object is automatically created for the passed string, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:System.IO.FileAttributes"/></term> <description> A <see cref="T:Xceed.FileSystem.AttributeFilter"/> object is automatically created for the provided attributes, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:Xceed.FileSystem.Filter"/></term> <description> The provided <see cref="T:Xceed.FileSystem.Filter"/> object is used as-is. </description> </item> <item> <term>Array of <see cref="T:System.Object"/></term> <description> Each object in the array may be of the types described in this table, and is used accordingly. </description> </item> <item> <term>Other</term> <description> If any other type is found, an exception is thrown. </description> </item> </list> </para> </remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The folder represented by this <see cref="T:Xceed.FileSystem.AbstractFolder"/> does not physically exist. </exception><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> One of the destination files already exists, and <paramref name="replaceExistingFiles"/> is <see langword="false"/>. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> One of the destination files already exists, <paramref name="replaceExistingFiles"/> is <see langword="true"/>, but the destination file has the <see langword="ReadOnly"/> attribute. </exception><exception cref="T:Xceed.FileSystem.FileSystemIOException"> The source file could not be read from, or the destination file could not be written to. </exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.MoveFilesTo(Xceed.FileSystem.FileSystemEvents,System.Object,Xceed.FileSystem.AbstractFolder,System.Boolean,System.Boolean,System.Object[])"> <summary> Moves the folder's content to another folder, and raises events during the process. </summary><param name="destinationFolder">An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object into which the folder's content must be moved. Cannot be <see langword="null"/>.</param><param name="recursive"><see langword="true"/> if the content of the folders contained in the subfolders should be moved; <see langword="false"/> if only the current folder's content should be moved.</param><param name="replaceExistingFiles"><see langword="true"/> if existing files in the destination should be replaced; <see langword="false"/> otherwise.</param><param name="filters">An array of objects that can be used to filter the items to be moved.</param><param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param><param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param><remarks> <para> If the physical folder specified by <paramref name="destinationFolder"/> does not exist, it is created. </para><para> The folder's content (files and subfolders) that matches the provided <paramref name="filters"/> is immediately moved to the destination. </para><para> When <paramref name="replacingExistingFiles"/> is <see langword="true"/>, any file in the destination that has the same name as a file being moved is automatically replaced. </para><para> When <paramref name="replacingExistingFiles"/> is <see langword="false"/>, an exception is thrown whenever the destination contains a file with the same name as a file being moved. </para><para> To filter a list of files or folders, you can pass a variable number of objects in the <paramref name="filters"/> parameter. These objects may be of the following types: </para><para> <list type="table"> <listheader> <term>Object type</term> <description>Type of filter applied</description> </listheader> <item> <term><see cref="T:System.String"/></term> <description> The string is assumed to be a file mask, and a <see cref="T:Xceed.FileSystem.NameFilter"/> object is automatically created for the passed string, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:System.IO.FileAttributes"/></term> <description> A <see cref="T:Xceed.FileSystem.AttributeFilter"/> object is automatically created for the provided attributes, with <see cref="F:Xceed.FileSystem.FilterScope.File"/> as the default FilterScope. </description> </item> <item> <term><see cref="T:Xceed.FileSystem.Filter"/></term> <description> The provided <see cref="T:Xceed.FileSystem.Filter"/> object is used as-is. </description> </item> <item> <term>Array of <see cref="T:System.Object"/></term> <description> Each object in the array may be of the types described in this table, and is used accordingly. </description> </item> <item> <term>Other</term> <description> If any other type is found, an exception is thrown. </description> </item> </list> </para> </remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The folder represented by this <see cref="T:Xceed.FileSystem.AbstractFolder"/> does not physically exist. </exception><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> One of the destination files already exists, and <paramref name="replaceExistingFiles"/> is <see langword="false"/>. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> One of the destination files already exists, <paramref name="replaceExistingFiles"/> is <see langword="true"/>, but the destination file has the <see langword="ReadOnly"/> attribute. </exception><exception cref="T:Xceed.FileSystem.FileSystemIOException"> The source file could not be read from, or the destination file could not be written to. </exception><event cref="F:Xceed.FileSystem.FileSystemEvents.ScanningFolder"> A folder is being scanned for files to be moved. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ItemProgression"> Every time an file is about to be moved, reports how many files have been moved and the total number of files that must be moved. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ByteProgression"> Every 32k, reports how many bytes have been and must be moved for the current file, as well as for the entire set of files that are being moved. </event><event cref="F:Xceed.FileSystem.FileSystemEvents.ItemException"> When an exception occurs while moving a file, reports the exception and allows to recover from the exception and continue moving the files. </event> </member> <member name="M:Xceed.FileSystem.AbstractFolder.DoCopyTo(Xceed.FileSystem.FileSystemEventsSession,Xceed.FileSystem.FileSystemItem,System.Boolean)"> <summary> Copies the folder to another folder. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="destination">An <see cref="T:Xceed.FileSystem.FileSystemItem"/> object into which the folder will be copied. Cannot be <see langword="null"/>.</param> <param name="replaceExistingFiles"><see langword="true"/> if existing items in the destination should be replaced; <see langword="false"/> otherwise.</param> <exception cref="T:Xceed.FileSystem.ItemDoesNotExistException">The physical item does not exist.</exception> <exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException">The source and target folders are the same item.</exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.GetFileFromRelativeName(Xceed.FileSystem.FileSystemEventsSession,System.String)"> <summary> </summary> <param name="session"></param> <param name="relativeName"></param> <returns></returns> </member> <member name="M:Xceed.FileSystem.AbstractFolder.GetFolderFromRelativeName(Xceed.FileSystem.FileSystemEventsSession,System.String)"> <summary> </summary> <param name="session"></param> <param name="relativeName"></param> <returns></returns> </member> <member name="M:Xceed.FileSystem.AbstractFolder.DoGetFiles(Xceed.FileSystem.FileSystemEventsSession,System.Boolean,Xceed.FileSystem.Filter[])"> <summary> Retrieves an array of <see cref="T:Xceed.FileSystem.AbstractFile"/> objects. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="recursive"><see langword="true"/> if items in subfolders should be processed; <see langword="false"/> otherwise.</param> <param name="filters">An array of objects that can be used to filter the list of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to process.</param> <returns>An array of <see cref="T:Xceed.FileSystem.AbstractFile"/> objects representing the files contained within the folder.</returns> </member> <member name="M:Xceed.FileSystem.AbstractFolder.DoGetFolders(Xceed.FileSystem.FileSystemEventsSession,System.Boolean,Xceed.FileSystem.Filter[])"> <summary> Retrieves an array of <see cref="T:Xceed.FileSystem.AbstractFolder"/> objects. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="recursive"><see langword="true"/> if items in subfolders should be processed; <see langword="false"/> otherwise.</param> <param name="filters">An array of objects that can be used to filter the list of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to process.</param> <returns>An array of <see cref="T:Xceed.FileSystem.AbstractFolder"/> objects representing the folders contained within the folder.</returns> </member> <member name="M:Xceed.FileSystem.AbstractFolder.DoGetItems(Xceed.FileSystem.FileSystemEventsSession,System.Boolean)"> <summary> Retrieves an array of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="recursive"><see langword="true"/> if items in subfolders should be processed; <see langword="false"/> otherwise.</param> <returns>An array of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects representing the files and folders contained within the folder.</returns> <exception cref="T:Xceed.FileSystem.ItemDoesNotExistException">The physical item does not exist.</exception> </member> <member name="M:Xceed.FileSystem.AbstractFolder.BuildList(Xceed.FileSystem.FileSystemEventsSession,Xceed.FileSystem.FileSystemItem,System.Boolean,System.Boolean,System.Boolean,Xceed.FileSystem.Filter[])"> <summary> Builds a list of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to process. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="destination">The eventual target for the item that will be procesed. For example, the desination folder for a folder that will be copied.</param> <param name="forward"><see langword="true"/> if folders will be added to the list of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to process first; <see langword="false"/> if files will be added to the list first.</param> <param name="recursive"><see langword="true"/> if items in subfolders should be added to the list of items to process; <see langword="false"/> otherwise.</param> <param name="includeFolders"><see langword="true"/> if folders will be included in the list of items to process; <see langword="false"/> otherwise.</param> <param name="filters">An array of objects that can be used to filter the list of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to process.</param> </member> <member name="M:Xceed.FileSystem.AbstractFolder.DoGetChildItems(Xceed.FileSystem.FileSystemEventsSession)"> <summary> Retrieves an array of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects. This method must be overridden when deriving from this class. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <returns>An array of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects representing the items ( files and folders ) contained within the folder.</returns> </member> <member name="M:Xceed.FileSystem.AbstractFolder.DoGetFile(Xceed.FileSystem.FileSystemEventsSession,System.String)"> <summary> Retrieves a reference to an <see cref="T:Xceed.FileSystem.AbstractFile"/> object. This method must be overridden when deriving from this class. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="fileName">The name of the file to retrieve.</param> <remarks><para><paramref name="fileName"/> should not end with a <see cref="F:System.IO.Path.DirectorySeparatorChar"/>.</para></remarks> <returns>Should return a reference to an <see cref="T:Xceed.FileSystem.AbstractFile"/> object regardless if the file represented by the object exists or not.</returns> </member> <member name="M:Xceed.FileSystem.AbstractFolder.DoGetFolder(Xceed.FileSystem.FileSystemEventsSession,System.String)"> <summary> Retrieves a reference to an <see cref="T:Xceed.FileSystem.AbstractFolder"/> object. This method must be overridden when deriving from this class. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="folderName">The name of the folder to retrieve.</param> <remarks><para><paramref name="folderName"/> should not end with a <see cref="F:System.IO.Path.DirectorySeparatorChar"/>.</para></remarks> <returns>Should return reference to an <see cref="T:Xceed.FileSystem.AbstractFolder"/> object regardless if the folder represented by the object exists or not.</returns> </member> <member name="F:Xceed.FileSystem.AbstractFolder.m_isRoot"> <summary> Identifies if this folder is a root folder. </summary><remarks><para> <b>Notes to inheritors:</b> The constructors of derived classes should set this field to <see langword="true"/> if they represent the root folder. </para></remarks> </member> <member name="P:Xceed.FileSystem.AbstractFolder.IsRoot"> <summary> Gets a value indicating if the folder is a root folder. </summary><value><see langword="true"/> if the folder is a root folder; <see langword="false"/> otherwise.</value><remarks><para> See <see cref="P:Xceed.FileSystem.FileSystemItem.RootFolder"/> for more information about root folders. </para></remarks> </member> <member name="P:Xceed.FileSystem.AbstractFolder.DoIsRoot"> <summary> Gets a boolean value indicating if the folder is a root folder. </summary> <value><see langword="true"/> if the folder represented by the <see cref="T:Xceed.FileSystem.AbstractFolder"/> class is a root folder; <see langword="false"/> otherwise.</value> </member> <member name="T:Xceed.FileSystem.IBatchUpdateable"> <summary> Allows a <see cref="T:Xceed.FileSystem.AbstractFolder"/> object to optimize its updates, by modifying its underlying physical store only once. </summary> <remarks><para> This interface is usually implemented by a root folder. </para></remarks> </member> <member name="M:Xceed.FileSystem.IBatchUpdateable.BeginUpdate"> <summary> Prevents a <see cref="T:Xceed.FileSystem.AbstractFolder"/> object from modifying its underlying physical store until the <see cref="M:Xceed.FileSystem.IBatchUpdateable.EndUpdate"/> method is called. </summary> <remarks><para> A call to <see langword="BeginUpdate"/> <b>must</b> be accompanied by a subsequent call to <see cref="M:Xceed.FileSystem.IBatchUpdateable.EndUpdate"/>, or desynchronization can occur. One mean of making sure that both calls stay synchronized is to use a <see langword="finally"/> block: </para><para> <code> try { i.BeginUpdate(); // Do some modifications to the folder } finally { i.EndUpdate(); } </code> </para><para> In C#, the preferred way is to use the <see cref="T:Xceed.FileSystem.AutoBatchUpdate"/> class in a <see langword="using"/> statement. </para></remarks> </member> <member name="M:Xceed.FileSystem.IBatchUpdateable.BeginUpdate(Xceed.FileSystem.FileSystemEvents,System.Object)"> <summary> Prevents a <see cref="T:Xceed.FileSystem.AbstractFolder"/> object from modifying its underlying physical store until the <see cref="M:Xceed.FileSystem.IBatchUpdateable.EndUpdate"/> method is called and raises events during the process. </summary> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <remarks><para> A call to <see langword="BeginUpdate"/> <b>must</b> be accompanied by a subsequent call to <see cref="M:Xceed.FileSystem.IBatchUpdateable.EndUpdate"/>, or desynchronization can occur. One mean of making sure that both calls stay synchronized is to use a <see langword="finally"/> block: </para><para> <code> try { i.BeginUpdate(); // Do some modifications to the folder } finally { i.EndUpdate(); } </code> </para><para> In C#, the preferred way is to use the <see cref="T:Xceed.FileSystem.AutoBatchUpdate"/> class in a <see langword="using"/> statement. </para></remarks> </member> <member name="M:Xceed.FileSystem.IBatchUpdateable.EndUpdate"> <summary> Informs a <see cref="T:Xceed.FileSystem.AbstractFolder"/> object to apply to its underlying physical store all the modifications that have been made since the call to <see cref="M:Xceed.FileSystem.IBatchUpdateable.BeginUpdate"/>. </summary> <remarks><para> A call to <see langword="EndUpdate"/> <b>must</b> be preceded by a call to <see cref="M:Xceed.FileSystem.IBatchUpdateable.BeginUpdate"/>, or desynchronization can occur. One mean of making sure that both calls stay synchronized is to use a <see langword="finally"/> block: </para><para> <code> try { i.BeginUpdate(); // Do some modifications to the folder } finally { i.EndUpdate(); } </code> </para><para> In C#, the preferred way is to use the <see cref="T:Xceed.FileSystem.AutoBatchUpdate"/> class in a <see langword="using"/> statement. </para></remarks> </member> <member name="M:Xceed.FileSystem.IBatchUpdateable.EndUpdate(Xceed.FileSystem.FileSystemEvents,System.Object)"> <summary> Informs a <see cref="T:Xceed.FileSystem.AbstractFolder"/> object to apply to its underlying physical store all the modifications that have been made since the call to <see cref="M:Xceed.FileSystem.IBatchUpdateable.BeginUpdate"/> and raises events during the process. </summary> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <remarks><para> A call to <see langword="EndUpdate"/> <b>must</b> be preceded by a call to <see cref="M:Xceed.FileSystem.IBatchUpdateable.BeginUpdate"/>, or desynchronization can occur. One mean of making sure that both calls stay synchronized is to use a <see langword="finally"/> block: </para><para> <code> try { i.BeginUpdate(); // Do some modifications to the folder } finally { i.EndUpdate(); } </code> </para><para> In C#, the preferred way is to use the <see cref="T:Xceed.FileSystem.AutoBatchUpdate"/> class in a <see langword="using"/> statement. </para></remarks> </member> <member name="T:Xceed.FileSystem.AutoBatchUpdate"> <summary> Class that verifies if the object implements the <see cref="T:Xceed.FileSystem.IBatchUpdateable"/> interface. </summary> </member> <member name="M:Xceed.FileSystem.AutoBatchUpdate.#ctor(System.Object)"> <summary> Verifies if the object implements the <see cref="T:Xceed.FileSystem.IBatchUpdateable"/> interface. </summary> <param name="batchUpdateable"> object that <b>may or may not</b> implement the <see cref="T:Xceed.FileSystem.IBatchUpdateable"/> interface.</param> <remarks><para> The <see langword="AutoBatchUpdate"/> class will verify if <paramref name="batchUpdateable"/> implements the <see cref="T:Xceed.FileSystem.IBatchUpdateable"/> interface and will automatically call the <see langword="BeginUpdate"/> and <see langword="EndUpdate"/> methods if it does. If <paramref name="batchUpdateable"/> does not implement the <see cref="T:Xceed.FileSystem.IBatchUpdateable"/> interface, the code will be executed normally. </para></remarks> </member> <member name="M:Xceed.FileSystem.AutoBatchUpdate.#ctor(System.Object,Xceed.FileSystem.FileSystemEvents,System.Object)"> <summary> Verifies if the object implements the <see cref="T:Xceed.FileSystem.IBatchUpdateable"/> interface and raises events during the process. </summary> <param name="batchUpdateable">Object that <b>may or may not</b> implement the <see cref="T:Xceed.FileSystem.IBatchUpdateable"/> interface.</param> <param name="events">A <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object that will be used to raise events. Cannot be <see langword="null"/>.</param> <param name="userData">Opaque data that will be passed back to the event handler when an event is raised.</param> <remarks><para> The <see langword="AutoBatchUpdate"/> class will verify if <paramref name="batchUpdateable"/> implements the <see cref="T:Xceed.FileSystem.IBatchUpdateable"/> interface and will automatically call the <see langword="BeginUpdate"/> and <see langword="EndUpdate"/> methods if it does. If <paramref name="batchUpdateable"/> does not implement the <see cref="T:Xceed.FileSystem.IBatchUpdateable"/> interface, the code will be executed normally. </para></remarks> </member> <member name="M:Xceed.FileSystem.AutoBatchUpdate.System#IDisposable#Dispose"> <summary> Calls the <see langword="EndUpdate"/> method on the object that was passed in the construction of the <see langword="AutoBatchUpdateable"/> class. </summary> <remarks><para> The <see langword="EndUpdate"/> method will only be called if the objecy implemented the <see cref="T:Xceed.FileSystem.IBatchUpdateable"/> interface. </para></remarks> </member> <member name="T:Xceed.FileSystem.DiskFile"> <summary> Specialization of the <see cref="T:Xceed.FileSystem.AbstractFile"/> class that implements access to a disk file. </summary> </member> <member name="M:Xceed.FileSystem.DiskFile.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Xceed.FileSystem.DiskFile"/> class with the fully qualified name of an underlying physical file. </summary> <param name="fileName">Fully qualified name of the underlying physical file. This file may or may not physically exist.</param> <remarks><para> The <paramref name="fileName"/> parameter can include relative path information, in which ".." means "previous folder". For example: "foo/bar.txt", "../bar.txt", etc. </para><para> In this context, a name is relative to the current working direcory of the application. </para><para> This method allows to initialize a <see cref="T:Xceed.FileSystem.DiskFile"/> object for a file that exists, as well as for a file that does not exist. </para></remarks> <exception cref="T:System.ArgumentException"> The <paramref name="fileName"/> parameter is an empty string, contains only white space, represents a folder, or contains invalid characters as defined in <see cref="P:Xceed.FileSystem.FileSystemItem.InvalidChars"/>. </exception> </member> <member name="M:Xceed.FileSystem.DiskFile.DoRefresh(Xceed.FileSystem.FileSystemEventsSession)"> <summary> Re-reads the information from the physical item. </summary><remarks><para> When a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object's properties, such as <see cref="P:Xceed.FileSystem.FileSystemItem.Attributes"/> or <see cref="P:Xceed.FileSystem.FileSystemItem.CreationDateTime"/>, are first accessed, a snapshot of the underlying physical item's properties is taken. This snapshot is <b>not</b> automatically updated whenever the physical item's properties change. </para><para> <see langword="Refresh"/> re-reads the information from the physical item and updates the snapshot. </para><para> <b>Note: </b><see langword="Refresh"/> should be called before accessing a property, or the information returned could be outdated. </para></remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The item represented by this <see cref="T:Xceed.FileSystem.FileSystemItem"/> does not physically exist. </exception> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> </member> <member name="M:Xceed.FileSystem.DiskFile.DoDelete(Xceed.FileSystem.FileSystemEventsSession)"> <summary> Permanently deletes the physical item. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <exception cref="T:Xceed.FileSystem.ItemDoesNotExistException">The file does not exist.</exception> <exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException">The file has the <see langword="FileAttributes.ReadOnly"/> attribute set.</exception> </member> <member name="M:Xceed.FileSystem.DiskFile.DoOpenRead(Xceed.FileSystem.FileSystemEventsSession,System.IO.FileShare)"> <summary> Opens the file for reading. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="share">A <see cref="T:System.IO.FileShare"/> constant that determines how the file will be shared by different processes.</param> <remarks><para> The returned stream is guaranteed to be readable, but may or may not be seekable. </para><para> The <paramref name="share"/> parameter allows you to control how the file is shared by different processes.</para></remarks> <returns>A <see cref="T:System.IO.Stream"/> object that can be used to read data from the file.</returns> <exception cref="T:Xceed.FileSystem.ItemDoesNotExistException">The file does not physically exist.</exception> <exception cref="T:Xceed.FileSystem.FileSystemIOException">An error occured while attempting to open the file.</exception> </member> <member name="M:Xceed.FileSystem.DiskFile.DoOpenWrite(Xceed.FileSystem.FileSystemEventsSession,System.Boolean,System.IO.FileShare)"> <summary> Opens the file for writing. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="overwrite"><see langword="true"/> if existing data for the file should be replaced; <see langword="false"/> if existing data should be preserved, appending new data at the end.</param> <param name="share">A <see cref="T:System.IO.FileShare"/> constant that determines how the file will be shared by different processes.</param> <remarks><para> The returned stream is guaranteed to be writable, but may or may not be seekable.</para><para> The <paramref name="share"/> parameter allows you to control how the file is shared by different processes.</para><para> If there is no existing data, the parameter <paramref name="overwrite"/> is ignored.</para></remarks> <returns>A <see cref="T:System.IO.Stream"/> object that can be used to write data to the file.</returns> <exception cref="T:Xceed.FileSystem.ItemDoesNotExistException">The file does not physically exist.</exception> <exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException">The file has the <see langword="FileAttributes.ReadOnly"/> attribute set.</exception> <exception cref="T:Xceed.FileSystem.FileSystemIOException">An error occured while attempting to open the file.</exception> </member> <member name="M:Xceed.FileSystem.DiskFile.DoCreate(Xceed.FileSystem.FileSystemEventsSession)"> <summary> Creates the physical file. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <remarks><para> The file must be created in a folder that exists otherwise an exception will be thrown. </para></remarks> <exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException">The physical file already exists.</exception> </member> <member name="M:Xceed.FileSystem.DiskFile.IsSameAs(Xceed.FileSystem.FileSystemItem)"> <summary> Gets a boolean value indicating if the source and target file are the same. </summary> <param name="target">A <see cref="T:Xceed.FileSystem.FileSystemItem"/> object representing the destination file.</param> <returns><see langword="true"/> if the source and target files are the same; <see langword="false"/> otherwise.</returns> </member> <member name="M:Xceed.FileSystem.DiskFile.IsPathRooted(System.String)"> <summary> Returns a boolean value indicating if the path passed is rooted. </summary> <param name="path">The path to verify.</param> <returns><see langword="true"/> if the path is rooted; <see langword="false"/> otherwise.</returns> </member> <member name="F:Xceed.FileSystem.DiskFile.m_name"> <summary> The current short name for the file. </summary> </member> <member name="F:Xceed.FileSystem.DiskFile.m_fullName"> <summary> The current fully-qualified name for the file. </summary> </member> <member name="F:Xceed.FileSystem.DiskFile.m_attributes"> <summary> The current file attributes for the file. </summary> </member> <member name="F:Xceed.FileSystem.DiskFile.m_creationTime"> <summary> The current creation date and time for the file. </summary> </member> <member name="F:Xceed.FileSystem.DiskFile.m_lastWriteTime"> <summary> The current last modification date and time for the file. </summary> </member> <member name="F:Xceed.FileSystem.DiskFile.m_lastAccessTime"> <summary> The current last access date and time for the file. </summary> </member> <member name="F:Xceed.FileSystem.DiskFile.m_size"> <summary> The current file size in bytes. </summary> </member> <member name="P:Xceed.FileSystem.DiskFile.DoName"> <summary> Gets or sets the short name of the item. </summary><value>A string that represents the short name of the item.</value><remarks><para> The short name consists of the item's name without a path. </para><para> For example, the short name of a file named "c:\foo\bar.txt" is "bar.txt", and the short name of a folder named "c:\foo\" is "foo". </para><para> When assigning a new name to this property, the physical item is immediately renamed if it exists. If it does not exist, the new name is cached and will be applied whenever this item is created. In either cases, if a physical item with the same name already exists, an exception is thrown. </para><para> The short name of an item must <b>not</b> end with a path separator character regardless of whether it represents a file or a folder. </para><para> The separator character is defined in <see cref="F:System.IO.Path.DirectorySeparatorChar"/> and <see cref="F:System.IO.Path.AltDirectorySeparatorChar"/>. </para></remarks><exception cref="T:System.ArgumentException"> The new name assigned to the item is an empty string, contains only white space, contains a path, or contains invalid characters as defined in <see cref="P:Xceed.FileSystem.FileSystemItem.InvalidChars"/>. </exception><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> The new name corresponds to a physical item that already exists. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.DiskFile.DoFullName"> <summary> Gets the full name of the item. </summary><value>A string that represents the full name of the item.</value><remarks><para> The full name consists of the item's name fully-qualified with a path. For example: "c:\foo\bar.txt", "c:\foo\". </para><para> If the item represents a file, its name does <b>not</b> end with a path separator character. </para><para> If the item represents a folder, its name <b>does</b> end with a path separator character. </para><para> The separator character is defined in <see cref="F:System.IO.Path.DirectorySeparatorChar"/> and <see cref="F:System.IO.Path.AltDirectorySeparatorChar"/>. </para></remarks> </member> <member name="P:Xceed.FileSystem.DiskFile.DoAttributes"> <summary> Gets or sets the attributes of the item. </summary><value>A combination of <see cref="T:System.IO.FileAttributes"/> values that represents the attributes of the item.</value><remarks><para> When changing the item's attributes through this property, the physical item is immediately modified if it exists. If it does not exist, the attributes are cached and will be applied whenever this item is created. </para><para> Some types of items may not expose attributes. In this case, an exception is thrown when trying to read or modify the attributes. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated. </para></remarks><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The item does not expose attributes, or does not support one of the assigned attributes. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The physical item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.DiskFile.DoCreationDateTime"> <summary> Gets or sets the creation date and time of the item. </summary><value>The date and time when the item was created.</value><remarks><para> When changing the item's creation date through this property, the physical item is immediately modified if it exists. If it does not exist, the date is cached and will be applied whenever this item is created. </para><para> Some types of items may not expose a creation date and time. In this case, an exception is thrown when trying to read or modify the creation date. </para><para> Other types of items that do expose a creation date and time may not have the information available. In this case, <see cref="F:System.DateTime.MinValue"/> is returned. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated. </para></remarks><exception cref="T:System.ArgumentException"> The provided creation date is not valid for this item. </exception><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The item does not expose a creation date. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The item has the <see langword="ReadOnly"/> attribute, preventing it from being modified. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.DiskFile.DoLastWriteDateTime"> <summary> Gets or sets the modification date and time of the item. </summary><value>The date and time when the item was modified.</value><remarks><para> When changing the item's modification date through this property, the physical item is immediately modified if it exists. If it does not exist, the date is cached and will be applied whenever this item is created. </para><para> Some types of items may not expose a modification date and time. In this case, an exception is thrown when trying to read or modify the modification date. </para><para> Other types of items that do expose a modification date and time may not have the information available. In this case, <see cref="F:System.DateTime.MinValue"/> is returned. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated. </para></remarks><exception cref="T:System.ArgumentException"> The provided modification date is not valid for this item. </exception><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The item does not expose a modification date. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The item has the <see langword="ReadOnly"/> attribute, preventing it from being modified. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.DiskFile.DoLastAccessDateTime"> <summary> Gets or sets the last access date and time of the item. </summary><value>The date and time when the item was last accessed.</value><remarks><para> When changing the item's access date through this property, the physical item is immediately modified if it exists. If it does not exist, the date is cached and will be applied whenever this item is created. </para><para> Some types of items may not expose a last access date and time. In this case, an exception is thrown when trying to read or modify the access date. </para><para> Other types of items that do expose a last access date and time may not have the information available. In this case, <see cref="F:System.DateTime.MinValue"/> is returned. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated. </para></remarks><exception cref="T:System.ArgumentException"> The provided last access date is not valid for this item. </exception><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The item does not expose a last access date. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The item has the <see langword="ReadOnly"/> attribute, preventing it from being modified. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The physical item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.DiskFile.DoParentFolder"> <summary> Gets a reference to the parent folder of this item. </summary><value>An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object that represents the folder that contains the item, or <see langword="null"/> if the item does not have a parent.</value><remarks><para> If the current item is the root of a folder hierarchy, it has no parent folder. In this case, the <see langword="ParentFolder"/> property returns <see langword="null"/>. </para></remarks> </member> <member name="P:Xceed.FileSystem.DiskFile.DoRootFolder"> <summary> Gets a reference to the root folder of this item. </summary><value>An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object that represents the folder at the root of the path of this item, or <see langword="null"/> if a root folder is not available.</value><remarks><para> A root folder represents the starting point of a folder hierarchy. On a physical disk, it is usually represented by a drive letter ("C:\") or UNC root ("\\server\share\"). </para><para> Some specializations of the <see cref="T:Xceed.FileSystem.AbstractFolder"/> class may define a specialized class that represents a root folder, exposing properties and methods that apply only to a root. </para><para> Therefore, the <see langword="RootFolder"/> property may return an <see cref="T:Xceed.FileSystem.AbstractFolder"/> instance that is in fact a specialized class representing the root. </para><para> If the current item is the root of a folder hierarchy, the <see langword="RootFolder"/> property returns a reference to itself, or a reference to a specialized object that represents the root folder with more details. </para><para> If a root folder is not available, the <see langword="RootFolder"/> property returns <see langword="null"/>. </para></remarks> </member> <member name="P:Xceed.FileSystem.DiskFile.DoExists"> <summary> Gets a boolean value indicating if the item physically exists. </summary><value><see langword="true"/> if the item physically exists; <see langword="false"/> otherwise.</value><remarks><para> This property should be evaluated before calling a method that needs to access the underlying physical item (For example, <see cref="M:Xceed.FileSystem.FileSystemItem.CopyTo(Xceed.FileSystem.AbstractFolder,System.Boolean)"/>), otherwise these methods will throw an exception. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> does <b>not</b> need to be called before accessing this property. The property will always reflect the physical item's existence. </para></remarks> </member> <member name="P:Xceed.FileSystem.DiskFile.DoSize"> <summary> Gets the size of the file in bytes. </summary><value>A value representing the file size in bytes.</value><remarks><para> Some types of files may not have the size information available. In this case, <see langword="-1"/> is returned. </para><para> If the file does not physically exist, an exception is thrown. </para> <para><b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated.</para></remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The file represented by this <see cref="T:Xceed.FileSystem.AbstractFile"/> does not physically exist. </exception> </member> <member name="T:Xceed.FileSystem.DiskFolder"> <summary> Specialization of the <see cref="T:Xceed.FileSystem.AbstractFolder"/> class that implements access to a disk folder. </summary> </member> <member name="M:Xceed.FileSystem.DiskFolder.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Xceed.FileSystem.DiskFolder"/> class with the fully qualified name of an underlying physical folder. </summary> <param name="folderName">Fully qualified name of the underlying physical folder. This folder may or may not physically exist.</param> <remarks><para> The <paramref name="folderName"/> parameter can include relative path information, in which ".." means "previous folder". For example: "foo/bar", "../bar", etc. </para><para> In this context, a name is relative to the current working direcory of the application. </para><para> This method allows to initialize a <see cref="T:Xceed.FileSystem.DiskFolder"/> object for a folder that exists, as well as for a folder that does not exist. </para></remarks> <exception cref="T:System.ArgumentException"> The <paramref name="folderName"/> parameter is an empty string, contains only white space, represents a file, or contains invalid characters as defined in <see cref="P:Xceed.FileSystem.FileSystemItem.InvalidChars"/>. </exception> </member> <member name="M:Xceed.FileSystem.DiskFolder.DoGetChildItems(Xceed.FileSystem.FileSystemEventsSession)"> <summary> Retrieves an array of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <returns>An array of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects representing the items ( files and folders ) contained within the folder.</returns> </member> <member name="M:Xceed.FileSystem.DiskFolder.DoDelete(Xceed.FileSystem.FileSystemEventsSession)"> <summary> Permanently deletes the physical folder. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <exception cref="T:Xceed.FileSystem.ItemDoesNotExistException">The physical folder does exist.</exception> <exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException">The physical folder is read-only.</exception> </member> <member name="M:Xceed.FileSystem.DiskFolder.DoCreate(Xceed.FileSystem.FileSystemEventsSession)"> <summary> Creates the physical folder. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <remarks><para> The folder must be created in a folder that exists otherwise an exception will be thrown. </para></remarks> <exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException">The physical folder already exists.</exception> </member> <member name="M:Xceed.FileSystem.DiskFolder.DoRefresh(Xceed.FileSystem.FileSystemEventsSession)"> <summary> Re-reads the information from the physical item. </summary><remarks><para> When a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object's properties, such as <see cref="P:Xceed.FileSystem.FileSystemItem.Attributes"/> or <see cref="P:Xceed.FileSystem.FileSystemItem.CreationDateTime"/>, are first accessed, a snapshot of the underlying physical item's properties is taken. This snapshot is <b>not</b> automatically updated whenever the physical item's properties change. </para><para> <see langword="Refresh"/> re-reads the information from the physical item and updates the snapshot. </para><para> <b>Note: </b><see langword="Refresh"/> should be called before accessing a property, or the information returned could be outdated. </para></remarks><exception cref="T:Xceed.FileSystem.ItemDoesNotExistException"> The item represented by this <see cref="T:Xceed.FileSystem.FileSystemItem"/> does not physically exist. </exception> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> </member> <member name="M:Xceed.FileSystem.DiskFolder.DoGetFile(Xceed.FileSystem.FileSystemEventsSession,System.String)"> <summary> Retrieves a reference to an <see cref="T:Xceed.FileSystem.AbstractFile"/> object. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="fileName">The name of the file to retrieve.</param> <remarks><para><paramref name="fileName"/> should not end with a <see cref="F:System.IO.Path.DirectorySeparatorChar"/>.</para></remarks> <returns>A reference to an <see cref="T:Xceed.FileSystem.AbstractFile"/> object regardless of if the file represented by the object exists or not.</returns> </member> <member name="M:Xceed.FileSystem.DiskFolder.DoGetFolder(Xceed.FileSystem.FileSystemEventsSession,System.String)"> <summary> Retrieves a reference to an <see cref="T:Xceed.FileSystem.AbstractFolder"/> object. </summary> <param name="session">A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object which is responsible for raising all events that occur during the process.</param> <param name="folderName">The name of the folder to retrieve.</param> <remarks><para><paramref name="folderName"/> should not end with a <see cref="F:System.IO.Path.DirectorySeparatorChar"/>.</para></remarks> <returns>A reference to an <see cref="T:Xceed.FileSystem.AbstractFolder"/> object regardless of if the folder represented by the object exists or not.</returns> </member> <member name="M:Xceed.FileSystem.DiskFolder.IsSameAs(Xceed.FileSystem.FileSystemItem)"> <summary> Returns a boolean value indicating if the source and target items are the same. </summary> <param name="target">A <see cref="T:Xceed.FileSystem.FileSystemItem"/> object representing the destination item.</param> <returns><see langword="true"/> if the source and target <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects are the same; <see langword="false"/> otherwise.</returns> </member> <member name="M:Xceed.FileSystem.DiskFolder.IsPathRooted(System.String)"> <summary> Returns a boolean value indicating if the path passed is rooted. </summary> <param name="path">The path to verify.</param> <returns><see langword="true"/> if the path is rooted; <see langword="false"/> otherwise.</returns> </member> <member name="F:Xceed.FileSystem.DiskFolder.m_name"> <summary> The current short name for the folder. </summary> </member> <member name="F:Xceed.FileSystem.DiskFolder.m_fullName"> <summary> The current fully qualified name for the folder. Should always end with a <see cref="F:System.IO.Path.DirectorySeparatorChar"/>. </summary> </member> <member name="F:Xceed.FileSystem.DiskFolder.m_fullNameForIO"> <summary> The current fully qualified name for the folder minus the Path.DirectorySeparatorChar at the end. Used for certain methods of the System.IO Namespace. </summary> </member> <member name="F:Xceed.FileSystem.DiskFolder.m_attributes"> <summary> The current file attributes for the folder. </summary> </member> <member name="F:Xceed.FileSystem.DiskFolder.m_creationTime"> <summary> The current creation date and time for the folder. </summary> </member> <member name="F:Xceed.FileSystem.DiskFolder.m_lastWriteTime"> <summary> The current last modification date and time for the folder. </summary> </member> <member name="F:Xceed.FileSystem.DiskFolder.m_lastAccessTime"> <summary> The current last access date and time for the folder. </summary> </member> <member name="P:Xceed.FileSystem.DiskFolder.DoName"> <summary> Gets or sets the short name of the item. </summary><value>A string that represents the short name of the item.</value><remarks><para> The short name consists of the item's name without a path. </para><para> For example, the short name of a file named "c:\foo\bar.txt" is "bar.txt", and the short name of a folder named "c:\foo\" is "foo". </para><para> When assigning a new name to this property, the physical item is immediately renamed if it exists. If it does not exist, the new name is cached and will be applied whenever this item is created. In either cases, if a physical item with the same name already exists, an exception is thrown. </para><para> The short name of an item must <b>not</b> end with a path separator character regardless of whether it represents a file or a folder. </para><para> The separator character is defined in <see cref="F:System.IO.Path.DirectorySeparatorChar"/> and <see cref="F:System.IO.Path.AltDirectorySeparatorChar"/>. </para></remarks><exception cref="T:System.ArgumentException"> The new name assigned to the item is an empty string, contains only white space, contains a path, or contains invalid characters as defined in <see cref="P:Xceed.FileSystem.FileSystemItem.InvalidChars"/>. </exception><exception cref="T:Xceed.FileSystem.ItemAlreadyExistsException"> The new name corresponds to a physical item that already exists. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.DiskFolder.DoFullName"> <summary> Gets the full name of the item. </summary><value>A string that represents the full name of the item.</value><remarks><para> The full name consists of the item's name fully-qualified with a path. For example: "c:\foo\bar.txt", "c:\foo\". </para><para> If the item represents a file, its name does <b>not</b> end with a path separator character. </para><para> If the item represents a folder, its name <b>does</b> end with a path separator character. </para><para> The separator character is defined in <see cref="F:System.IO.Path.DirectorySeparatorChar"/> and <see cref="F:System.IO.Path.AltDirectorySeparatorChar"/>. </para></remarks> </member> <member name="P:Xceed.FileSystem.DiskFolder.DoAttributes"> <summary> Gets or sets the attributes of the item. </summary><value>A combination of <see cref="T:System.IO.FileAttributes"/> values that represents the attributes of the item.</value><remarks><para> When changing the item's attributes through this property, the physical item is immediately modified if it exists. If it does not exist, the attributes are cached and will be applied whenever this item is created. </para><para> Some types of items may not expose attributes. In this case, an exception is thrown when trying to read or modify the attributes. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated. </para></remarks><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The item does not expose attributes, or does not support one of the assigned attributes. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The physical item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.DiskFolder.DoCreationDateTime"> <summary> Gets or sets the creation date and time of the item. </summary><value>The date and time when the item was created.</value><remarks><para> When changing the item's creation date through this property, the physical item is immediately modified if it exists. If it does not exist, the date is cached and will be applied whenever this item is created. </para><para> Some types of items may not expose a creation date and time. In this case, an exception is thrown when trying to read or modify the creation date. </para><para> Other types of items that do expose a creation date and time may not have the information available. In this case, <see cref="F:System.DateTime.MinValue"/> is returned. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated. </para></remarks><exception cref="T:System.ArgumentException"> The provided creation date is not valid for this item. </exception><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The item does not expose a creation date. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The item has the <see langword="ReadOnly"/> attribute, preventing it from being modified. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.DiskFolder.DoLastWriteDateTime"> <summary> Gets or sets the modification date and time of the item. </summary><value>The date and time when the item was modified.</value><remarks><para> When changing the item's modification date through this property, the physical item is immediately modified if it exists. If it does not exist, the date is cached and will be applied whenever this item is created. </para><para> Some types of items may not expose a modification date and time. In this case, an exception is thrown when trying to read or modify the modification date. </para><para> Other types of items that do expose a modification date and time may not have the information available. In this case, <see cref="F:System.DateTime.MinValue"/> is returned. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated. </para></remarks><exception cref="T:System.ArgumentException"> The provided modification date is not valid for this item. </exception><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The item does not expose a modification date. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The item has the <see langword="ReadOnly"/> attribute, preventing it from being modified. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.DiskFolder.DoLastAccessDateTime"> <summary> Gets or sets the last access date and time of the item. </summary><value>The date and time when the item was last accessed.</value><remarks><para> When changing the item's access date through this property, the physical item is immediately modified if it exists. If it does not exist, the date is cached and will be applied whenever this item is created. </para><para> Some types of items may not expose a last access date and time. In this case, an exception is thrown when trying to read or modify the access date. </para><para> Other types of items that do expose a last access date and time may not have the information available. In this case, <see cref="F:System.DateTime.MinValue"/> is returned. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> should be called before accessing this property, or the information returned could be outdated. </para></remarks><exception cref="T:System.ArgumentException"> The provided last access date is not valid for this item. </exception><exception cref="T:Xceed.FileSystem.FileSystemNotSupportedException"> The item does not expose a last access date. </exception><exception cref="T:Xceed.FileSystem.ItemIsReadOnlyException"> The item has the <see langword="ReadOnly"/> attribute, preventing it from being modified. </exception><exception cref="T:Xceed.FileSystem.ItemIsRootFolderException"> The physical item is a root folder. </exception> </member> <member name="P:Xceed.FileSystem.DiskFolder.DoParentFolder"> <summary> Gets a reference to the parent folder of this item. </summary><value>An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object that represents the folder that contains the item, or <see langword="null"/> if the item does not have a parent.</value><remarks><para> If the current item is the root of a folder hierarchy, it has no parent folder. In this case, the <see langword="ParentFolder"/> property returns <see langword="null"/>. </para></remarks> </member> <member name="P:Xceed.FileSystem.DiskFolder.DoRootFolder"> <summary> Gets a reference to the parent folder of this item. </summary><value>An <see cref="T:Xceed.FileSystem.AbstractFolder"/> object that represents the folder that contains the item, or <see langword="null"/> if the item does not have a parent.</value><remarks><para> If the current item is the root of a folder hierarchy, it has no parent folder. In this case, the <see langword="ParentFolder"/> property returns <see langword="null"/>. </para></remarks> </member> <member name="P:Xceed.FileSystem.DiskFolder.DoExists"> <summary> Gets a boolean value indicating if the item physically exists. </summary><value><see langword="true"/> if the item physically exists; <see langword="false"/> otherwise.</value><remarks><para> This property should be evaluated before calling a method that needs to access the underlying physical item (For example, <see cref="M:Xceed.FileSystem.FileSystemItem.CopyTo(Xceed.FileSystem.AbstractFolder,System.Boolean)"/>), otherwise these methods will throw an exception. </para><para> <b>Note: </b><see cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> does <b>not</b> need to be called before accessing this property. The property will always reflect the physical item's existence. </para></remarks> </member> <member name="T:Xceed.FileSystem.FileSystemEventArgs"> <summary> The base class for argument classes used by all events. </summary> </member> <member name="M:Xceed.FileSystem.FileSystemEventArgs.#ctor"> <summary> Creates a new instance of the FileSystemEventArgs class. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventArgs.m_userData"> <summary> Opaque data that is sent back to the event handler when an event is raised. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventArgs.m_currentItem"> <summary> The current <see cref="T:Xceed.FileSystem.FileSystemItem"/> object being processed. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventArgs.m_targetItem"> <summary> The current target <see cref="T:Xceed.FileSystem.FileSystemItem"/> object of the process. </summary> </member> <member name="P:Xceed.FileSystem.FileSystemEventArgs.UserData"> <summary> Gets or sets the opaque data that will be sent back to the event handler whenever an event is raised. </summary> <value>Opaque data that is sent back to the event handler.</value> </member> <member name="P:Xceed.FileSystem.FileSystemEventArgs.CurrentItem"> <summary> Gets or sets the current <see cref="T:Xceed.FileSystem.FileSystemItem"/> object being processed. </summary> <value>A reference to a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object.</value> </member> <member name="P:Xceed.FileSystem.FileSystemEventArgs.TargetItem"> <summary> Gets or sets the destination <see cref="T:Xceed.FileSystem.FileSystemItem"/> object. </summary> <value>A reference to the eventual target <see cref="T:Xceed.FileSystem.FileSystemItem"/> object.</value> </member> <member name="T:Xceed.FileSystem.ProgressionInfo"> <summary> Class which provides progression information for progression events. </summary> </member> <member name="M:Xceed.FileSystem.ProgressionInfo.#ctor"> <summary> Creates a new instance of the ProgressionInfo class. </summary> </member> <member name="F:Xceed.FileSystem.ProgressionInfo.m_processed"> <summary> The amount of bytes or items processed. </summary> </member> <member name="F:Xceed.FileSystem.ProgressionInfo.m_total"> <summary> The total amount of bytes or items to process. </summary> </member> <member name="P:Xceed.FileSystem.ProgressionInfo.Processed"> <summary> Gets or sets the number of bytes or <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects processed so far. </summary> <value>A value indicating the number of bytes or <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects processed so far.</value> </member> <member name="P:Xceed.FileSystem.ProgressionInfo.Total"> <summary> Gets or sets the total number of bytes or <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to be processed. </summary> <value>A value indicating the number of bytes or <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to be processed.</value> </member> <member name="P:Xceed.FileSystem.ProgressionInfo.Percent"> <summary> Gets the ratio (percentage) of bytes or <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects processed so far. </summary> <value>A value indicating the ratio of bytes or <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects processed so far.</value> </member> <member name="T:Xceed.FileSystem.ByteProgressionEventArgs"> <summary> Argument class that provides byte progression information. </summary> </member> <member name="M:Xceed.FileSystem.ByteProgressionEventArgs.#ctor(Xceed.FileSystem.ProgressionInfo,Xceed.FileSystem.ProgressionInfo)"> <summary> Creates a new instance of the ByteProgressionEventArgs argument class. </summary> <param name="currentFileBytes">The size, in bytes, of the file currently being processed.</param> <param name="allFilesBytes">The total combined size, in bytes, of all files being processed.</param> </member> <member name="F:Xceed.FileSystem.ByteProgressionEventArgs.m_currentFileBytes"> <summary> An instance of the ProgressionInfo class representing the byte count information in regards to the current item being processed. </summary> </member> <member name="F:Xceed.FileSystem.ByteProgressionEventArgs.m_allFilesBytes"> <summary> An instance of the ProgressionInfo class representing the byte count information in regards to all the items to be processed. </summary> </member> <member name="P:Xceed.FileSystem.ByteProgressionEventArgs.CurrentFileBytes"> <summary> Gets the size, in bytes, of the file currently being processed. </summary> <value>A value indicating the size, in bytes, of the file being processed.</value> </member> <member name="P:Xceed.FileSystem.ByteProgressionEventArgs.AllFilesBytes"> <summary> Gets the total combined size, in bytes, of all files being processed. </summary> <value>A value indicating the size, in bytes, of all the files being processed.</value> </member> <member name="T:Xceed.FileSystem.ItemProgressionEventArgs"> <summary> Argument class that provides item progression information. </summary> </member> <member name="M:Xceed.FileSystem.ItemProgressionEventArgs.#ctor(Xceed.FileSystem.ProgressionInfo)"> <summary> Creates an new instance of the ItemProgressionEventArgs argument class. </summary> <param name="allItems">The total number of items being processed.</param> </member> <member name="F:Xceed.FileSystem.ItemProgressionEventArgs.m_allItems"> <summary> An instance of the ProgressionInfo class representing the item count information. </summary> </member> <member name="P:Xceed.FileSystem.ItemProgressionEventArgs.AllItems"> <summary> Gets the total number of items being processed. </summary> <value>A value indicating the number if items being processed.</value> </member> <member name="T:Xceed.FileSystem.ByteProgressionEventHandler"> <summary> Represents the method that will handle the <see cref="F:Xceed.FileSystem.FileSystemEvents.ByteProgression"/> event. </summary> <param name="sender">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> on which the method was called.</param> <param name="e">An instance of the <see cref="T:Xceed.FileSystem.ByteProgressionEventArgs"/> argument class that contains progression information.</param> </member> <member name="T:Xceed.FileSystem.ItemProgressionEventHandler"> <summary> Represents the method that will handle the <see cref="F:Xceed.FileSystem.FileSystemEvents.ItemProgression"/> event. </summary> <param name="sender">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> on which the method was called.</param> <param name="e">An instance of the <see cref="T:Xceed.FileSystem.ItemProgressionEventArgs"/> argument class that contains progression information.</param> </member> <member name="T:Xceed.FileSystem.ScanningFolderEventArgs"> <summary> Argument class that provides information on the folder being scanned or accessed. </summary> </member> <member name="M:Xceed.FileSystem.ScanningFolderEventArgs.#ctor"> <summary> Creates a new instance of the ScanningFolderEventArgs argument class. </summary> </member> <member name="T:Xceed.FileSystem.ScanningFolderEventHandler"> <summary> Represents the method that will handle the <see cref="F:Xceed.FileSystem.FileSystemEvents.ScanningFolder"/> event. </summary> <param name="sender">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> on which the method was called.</param> <param name="e">An instance of the <see cref="T:Xceed.FileSystem.ScanningFolderEventArgs"/> argument class that contains progression information.</param> </member> <member name="T:Xceed.FileSystem.ItemExceptionAction"> <summary> Specifies the action taken when an exception is thrown during the processing of a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object. </summary> </member> <member name="F:Xceed.FileSystem.ItemExceptionAction.Abort"> <summary>The entire process will be aborted and the exception will be thrown.</summary> </member> <member name="F:Xceed.FileSystem.ItemExceptionAction.Retry"> <summary>Retry processing the item. A corrective action <b>must</b> be taken otherwise the same exception will be rethrown.</summary> </member> <member name="F:Xceed.FileSystem.ItemExceptionAction.Ignore"> <summary>Ignore the item that caused the error and continue processing the other items.</summary> </member> <member name="T:Xceed.FileSystem.ItemExceptionEventArgs"> <summary> Argument class that provides information on the exception that was thrown during a process. </summary> </member> <member name="M:Xceed.FileSystem.ItemExceptionEventArgs.#ctor"> <summary> Creates a new instance of the ItemExceptionEventArgs argument class. </summary> </member> <member name="F:Xceed.FileSystem.ItemExceptionEventArgs.m_exception"> <summary> An instance of the Exception class representing the exception that was thrown and caused the OnItemException event to be raised. </summary> </member> <member name="F:Xceed.FileSystem.ItemExceptionEventArgs.m_action"> <summary> An instance of the ItemExceptionAction class representing the action that will be taken in the OnItemException event handler. </summary> </member> <member name="P:Xceed.FileSystem.ItemExceptionEventArgs.Exception"> <summary> Gets or sets the exception that was thrown. </summary> <value>A reference to a <see cref="T:Xceed.FileSystem.FileSystemException"/> object.</value> </member> <member name="P:Xceed.FileSystem.ItemExceptionEventArgs.Action"> <summary> Gets or sets the action taken when an exception is thrown during the processing of a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object. </summary> <value>A value indicating the action taken when an exception is thrown</value> </member> <member name="T:Xceed.FileSystem.ItemExceptionEventHandler"> <summary> Represents the method that will handle the <see cref="F:Xceed.FileSystem.FileSystemEvents.ItemException"/> event. </summary> <param name="sender">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> on which the method was called.</param> <param name="e">An instance of the <see cref="T:Xceed.FileSystem.ItemExceptionEventArgs"/> argument class that contains progression information.</param> </member> <member name="T:Xceed.FileSystem.FileSystemEvents"> <summary> Class that dispatches events raised from methods called on <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects or objects that derive from the <see cref="T:Xceed.FileSystem.FileSystemItem"/> class. </summary> <remarks><para> This class serves as a central point of access to associate event handlers with method calls, for methods that need to raise events. </para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemEvents.CreateSession(System.Object,System.Object)"> <summary> Creates a new session from a <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object. </summary> <param name="sender">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object from which the session is created.</param> <param name="userData">Opaque data that is sent back to the event handler when an event is raised.</param> <returns>A reference to a <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> object.</returns> </member> <member name="M:Xceed.FileSystem.FileSystemEvents.BeginSubOperation"> <summary> Called when a sub-operation is begun within a process. </summary> <remarks><para>Increments the sub-operation counter.</para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemEvents.EndSubOperation"> <summary> Called when a sub-operation is ended within a process. </summary> <remarks><para>Decrements the sub-operation counter.</para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemEvents.OnByteProgression(System.Object,Xceed.FileSystem.ByteProgressionEventArgs)"> <summary> Calls the delegated <see cref="M:Xceed.FileSystem.FileSystemEvents.OnByteProgression(System.Object,Xceed.FileSystem.ByteProgressionEventArgs)"/> event handler. </summary> <param name="sender">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> on which the method was called.</param> <param name="e">An instance of the <see cref="T:Xceed.FileSystem.ByteProgressionEventArgs"/> argument class that contains byte progression information.</param> <remarks><para>It is not necessary to override this method.</para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemEvents.OnItemProgression(System.Object,Xceed.FileSystem.ItemProgressionEventArgs)"> <summary> Calls the delegated <see cref="M:Xceed.FileSystem.FileSystemEvents.OnItemProgression(System.Object,Xceed.FileSystem.ItemProgressionEventArgs)"/> event handler. </summary> <param name="sender">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> on which the method was called.</param> <param name="e">An instance of the <see cref="T:Xceed.FileSystem.ItemProgressionEventArgs"/> argument class that contains item progression information.</param> <remarks><para>It is not necessary to override this method.</para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemEvents.OnScanningFolder(System.Object,Xceed.FileSystem.ScanningFolderEventArgs)"> <summary> Calls the delegated <see cref="M:Xceed.FileSystem.FileSystemEvents.OnScanningFolder(System.Object,Xceed.FileSystem.ScanningFolderEventArgs)"/> event handler. </summary> <param name="sender">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> on which the method was called.</param> <param name="e">An instance of the <see cref="T:Xceed.FileSystem.ScanningFolderEventArgs"/> argument class that contains information on the folder being scanned.</param> <remarks><para>It is not necessary to override this method.</para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemEvents.OnItemException(System.Object,Xceed.FileSystem.ItemExceptionEventArgs)"> <summary> Calls the delegated <see cref="M:Xceed.FileSystem.FileSystemEvents.OnItemException(System.Object,Xceed.FileSystem.ItemExceptionEventArgs)"/> event handler. </summary> <param name="sender">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> on which the method was called.</param> <param name="e">An instance of the <see cref="T:Xceed.FileSystem.ItemExceptionEventArgs"/> argument class that contains information on the exception that was raised.</param> <remarks><para>It is not necessary to override this method.</para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemEvents.ValidateParams(System.Object,Xceed.FileSystem.FileSystemEventArgs)"> <summary> Verifies the validity of the parameters sent to the event handlers. </summary> <param name="sender">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> on which the method was called.</param> <param name="e">An instance of the <see cref="T:Xceed.FileSystem.FileSystemEventArgs"/> argument class.</param> </member> <member name="F:Xceed.FileSystem.FileSystemEvents.m_subOperationCount"> <summary> Sub-operation counter which keeps a reference count on the amount of sub-operations within a process. </summary> </member> <member name="E:Xceed.FileSystem.FileSystemEvents.ScanningFolder"> <summary> Raised when an <see cref="T:Xceed.FileSystem.AbstractFolder"/> object is accessed or is scanned for matching items while building a list of items to process. </summary> </member> <member name="E:Xceed.FileSystem.FileSystemEvents.ItemProgression"> <summary> Raised every time a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object is <b>about to be processed</b>, providing progression information to the event handler. </summary> </member> <member name="E:Xceed.FileSystem.FileSystemEvents.ByteProgression"> <summary> Raised for every 64k of bytes processed when a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object is being processed. </summary> </member> <member name="E:Xceed.FileSystem.FileSystemEvents.ItemException"> <summary> Raised when an exception is caught during the processing of a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object, allowing the handler to decide the action to take. </summary> </member> <member name="P:Xceed.FileSystem.FileSystemEvents.WantsScanningFolder"> <summary> Gets a boolean value indicating if the <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object has subscribed to the <see cref="M:Xceed.FileSystem.FileSystemEvents.OnScanningFolder(System.Object,Xceed.FileSystem.ScanningFolderEventArgs)"/> event. </summary> <value><see langword="true"/> if the <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object has subscribed to the <see cref="M:Xceed.FileSystem.FileSystemEvents.OnScanningFolder(System.Object,Xceed.FileSystem.ScanningFolderEventArgs)"/> event; <see langword="false"/> otherwise.</value> <remarks><para>It is not necessary to override this method.</para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemEvents.WantsItemProgression"> <summary> Gets a boolean value indicating if the <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object has subscribed to the <see cref="M:Xceed.FileSystem.FileSystemEvents.OnItemProgression(System.Object,Xceed.FileSystem.ItemProgressionEventArgs)"/> event. </summary> <value><see langword="true"/> if the <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object has subscribed to the <see cref="M:Xceed.FileSystem.FileSystemEvents.OnItemProgression(System.Object,Xceed.FileSystem.ItemProgressionEventArgs)"/> event; <see langword="false"/> otherwise.</value> <remarks><para>It is not necessary to override this method.</para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemEvents.WantsByteProgression"> <summary> Gets a boolean value indicating if the <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object has subscribed to the <see cref="M:Xceed.FileSystem.FileSystemEvents.OnByteProgression(System.Object,Xceed.FileSystem.ByteProgressionEventArgs)"/> event. </summary> <value><see langword="true"/> if the <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object has subscribed to the <see cref="M:Xceed.FileSystem.FileSystemEvents.OnByteProgression(System.Object,Xceed.FileSystem.ByteProgressionEventArgs)"/> event; <see langword="false"/> otherwise.</value> <remarks><para>It is not necessary to override this method.</para></remarks> </member> <member name="P:Xceed.FileSystem.FileSystemEvents.WantsItemException"> <summary> Gets a boolean value indicating if the <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object has subscribed to the <see cref="M:Xceed.FileSystem.FileSystemEvents.OnItemException(System.Object,Xceed.FileSystem.ItemExceptionEventArgs)"/> event. </summary> <value><see langword="true"/> if the <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object has subscribed to the <see cref="M:Xceed.FileSystem.FileSystemEvents.OnItemException(System.Object,Xceed.FileSystem.ItemExceptionEventArgs)"/> event; <see langword="false"/> otherwise.</value> <remarks><para>It is not necessary to override this method.</para></remarks> </member> <member name="T:Xceed.FileSystem.FileSystemEventsSession"> <summary> Class which holds information about the session which is responsible for raising all events that occur during the process. </summary> </member> <member name="M:Xceed.FileSystem.FileSystemEventsSession.#ctor(Xceed.FileSystem.FileSystemEvents,System.Object,System.Object)"> <summary> Creates a new instance of the <see cref="T:Xceed.FileSystem.FileSystemEventsSession"/> class. </summary> <param name="events">The <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object from which we created the session.</param> <param name="sender">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object on which the process was called.</param> <param name="userData">Opaque data that is sent back to the event handler when an event is raised.</param> <remarks><para>This constructor is called within the <see cref="M:Xceed.FileSystem.FileSystemEvents.CreateSession(System.Object,System.Object)"/> method found in the <see cref="T:Xceed.FileSystem.FileSystemEvents"/> class.</para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemEventsSession.OnScanningFolder(Xceed.FileSystem.AbstractFolder)"> <summary> Raised when a folder is scanned or accessed during the processing of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects. </summary> <param name="currentFolder">The <see cref="T:Xceed.FileSystem.AbstractFolder"/> object being scanned.</param> </member> <member name="M:Xceed.FileSystem.FileSystemEventsSession.OnNewItemToProcess(Xceed.FileSystem.FileSystemItem,Xceed.FileSystem.FileSystemItem)"> <summary> Places the new item in the list of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to be processed. </summary> <param name="currentItem">The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object being processed.</param> <param name="targetItem">The eventual target <see cref="T:Xceed.FileSystem.FileSystemItem"/> object being added to the list of items.</param> </member> <member name="M:Xceed.FileSystem.FileSystemEventsSession.OnProcessingNewItem(Xceed.FileSystem.FileSystemItem,Xceed.FileSystem.FileSystemItem,System.Boolean)"> <summary> Raised when a new item is about to be processed. </summary> <param name="current">The current <see cref="T:Xceed.FileSystem.FileSystemItem"/> object being processed.</param> <param name="target">The eventual target <see cref="T:Xceed.FileSystem.FileSystemItem"/> object for the process.</param> <param name="raiseBytesProgression">A boolean value indicating if we want bytes progression events to be raised.</param> </member> <member name="M:Xceed.FileSystem.FileSystemEventsSession.GetNextItemPair(System.Boolean)"> <summary> Retrieves the next pair of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to be processed. </summary> <param name="raiseBytesProgression">A boolean value indicating if the <see langword="ByteProgression"/> event should be raised.</param> <returns>An <see cref="T:Xceed.FileSystem.ItemPair"/> object.</returns> <remarks><para> A pair of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects consisting of the current item being processed and it's eventual target or destination item. </para></remarks> </member> <member name="M:Xceed.FileSystem.FileSystemEventsSession.OnBytesProcessed(System.Int64)"> <summary> Raises the <see langword="ByteProgression"/> event for a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object being processed. </summary> <param name="increment">The amount of bytes to be added to the total amount of bytes processed so far.</param> </member> <member name="M:Xceed.FileSystem.FileSystemEventsSession.OnBytesCompleted"> <summary> Forces the byte progression to 100% completion. </summary> </member> <member name="M:Xceed.FileSystem.FileSystemEventsSession.OnUndoBytesProcessed"> <summary> Removes the amount of bytes processed for an item if an error occured during the processing of that item. </summary> </member> <member name="M:Xceed.FileSystem.FileSystemEventsSession.OnException(System.Exception)"> <summary> Raises the <see langword="ItemException"/> event whenever an error occurs during the processing of a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object. </summary> <param name="except">The error that occured.</param> <returns><see langword="true"/> if we want to retry processing the item; <see langword="false"/> if the item should be ignored or the process aborted.</returns> </member> <member name="M:Xceed.FileSystem.FileSystemEventsSession.OnCompletion"> <summary> Raises the last <see langword="ItemProgression"/> event when the process is completed. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventsSession.m_currentFileBytes"> <summary> An instance of the ProgressionInfo class representing the byte count information in regards to the current item being processed for the current session. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventsSession.m_allFilesBytes"> <summary> An instance of the ProgressionInfo class representing the byte count information in regards to all the items to be processed for the current session. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventsSession.m_allItems"> <summary> An instance of the ProgressionInfo class representing the item count information for the current session. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventsSession.m_scanningFolderArgs"> <summary> An instance of the <see cref="T:Xceed.FileSystem.ScanningFolderEventArgs"/> class that provides information on the folder being scanned or accessed for the current session. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventsSession.m_byteProgressionArgs"> <summary> An instance of the <see cref="T:Xceed.FileSystem.ByteProgressionEventArgs"/> class that provides byte progression information for the current session. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventsSession.m_itemProgressionArgs"> <summary> An instance of the <see cref="T:Xceed.FileSystem.ItemProgressionEventArgs"/> class that provides item progression information for the current session. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventsSession.m_itemExceptionArgs"> <summary> An instance of the <see cref="T:Xceed.FileSystem.ItemExceptionEventArgs"/> class that provides information on the exception that was thrown during a process for the current session. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventsSession.m_currentItem"> <summary> The current <see cref="T:Xceed.FileSystem.FileSystemItem"/> object being processed for the current session. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventsSession.m_targetItem"> <summary> The current target <see cref="T:Xceed.FileSystem.FileSystemItem"/> object of the process for the current session. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventsSession.m_events"> <summary> An instance of the <see cref="T:Xceed.FileSystem.FileSystemEvents"/> class representing the original <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object from which we created the session. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventsSession.m_sender"> <summary> The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object on which the process was called. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventsSession.m_userData"> <summary> This is set at construction, and updated after each event. It is assigned to each argument structure before each event. </summary> </member> <member name="F:Xceed.FileSystem.FileSystemEventsSession.m_itemPairQueue"> <summary> Represents a first-in, first-out collection of the items to process for the current session. </summary> </member> <member name="P:Xceed.FileSystem.FileSystemEventsSession.Events"> <summary> Gets the original <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object used to create the session. </summary> <value>A reference to <see cref="T:Xceed.FileSystem.FileSystemEvents"/> object.</value> </member> <member name="P:Xceed.FileSystem.FileSystemEventsSession.UserData"> <summary> Gets the opaque data that is sent back to the event handler when an event is raised. </summary> <value>Opaque data that is sent back to the event handler.</value> </member> <member name="P:Xceed.FileSystem.FileSystemEventsSession.CurrentItem"> <summary> Gets or sets the <see cref="T:Xceed.FileSystem.FileSystemItem"/> object currently being processed. </summary> <value>A reference to a <see cref="T:Xceed.FileSystem.FileSystemItem"/> object.</value> </member> <member name="P:Xceed.FileSystem.FileSystemEventsSession.TargetItem"> <summary> Gets or sets the eventual target <see cref="T:Xceed.FileSystem.FileSystemItem"/> object for the process. </summary> <value>A reference to the eventual target <see cref="T:Xceed.FileSystem.FileSystemItem"/> object.</value> </member> <member name="P:Xceed.FileSystem.FileSystemEventsSession.IsEmpty"> <summary> Gets a boolean value indicating if the session's list of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects to process contains no items. </summary> <value><see langword="true"/> if the list is empty; <see langword="false"/> otherwise.</value> </member> <member name="T:Xceed.FileSystem.ItemPair"> <summary> Represents a pair of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects consisting of the item being processed and it's eventual target or destination item. </summary> </member> <member name="M:Xceed.FileSystem.ItemPair.#ctor(Xceed.FileSystem.FileSystemItem,Xceed.FileSystem.FileSystemItem)"> <summary> Initializes an instance of the <see cref="T:Xceed.FileSystem.ItemPair"/> class specifying the current and target items. </summary> <param name="currentItem">The current <see cref="T:Xceed.FileSystem.FileSystemItem"/> object being processed.</param> <param name="targetItem">The eventual target or destination <see cref="T:Xceed.FileSystem.FileSystemItem"/> object.</param> </member> <member name="F:Xceed.FileSystem.ItemPair.current"> <summary> The <see cref="T:Xceed.FileSystem.FileSystemItem"/> object being procesed. </summary> </member> <member name="F:Xceed.FileSystem.ItemPair.target"> <summary> The eventual target or destination <see cref="T:Xceed.FileSystem.FileSystemItem"/> object. </summary> <remarks><para>Can be <see langword="null"/> in cases where there is no target, for example when calling the <seealso cref="M:Xceed.FileSystem.FileSystemItem.Refresh"/> method.</para></remarks> </member> <member name="T:Xceed.FileSystem.FileSystemLicenseProvider"> <summary> The license provider for all the public classes of the Xceed.FileSystem namespace. All these classes are using the Xceed.FileSystem.Licenser type and the ZIN... license key. </summary> </member> <member name="P:Xceed.FileSystem.FileSystemLicenseProvider.ProductId"> <summary> The code name of the product </summary> </member> <member name="P:Xceed.FileSystem.FileSystemLicenseProvider.AllowedVersions"> <summary> All the version number supported by this version of the product. </summary> <remarks> The versions should be in descending order beginning with the current version. </remarks> </member> <member name="T:Xceed.FileSystem.FilterScope"> <summary> Specifies which type of <see cref="T:Xceed.FileSystem.FileSystemItem"/> will be filtered by a <see cref="T:Xceed.FileSystem.Filter"/> object. </summary> </member> <member name="F:Xceed.FileSystem.FilterScope.File"> <summary>The filter will be applied to any <see cref="T:Xceed.FileSystem.AbstractFile"/> object.</summary> </member> <member name="F:Xceed.FileSystem.FilterScope.Folder"> <summary>The filter will be applied to any <see cref="T:Xceed.FileSystem.AbstractFolder"/> object.</summary> </member> <member name="F:Xceed.FileSystem.FilterScope.All"> <summary>The filter will be applied to all types of <see cref="T:Xceed.FileSystem.FileSystemItem"/> objects.</summary> </member> <member name="T:Xceed.FileSystem.Licenser"> <summary> Class which is used to register the classes located in the Xceed.FileSystem namespace as described in the <A href="XceedZipNET.chm::/Sources/Licensing.htm">Licensing</A> topic of the Xceed Zip for .NET documentation. </summary> </member> <member name="M:Xceed.FileSystem.Licenser.#ctor"> <summary> Initializes a new instance of the <see cref="T:Xceed.FileSystem.Licenser"/> class. </summary> </member> <member name="P:Xceed.FileSystem.Licenser.LicenseKey"> <summary> Gets or sets the license key used to license this product. </summary> <value>A string value representing the license key used to license this product.</value> </member> <member name="P:Xceed.FileSystem.Licenser.License"> <summary> Returns the Xceed license created by the LicenseManager in the default constructor. </summary> </member> </members> </doc> 
