View Source

Class BackOfficeTourFilter

Represents a back-office tour filter.

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.Tour

Assembly: Umbraco.Core.dll

Syntax

public class BackOfficeTourFilter

Constructors

BackOfficeTourFilter(Regex, Regex, Regex)

Initializes a new instance of the BackOfficeTourFilter class.

Declaration

public BackOfficeTourFilter(Regex pluginName, Regex tourFileName, Regex tourAlias)

Parameters

Type	Name	Description
System.Text.RegularExpressions.Regex	pluginName	Value to filter out tours by a plugin, can be null
System.Text.RegularExpressions.Regex	tourFileName	Value to filter out a tour file, can be null
System.Text.RegularExpressions.Regex	tourAlias	Value to filter out a tour alias, can be null

Remarks

Depending on what is null will depend on how the filter is applied. If pluginName is not NULL and it's matched then we check if tourFileName is not NULL and it's matched then we check tour alias is not NULL and then match it, if any steps is NULL then the filters upstream are applied. Example, pluginName = "hello", tourFileName="stuff", tourAlias=NULL = we will filter out the tour file "stuff" from the plugin "hello" but not from other plugins if the same file name exists. Example, tourAlias="test.*" = we will filter out all tour aliases that start with the word "test" regardless of the plugin or file name

Properties

PluginName

Gets the plugin name filtering regex.

Declaration

public Regex PluginName { get; }

Property Value

Type	Description
System.Text.RegularExpressions.Regex

TourAlias

Gets the tour alias filtering regex.

Declaration

public Regex TourAlias { get; }

Property Value

Type	Description
System.Text.RegularExpressions.Regex

TourFileName

Gets the tour filename filtering regex.

Declaration

public Regex TourFileName { get; }

Property Value

Type	Description
System.Text.RegularExpressions.Regex

Methods

FilterAlias(Regex)

Creates a filter to filter on the tour alias.

Declaration

public static BackOfficeTourFilter FilterAlias(Regex tourAlias)

Parameters

Type	Name	Description
System.Text.RegularExpressions.Regex	tourAlias

Returns

Type	Description
BackOfficeTourFilter

FilterFile(Regex)

Creates a filter to filter on the tour filename.

Declaration

public static BackOfficeTourFilter FilterFile(Regex tourFileName)

Parameters

Type	Name	Description
System.Text.RegularExpressions.Regex	tourFileName

Returns

Type	Description
BackOfficeTourFilter

FilterPlugin(Regex)

Creates a filter to filter on the plugin name.

Declaration

public static BackOfficeTourFilter FilterPlugin(Regex pluginName)

Parameters

Type	Name	Description
System.Text.RegularExpressions.Regex	pluginName

Returns

Type	Description
BackOfficeTourFilter