Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / FilterScope Enumeration
ExampleExample


In This Topic
    FilterScope Enumeration
    In This Topic
    Specifies which type of FileSystemItem will be filtered by a Filter object.
    Syntax
    'Declaration
 

    <FlagsAttribute()>
Public Enum FilterScope 
   Inherits System.Enum
   Implements System.IComparable, System.IConvertible, System.IFormattable 
    'Usage
 

    Dim instance As FilterScope
    [Flags()]
public enum FilterScope : System.Enum, System.IComparable, System.IConvertible, System.IFormattable
    Members
    MemberValueDescription
    All3The filter will be applied to all types of FileSystemItem objects.
    File1The filter will be applied to any AbstractFile object.
    Folder2The filter will be applied to any AbstractFolder object.
    Recurse4The filter only applies to subfolder AbstractFolder objects when the recursive parameter of the applicable methods is set to true.
    Remarks

    The File and Folder values determine what items are included or excluded, but do not prevent recursing into subfolders even though that folder would be excluded by the filter. To prevent recursing into a subfolder, use the Recurse value with the applicable filter.

    Example
    This example shows how to prevent the contents of a specific subfolder from being copied, while copying everything else recursively.
    This example shows how to prevent the contents of a specific subfolder from being copied, while copying everything else recursively. 
    
	
    
	
    
		
    sourceFolder.CopyFilesTo( destFolder, true, true, new NotFilter( new NameFilter( "Private", FilterScope.Recurse ) ) );
    
	
    
	

    

    
            
            
    Example
    sourceFolder.CopyFilesTo( destFolder, true, true, new NotFilter( new NameFilter( "Private", FilterScope.Recurse ) ) );

    
            
    Inheritance Hierarchy
    System.Object
       System.ValueType
          System.Enum
             Xceed.FileSystem.FilterScope
    
            
    Supported Frameworks
    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.
    .NET Standard: netstandard2.0, netstandard2.1
    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.
    
            
            
    See Also
    Reference
    Xceed.FileSystem Namespace

    FileSystemItem Class

    Filter Class

    

    
            
            
    
                

Send Feedback