Class CsFileFilter

Namespace

SunamoDevCode

Assembly

SunamoDevCode.dll

EN: Filter for C# files with configurable filtering rules CZ: Filtr pro C# soubory s konfigurovatelными pravidly filtrování

public class CsFileFilter : ICsFileFilter

Inheritance

object

CsFileFilter

Implements

ICsFileFilter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

FuncExtensions.AsFuncFast<T>(T)

FuncExtensions.AsFunc<T>(T)

ObjectExtensions.GetStackTrace(object)

ReClasser.FixMeUp(object)

Remarks

Cannot be derived from FiltersNotTranslateAble to make finding instances of CsFileFilter easier

Constructors

CsFileFilter()

In default is everything in false Call some Set* method

public CsFileFilter()

Methods

AllowOnly(string)

Checks whether the given file path passes all filter criteria including both contains and end checks.

public bool AllowOnly(string filePath)

Parameters

filePath string

File path to evaluate.

Returns

bool

True if the file is allowed by the filter.

AllowOnly(string, EndArgs, ContainsArgs)

Checks if a file path is allowed based on end and contains filtering rules.

public static bool AllowOnly(string filePath, CsFileFilter.EndArgs end, CsFileFilter.ContainsArgs containsArgs)

Parameters

filePath string

File path to check

end CsFileFilter.EndArgs

End arguments for filtering

containsArgs CsFileFilter.ContainsArgs

Contains arguments for filtering

Returns

bool

True if the file is allowed, false if it should be filtered out

AllowOnly(string, EndArgs, ContainsArgs, ref bool, bool)

A2 is also for master.designer.cs and aspx.designer.cs A2,3 can be null

public static bool AllowOnly(string filePath, CsFileFilter.EndArgs end, CsFileFilter.ContainsArgs containsArgs, ref bool hasEndMatch, bool isAlsoCheckingEnds)

Parameters

filePath string

File path to check

end CsFileFilter.EndArgs

End arguments for filtering

containsArgs CsFileFilter.ContainsArgs

Contains arguments for filtering

hasEndMatch bool

Output parameter indicating if end pattern matched

isAlsoCheckingEnds bool

Whether to also check end patterns

Returns

bool

True if the file is allowed, false if it should be filtered out

AllowOnly(string, bool)

Checks whether the given file path passes filter criteria, optionally including end-of-path checks.

public bool AllowOnly(string filePath, bool isAlsoCheckingEnds)

Parameters

filePath string

File path to evaluate.

isAlsoCheckingEnds bool

Whether to also check file path endings.

Returns

bool

True if the file is allowed by the filter.

AllowOnlyContains(string)

Checks whether the given file path passes the contains-only filter criteria.

public bool AllowOnlyContains(string itemPath)

Parameters

itemPath string

File path to evaluate.

Returns

bool

True if the file is allowed by the contains filter.

AllowOnlyContains(string, ContainsArgs)

Checks if a file path is allowed based on contains filtering rules only.

public static bool AllowOnlyContains(string itemPath, CsFileFilter.ContainsArgs containsArgs)

Parameters

itemPath string

File path to check

containsArgs CsFileFilter.ContainsArgs

Contains arguments for filtering

Returns

bool

True if the file is allowed, false if it should be filtered out

GetContainsByFlags(bool)

Gets list of "contains" patterns based on flags

public List<string> GetContainsByFlags(bool negate)

Parameters

negate bool

Whether to negate the flag values

Returns

List<string>

List of contains patterns

GetEndingByFlags(bool)

Gets list of file ending patterns based on configured flags.

public List<string> GetEndingByFlags(bool negate)

Parameters

negate bool

Whether to negate the flag values

Returns

List<string>

List of file ending patterns

GetFilesFiltered(string, string, SearchOption)

Gets filtered list of C# files based on configured filtering rules.

public List<string> GetFilesFiltered(string path, string searchPattern, SearchOption searchOption)

Parameters

path string

Directory path to search

searchPattern string

File search pattern (e.g., "*.cs")

searchOption SearchOption

Search option (TopDirectoryOnly or AllDirectories)

Returns

List<string>

Filtered list of file paths

Set(EndArgs, ContainsArgs)

Sets the end and contains arguments for filtering.

public void Set(CsFileFilter.EndArgs endArguments, CsFileFilter.ContainsArgs containsArguments)

Parameters

endArguments CsFileFilter.EndArgs

End arguments for filtering

containsArguments CsFileFilter.ContainsArgs

Contains arguments for filtering

SetDefault()

Sets the default filtering configuration with standard exclusion patterns.

public void SetDefault()