DocumentFilter.FromGlobPattern(String, Boolean) Method

Definition

Creates a DocumentFilter from a glob pattern matching the document file path.

public static Microsoft.VisualStudio.Extensibility.DocumentFilter FromGlobPattern (string pattern, bool relativePath);
static member FromGlobPattern : string * bool -> Microsoft.VisualStudio.Extensibility.DocumentFilter
Public Shared Function FromGlobPattern (pattern As String, relativePath As Boolean) As DocumentFilter

Parameters

pattern
String

The glob pattern to match document file path. Glob patterns can have the following syntax:

  • to match one or more characters in a path segment ? to match on one character in a path segment ** to match any number of path segments, including none {} to group conditions (e.g. **/*.{ts,js} matches all TypeScript and JavaScript files) [] to declare a range of characters to match in a path segment (e.g., example.[0-9] to match on example.0, example.1, …) [!...] to negate a range of characters to match in a path segment (e.g., example.[!0-9] to match on example.a, example.b, but not example.0) Note: a backslash () is not valid within a glob pattern. If you have an existing file path to match against, consider to use the relative pattern support that takes care of converting any backslash into slash. Otherwise, make sure to convert any backslash to slash when creating the glob pattern.
relativePath
Boolean

Defines whether the pattern should be applied to the absolute path of a file or to a path relative to the solution folder.

Returns

The DocumentFilter.

Applies to