Class Filter

Filter class

Represents a filter in Project.

public sealed class Filter : IComparable<Filter>, IEquatable<Filter>

Constructors

NameDescription
Filter()The default constructor.

Properties

NameDescription
Criteria { get; set; }Gets or sets the criteria that tasks or resources must meet to be displayed in MSP view.
FilterType { get; set; }Gets the type of the filter.
Index { get; }Gets the index of a Filter object in the Filters containing object.
Name { get; set; }Gets or sets the name of a Filter object.
ShowInMenu { get; set; }Gets or sets a value indicating whether project shows the filter name in the Filter drop-down list on the View tab of the Ribbon.
ShowRelatedSummaryRows { get; set; }Gets or sets a value indicating whether related summary rows are displayed for the filter.
Uid { get; }Gets the unique identifier of a filter.

Methods

NameDescription
CompareTo(Filter)Compares this instance to the specified instance of the Filter class and returns an indication of their relative order.
Equals(Filter)Returns a value indicating whether this instance is equal to the specified AssignmentBaseline object.
override Equals(object)Returns a value indicating whether this instance is equal to the specified AssignmentBaseline object.
override GetHashCode()Returns a hash code value for the filter.
operator ==Returns a value indicating whether this instance is equal to a specified object.
operator >Returns a value indicating whether this instance is greater than a specified object.
operator >=Returns a value indicating whether this instance is greater than or equal to a specified object.
operator !=Returns a value indicating whether this instance is not equal to a specified object.
operator <Returns a value indicating whether this instance is less than a specified object.
operator <=Returns a value indicating whether this instance is less than or equal to a specified object.

Examples

Shows how to work with filters.

var project = new Project(DataDir + "ReadFilterDefinitionData.mpp");
List<Filter> filters = project.TaskFilters.ToList();
Console.WriteLine("Task filters count: " + filters.Count);
foreach (var filter in filters)
{
    Console.WriteLine("Uid: " + filter.Uid);
    Console.WriteLine("Index: " + filter.Index);
    Console.WriteLine("Name: " + filter.Name);
    Console.WriteLine("Type: " + filter.FilterType);
    Console.WriteLine("Show In Menu: " + filter.ShowInMenu);
    Console.WriteLine("Show Related Summary Rows: " + filter.ShowRelatedSummaryRows);
}

// check resource filters
List<Filter> resourceFilters = project.ResourceFilters.ToList();
Console.WriteLine("Project.ResourceFilters count: " + resourceFilters.Count);
Console.WriteLine("Resource Filter Item Type: Item.ResourceType: " + resourceFilters[0].FilterType);
Console.WriteLine("Resource filter ShowInMenu" + resourceFilters[0].ShowInMenu);
Console.WriteLine("Resource filter ShowRelatedSummaryRows: " + resourceFilters[0].ShowRelatedSummaryRows);

See Also