Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator Class Reference

Wraps Project's Graphical Indicator criteria string. More...

List of all members.

Classes
class	Criteria
	A very simple wrapper around Project Server's graphical indicator. More...
Public Types
enum	CriteriaFor { None, NonSummaryRows, ProjectSummary, Summary }
Public Member Functions
	GraphicalIndicator (Guid entityGuid, CustomFieldDefinition customField, CustomField.Type customFieldType)
	Create an instance of GraphicalIndicator.
void	AddCriteria (CriteriaFor criteriaFor, Criteria criteria)
	Add criteria to a specific type (Non Summary Rows,Project Summary, and Summary).
Criteria	GetCriteria (CriteriaFor criteriaFor, int index)
	Retrieve the criteria for the given type at the given index.
string	GetCriteriaString (CriteriaFor criteriaFor)
	Returns the criteria string for the specified criteria type.
int	GetCount (CriteriaFor criteriaFor)
	Given a specific criteria type, return the count of criteria.
void	ClearCriteria (CriteriaFor criteriaFor)
	Given a specific criteria type, clear its criteria.
Stack	ParseCriteriaString (string criteriaString)
	Parses the criteria string.
Static Public Member Functions
static string	GetDisplayName (string testString)
	Given a specific test string (for example '==' or '!='), return its display name (equals or does not equal).
Static Public Attributes
static readonly int	MAX_NUMBER_OF_CRITERIA = 3
static readonly int	MAX_IMAGE_INDEX = 65
Properties
string[]	TestsDisplayNames [get]
	Retrieve an error of the tests' display names.
Guid	EntityGuid [get, set]
	Retrieve and privately set the Graphical Indicator's underlying entity GUID.
CustomField.Type	CustomFieldType [get, set]
	Retrieve and privately set the CustomField type.
int	ProjectSummaryCriteriaCount [get]
	Retrieve the count of Project Summary criteria.
int	SummaryCriteriaCount [get]
	Retrieve the count of Summary criteria.
int	NonSummaryCriteriaCount [get]
	Retrieve the count of Non Summary criteria.

---

Detailed Description

Wraps Project's Graphical Indicator criteria string.

Definition at line 25 of file GraphicalIndicator.cs.

---

Constructor & Destructor Documentation

Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator.GraphicalIndicator	(	Guid	entityGuid,
		CustomFieldDefinition	customField,
		CustomField.Type	customFieldType
	)

Create an instance of GraphicalIndicator.

Parameters:

	entityGuid	The GUID of the entity (Project, Task, Resource)
	customField	The CustomField definition of the field for which the Graphical Indicator will be associated with
	customFieldType	The custom field type (Cost, Date, Duration, Flag, Number, and Text

Definition at line 63 of file GraphicalIndicator.cs.

---

Member Function Documentation

void Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator.AddCriteria	(	CriteriaFor	criteriaFor,
		Criteria	criteria
	)

Add criteria to a specific type (Non Summary Rows,Project Summary, and Summary).

Parameters:

	criteriaFor	Designates which criteria collection the criteria will be added to
	criteria	The criteria to add

Definition at line 100 of file GraphicalIndicator.cs.

void Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator.ClearCriteria

(

CriteriaFor

criteriaFor

)

Given a specific criteria type, clear its criteria.

Parameters:

criteriaFor

The criteria type to clear

Definition at line 234 of file GraphicalIndicator.cs.

int Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator.GetCount

(

CriteriaFor

criteriaFor

)

Given a specific criteria type, return the count of criteria.

Parameters:

criteriaFor

The criteria type

Returns:

The count

Definition at line 215 of file GraphicalIndicator.cs.

Criteria Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator.GetCriteria	(	CriteriaFor	criteriaFor,
		int	index
	)

Retrieve the criteria for the given type at the given index.

Parameters:

	criteriaFor	Designates which criteria collection to retrieve from
	index	The index of the criteria

Returns:

The requested criteria

Definition at line 157 of file GraphicalIndicator.cs.

string Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator.GetCriteriaString

(

CriteriaFor

criteriaFor

)

Returns the criteria string for the specified criteria type.

Parameters:

criteriaFor

Designates which criteria should be render as the return string

Returns:

The criteria string

Definition at line 178 of file GraphicalIndicator.cs.

static string Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator.GetDisplayName

(

string

testString

)

[static]

Given a specific test string (for example '==' or '!='), return its display name (equals or does not equal).

Parameters:

testString

The test string to look up

Returns:

The display name of the test string

Definition at line 317 of file GraphicalIndicator.cs.

Stack Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator.ParseCriteriaString

(

string

criteriaString

)

Parses the criteria string.

Parameters:

criteriaString

Returns:

A stack representing the individual criteria components

Definition at line 259 of file GraphicalIndicator.cs.

---

Property Documentation

CustomField.Type Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator.CustomFieldType [get, set]

Retrieve and privately set the CustomField type.

Definition at line 357 of file GraphicalIndicator.cs.

Guid Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator.EntityGuid [get, set]

Retrieve and privately set the Graphical Indicator's underlying entity GUID.

Definition at line 352 of file GraphicalIndicator.cs.

int Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator.NonSummaryCriteriaCount [get]

Retrieve the count of Non Summary criteria.

Definition at line 379 of file GraphicalIndicator.cs.

int Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator.ProjectSummaryCriteriaCount [get]

Retrieve the count of Project Summary criteria.

Definition at line 363 of file GraphicalIndicator.cs.

int Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator.SummaryCriteriaCount [get]

Retrieve the count of Summary criteria.

Definition at line 371 of file GraphicalIndicator.cs.

string [] Mcs.Epm.MicrosoftProject.mpFx.GraphicalIndicator.TestsDisplayNames [get]

Retrieve an error of the tests' display names.

Definition at line 338 of file GraphicalIndicator.cs.

---

The documentation for this class was generated from the following file:

• C:/Data/Projects/MCS EPM Global Practice/Frameworks/Public/mpfX/1.0/Libraries/Mcs.Epm.MicrosoftProject.mpFx/GraphicalIndicator.cs