Mcs.Epm.MicrosoftProject.mpFx.CustomFields Class Reference

Provides data and functionality for using enterprise custom fields. More...

List of all members.

Public Member Functions
	CustomFields (ProjectServer parent)
	Create an instance of Calendars.
IEnumerator< Guid >	GetEnumerator ()
CustomFieldDataSet.CustomFieldsRow	GetCustomFieldInfo (Guid propertyGuid)
	Return a custom field row for the specified custom field.
CustomFieldDataSet	GetCustomFieldDataSet (Guid propertyGuid)
	Get a custom field dataset for the specified custom field.
void	CheckOut (Guid[] propertyGuids)
	Check out a collection of custom fields.
void	CheckIn (Guid propertyGuid, bool force)
	Check in a custom field.
void	Create (CustomFieldDefinition customFieldDefinition, bool validateOnly, bool autoCheckin)
	Create a custom field from a custom field definition.
void	Delete (Guid[] propertyGuids)
	Delete custom fields.
void	Update (CustomFieldDataSet customFieldDataSet, CustomFieldDefinition customFieldDefinition, bool validateOnly, bool autoCheckin)
	Update a custom field from a definition.
void	Update (CustomFieldDataSet customFieldDataSet, bool validateOnly, bool autoCheckin)
	Update custom fields.
bool	ContainsKey (Guid propertyGuid)
	Determine if the custom field collection contains a specific property GUID.
Static Public Member Functions
static CustomField.Type	GetTypeFromName (string name)
	Get a custom field type from its name.
Properties
internal ProjectServer	Parent [get, set]
Dictionary< Guid, string >	CustomFieldsCollection [get, set]
	Get a simple dictionary of calendar GUIDs and Names.
string	this [Guid guid] [get]

---

Detailed Description

Provides data and functionality for using enterprise custom fields.

Definition at line 24 of file CustomFields.cs.

---

Constructor & Destructor Documentation

Mcs.Epm.MicrosoftProject.mpFx.CustomFields.CustomFields

(

ProjectServer

parent

)

Create an instance of Calendars.

Parameters:

parent

Parent Object

summary> Returns an enumerator that iterates through the collection. /summary>

returns> A T:System.Collections.Generic.IEnumerator`1 that can be used to iterate through the collection. /returns> filterpriority>1</filterpriority>

Definition at line 137 of file CustomFields.cs.

---

Member Function Documentation

void Mcs.Epm.MicrosoftProject.mpFx.CustomFields.CheckIn	(	Guid	propertyGuid,
		bool	force
	)

Check in a custom field.

Parameters:

	propertyGuid	The custom field property GUID
	force	True to force the check-in

Definition at line 220 of file CustomFields.cs.

void Mcs.Epm.MicrosoftProject.mpFx.CustomFields.CheckOut

(

Guid[]

propertyGuids

)

Check out a collection of custom fields.

Parameters:

propertyGuids

An array of custom field GUIDs

Definition at line 210 of file CustomFields.cs.

bool Mcs.Epm.MicrosoftProject.mpFx.CustomFields.ContainsKey

(

Guid

propertyGuid

)

Determine if the custom field collection contains a specific property GUID.

Parameters:

propertyGuid

The property GUID to look for

Returns:

True if contains key, false otherwise

summary> Returns an enumerator that iterates through a collection. /summary>

returns> An T:System.Collections.IEnumerator object that can be used to iterate through the collection. /returns> filterpriority>2</filterpriority>

Definition at line 293 of file CustomFields.cs.

void Mcs.Epm.MicrosoftProject.mpFx.CustomFields.Create	(	CustomFieldDefinition	customFieldDefinition,
		bool	validateOnly,
		bool	autoCheckin
	)

Create a custom field from a custom field definition.

Parameters:

	customFieldDefinition	The custom field definition
	validateOnly	True to validate only
	autoCheckin	True to automatically check in after creation

Definition at line 231 of file CustomFields.cs.

void Mcs.Epm.MicrosoftProject.mpFx.CustomFields.Delete

(

Guid[]

propertyGuids

)

Delete custom fields.

Parameters:

propertyGuids

An array of custom field GUIDs

Definition at line 252 of file CustomFields.cs.

CustomFieldDataSet Mcs.Epm.MicrosoftProject.mpFx.CustomFields.GetCustomFieldDataSet

(

Guid

propertyGuid

)

Get a custom field dataset for the specified custom field.

Parameters:

propertyGuid

The custom field property GUID

Returns:

CustomFieldDataSet

Definition at line 196 of file CustomFields.cs.

CustomFieldDataSet.CustomFieldsRow Mcs.Epm.MicrosoftProject.mpFx.CustomFields.GetCustomFieldInfo

(

Guid

propertyGuid

)

Return a custom field row for the specified custom field.

Parameters:

propertyGuid

The custom field property GUID

Returns:

CustomFieldDataSet.CustomFieldsRow

Definition at line 177 of file CustomFields.cs.

static CustomField.Type Mcs.Epm.MicrosoftProject.mpFx.CustomFields.GetTypeFromName

(

string

name

)

[static]

Get a custom field type from its name.

Parameters:

name

The name of the custom field

Returns:

Definition at line 33 of file CustomFields.cs.

void Mcs.Epm.MicrosoftProject.mpFx.CustomFields.Update	(	CustomFieldDataSet	customFieldDataSet,
		bool	validateOnly,
		bool	autoCheckin
	)

Update custom fields.

Parameters:

	customFieldDataSet	The CustomFieldDataSet
	validateOnly	True to validate only
	autoCheckin	True to automatically check in after creation

Definition at line 283 of file CustomFields.cs.

void Mcs.Epm.MicrosoftProject.mpFx.CustomFields.Update	(	CustomFieldDataSet	customFieldDataSet,
		CustomFieldDefinition	customFieldDefinition,
		bool	validateOnly,
		bool	autoCheckin
	)

Update a custom field from a definition.

Parameters:

	customFieldDataSet	The CustomFieldDataSet
	customFieldDefinition	The custom field definition
	validateOnly	True to validate only
	autoCheckin	True to automatically check in after creation

Definition at line 264 of file CustomFields.cs.

---

Property Documentation

Dictionary<Guid, string> Mcs.Epm.MicrosoftProject.mpFx.CustomFields.CustomFieldsCollection [get, set]

Get a simple dictionary of calendar GUIDs and Names.

Definition at line 113 of file CustomFields.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/CustomFields.cs