GroupCriterion

GroupCriterion class

Represents a criterion in a group definition. The GroupCriterion object is a member of the GroupCriterionCollection collection.

public class GroupCriterion

Constructors

Name Description
GroupCriterion() The default constructor.

Properties

Name Description
Ascending { get; set; } Gets or sets a value indicating whether a field used as a criterion in a group definition is sorted in ascending order. False if the field is sorted in descending order.
CellColor { get; set; } Gets or sets the color of the cell background for a field used as a criterion in a group definition.
Field { get; set; } Gets or sets the field being grouped by.
Font { get; set; } Gets or sets the font for a criterion in a group definition.
FontColor { get; set; } Gets or sets the color of the font for a field used as a criterion in a group definition.
GroupInterval { get; set; } Gets or sets the interval for a field used as a criterion in a group definition.
GroupOn { get; set; } Gets or sets the type of grouping for a field used as a criterion in a group definition.
Index { get; } Gets the index of a GroupCriterion object in the containing GroupCriterionCollection collection.
ParentGroup { get; } Gets the parent of the GroupCriterion object.
Pattern { get; set; } Gets or sets the pattern of the cell for a field used as a criterion in a group definition.
StartAt { get; set; } Gets or sets the start of the intervals for a field used as a criterion in a group definition.

Methods

Name Description
override Equals(object) Returns a value indicating whether this instance is equal to a specified object.
override GetHashCode() Serves as a hash function for a particular type.

Examples

Shows how to work with a group criterion.

var project = new Project(DataDir + "ReadGroupDefinitionData.mpp");

Console.WriteLine("Task Groups Count: " + project.TaskGroups.Count);
var group = project.TaskGroups.ToList()[1];
Console.WriteLine("Task Group Name: " + group.Name);
Console.WriteLine("Task Group Criteria count: " + group.GroupCriteria.Count);

Console.WriteLine("\n************* Retrieving Task Group's Criterion information *************");
var criterion = group.GroupCriteria.ToList()[0];
Console.WriteLine("Task Criterion Index: " + criterion.Index);
Console.WriteLine("Task Criterion Field: " + criterion.Field);
Console.WriteLine("Task Criterion GroupOn: " + criterion.GroupOn);
Console.WriteLine("Task Criterion Cell Color: " + criterion.CellColor);
Console.WriteLine("Task Criterion Font Color: " + criterion.FontColor);
Console.WriteLine("Task Criterion Group Interval: " + criterion.GroupInterval);
Console.WriteLine("Task Criterion Start At: " + criterion.StartAt);

// read the background pattern of the criterion  
Console.WriteLine("Task Criterion Pattern: " + criterion.Pattern);

if (group == criterion.ParentGroup)
{
    Console.WriteLine("Parent Group is equal to task Group.");
}

Console.WriteLine("\n*********** Retrieving Criterion's Font Information ***********");
Console.WriteLine("Font Name: " + criterion.Font.FontFamily);
Console.WriteLine("Font Size: " + criterion.Font.Size);
Console.WriteLine("Font Style: " + criterion.Font.Style);
Console.WriteLine("Ascending/Descending: " + criterion.Ascending);

See Also