Class CompassFilter

Represents the different filters for a given filter.

Inheritance

System.Object

CompassFilter

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Phoenix.Controls.Compass

Assembly: Phoenix.Controls.Compass.dll

Syntax

public class CompassFilter

Remarks

This is intended for something like Polaris Recommendations, where a recommendation may have different ways to filter objects, i.e. by bug status or area path. This class represents corresponds to an item in the "Object Type" column of the filter table.

Constructors

CompassFilter(String)

Initializes a new instance of the CompassFilter class. Initializes a new instance of CompassFilter.

Declaration

public CompassFilter(string name)

Parameters

Type	Name	Description
System.String	name	The name of the filter.

Properties

Name

Gets the name of the filter.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

RegisteredFilters

Gets all of the registered filter categories under this filter.

Declaration

public ObservableCollection<CompassFilterCategory> RegisteredFilters { get; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<CompassFilterCategory>

Methods

AddNewFilterCategory(String, IEnumerable<String>)

Registers a new filter type associated with this filter.

Declaration

public void AddNewFilterCategory(string filterCategoryName, IEnumerable<string> filterCategoryEntries)

Parameters

Type	Name	Description
System.String	filterCategoryName	The name of the filter category.
System.Collections.Generic.IEnumerable<System.String>	filterCategoryEntries	The collection of filter entries that belong to the new filter category.

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()