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

/*  ----------------------------------------------------------------------------
 *  Microsoft Corporation
 *  ----------------------------------------------------------------------------
 *  Microsoft Project Server mpFx (mpFx)
 *  ----------------------------------------------------------------------------
 *  Author: Colby Africa
 *  ----------------------------------------------------------------------------
 *  License: http://code.msdn.microsoft.com/mpFx/Project/License.aspx
 *  ----------------------------------------------------------------------------
 */

using System;
using System.Collections;
using System.Collections.Generic;
using System.Globalization;
using Mcs.Epm.MicrosoftProject.mpFx.CustomFieldsWebService;
using Microsoft.Office.Project.Server.Library;

namespace Mcs.Epm.MicrosoftProject.mpFx
{
    /// <summary>
    /// Provides data and functionality for using enterprise custom fields
    /// </summary>
    public class CustomFields : IEnumerable<Guid>
    {
        #region Static Methods

        /// <summary>
        /// Get a custom field type from its name
        /// </summary>
        /// <param name="name">The name of the custom field</param>
        /// <returns></returns>
        public static CustomField.Type GetTypeFromName(string name)
        {
            name = name.ToUpper(CultureInfo.InvariantCulture);

            foreach (CustomField.Type type in Enum.GetValues(typeof(CustomField.Type)))
            {
                if (type.ToString().ToUpper(CultureInfo.InvariantCulture) == name)
                {
                    return type;
                }
            }

            throw new IndexOutOfRangeException("name");
        }

        #endregion

        #region Private Static Methods

        /// <summary>
        /// Transform a custom field definition into a custom fields row
        /// </summary>        
        /// <param name="customFieldDefinition">The custom field definition</param>
        /// <param name="customField">The custom field row</param>
        /// <returns></returns>
        private static CustomFieldDataSet.CustomFieldsRow TransformDefintionToPsiField(CustomFieldDefinition customFieldDefinition, ref CustomFieldDataSet.CustomFieldsRow customField)
        {
            customField.MD_PROP_UID = customFieldDefinition.Guid;
            customField.MD_ENT_TYPE_UID = customFieldDefinition.EntityGuid;
            customField.MD_PROP_NAME = customFieldDefinition.Name;
            customField.MD_PROP_IS_REQUIRED = customFieldDefinition.IsRequired;
            customField.MD_PROP_TYPE_ENUM = (byte)customFieldDefinition.Type;
            customField.MD_PROP_MAX_VALUES = (int)customFieldDefinition.MultiSelect;

            if (customFieldDefinition.LookupTableGuid != Guid.Empty)
            {
                customField.MD_PROP_IS_LEAF_NODE_ONLY = customFieldDefinition.LeafOnly;
                customField.MD_LOOKUP_TABLE_UID = customFieldDefinition.LookupTableGuid;

                if (customFieldDefinition.DefaultValueGuid == Guid.Empty)
                {
                    customField.SetMD_PROP_DEFAULT_VALUENull();
                }
                else
                {
                    customField.MD_PROP_DEFAULT_VALUE = customFieldDefinition.DefaultValueGuid;
                }
            }

            customField.MD_PROP_MAX_VALUES = (int)customFieldDefinition.MultiSelect;

            customField.MD_PROP_GRAPHICAL_INDICATOR = customFieldDefinition.NonSummaryCriteriaString;
            customField.MD_PROP_SUMM_GRAPHICAL_INDICATOR = customFieldDefinition.ProjectSummaryCriteriaString;
            customField.MD_PROP_PROJ_SUMM_GRAPHICAL_INDICATOR = customFieldDefinition.ProjectSummaryCriteriaString;

            customField.MD_PROP_GRAPHICAL_INDICATOR_TOOLTIP = customFieldDefinition.ShowValuesInTooltip;

            return customField;
        }

        #endregion

        #region Instance Data

        private Dictionary<Guid, string> _CustomFieldsCollection;

        #endregion

        #region Internal Properties

        protected internal ProjectServer Parent { get; private set; }

        #endregion

        #region Public Properties

        /// <summary>
        /// Get a simple dictionary of calendar GUIDs and Names
        /// </summary>
        public Dictionary<Guid, string> CustomFieldsCollection
        {
            get
            {
                if (_CustomFieldsCollection == null)
                {
                    LoadCustomFields();
                }

                return _CustomFieldsCollection;
            }
            set
            {
                _CustomFieldsCollection = value;
            }
        }

        #endregion

        #region Constructor

        /// <summary>
        /// Create an instance of Calendars
        /// </summary>
        /// <param name="parent">Parent Object</param>
        public CustomFields(ProjectServer parent)
        {
            if (parent == null)
            {
                throw new ArgumentNullException("parent");
            }

            Parent = parent;
        }

        #endregion     

        #region Public Methods

        ///<summary>
        ///Returns an enumerator that iterates through the collection.
        ///</summary>
        ///
        ///<returns>
        ///A <see cref="T:System.Collections.Generic.IEnumerator`1"></see> that can be used to iterate through the collection.
        ///</returns>
        ///<filterpriority>1</filterpriority>
        public IEnumerator<Guid> GetEnumerator()
        {
            if (_CustomFieldsCollection == null)
            {
                LoadCustomFields();
            }

            foreach (KeyValuePair<Guid, string> valuePair in CustomFieldsCollection)
            {
                yield return valuePair.Key;
            }
        }

        /// <summary>
        /// Return a custom field row for the specified custom field
        /// </summary>
        /// <param name="propertyGuid">The custom field property GUID</param>
        /// <returns>CustomFieldDataSet.CustomFieldsRow</returns>
        public CustomFieldDataSet.CustomFieldsRow GetCustomFieldInfo(Guid propertyGuid)
        {
            string filter = CustomFieldFilters.CreateGetAllInfoFilter(propertyGuid);

            using (CustomFieldDataSet customFieldDataSet = Parent.WebServices.CustomFields.ReadCustomFields(filter, false))
            {
                if (customFieldDataSet != null && customFieldDataSet.CustomFields.Rows.Count == 1)
                {
                    return customFieldDataSet.CustomFields[0];                    
                }
                return null;
            }   
        }

        /// <summary>
        /// Get a custom field dataset for the specified custom field
        /// </summary>
        /// <param name="propertyGuid">The custom field property GUID</param>
        /// <returns>CustomFieldDataSet</returns>
        public CustomFieldDataSet GetCustomFieldDataSet(Guid propertyGuid)
        {
            string filter = CustomFieldFilters.CreateGetAllInfoFilter(propertyGuid);

            using (CustomFieldDataSet customFieldDataSet = Parent.WebServices.CustomFields.ReadCustomFields(filter, false))
            {
                return customFieldDataSet;
            }               
        }

        /// <summary>
        /// Check out a collection of custom fields
        /// </summary>
        /// <param name="propertyGuids">An array of custom field GUIDs</param>
        public void CheckOut(Guid[] propertyGuids)
        {
            Parent.WebServices.CustomFields.CheckOutCustomFields(propertyGuids);
        }

        /// <summary>
        /// Check in a custom field
        /// </summary>
        /// <param name="propertyGuid">The custom field property GUID</param>
        /// <param name="force">True to force the check-in</param>
        public void CheckIn(Guid propertyGuid, bool force)
        {
            Parent.WebServices.CustomFields.CheckInCustomFields(new[] { propertyGuid }, force);
        }

        /// <summary>
        /// Create a custom field from a custom field definition
        /// </summary>
        /// <param name="customFieldDefinition">The custom field definition</param>
        /// <param name="validateOnly">True to validate only</param>
        /// <param name="autoCheckin">True to automatically check in after creation</param>
        public void Create(CustomFieldDefinition customFieldDefinition, bool validateOnly, bool autoCheckin)
        {
            using (CustomFieldDataSet customFieldDataSet = new CustomFieldDataSet())
            {
                Guid mdPropUID = Guid.NewGuid();

                CustomFieldDataSet.CustomFieldsRow customField = customFieldDataSet.CustomFields.NewCustomFieldsRow();

                customField = TransformDefintionToPsiField(customFieldDefinition, ref customField);
                customField.MD_PROP_UID = mdPropUID;

                customFieldDataSet.CustomFields.AddCustomFieldsRow(customField);

                Parent.WebServices.CustomFields.CreateCustomFields(customFieldDataSet, validateOnly, autoCheckin);
            }
        }

        /// <summary>
        /// Delete custom fields
        /// </summary>
        /// <param name="propertyGuids">An array of custom field GUIDs</param>
        public void Delete(Guid[] propertyGuids)
        {
            Parent.WebServices.CustomFields.DeleteCustomFields(propertyGuids);
        }

        /// <summary>
        /// Update a custom field from a definition
        /// </summary>
        /// <param name="customFieldDataSet">The CustomFieldDataSet</param>
        /// <param name="customFieldDefinition">The custom field definition</param>
        /// <param name="validateOnly">True to validate only</param>
        /// <param name="autoCheckin">True to automatically check in after creation</param>
        public void Update(CustomFieldDataSet customFieldDataSet,
                           CustomFieldDefinition customFieldDefinition,
                           bool validateOnly,
                           bool autoCheckin)
        {

            CustomFieldDataSet.CustomFieldsRow customField = customFieldDataSet.CustomFields.FindByMD_PROP_UID(customFieldDefinition.Guid);

            TransformDefintionToPsiField(customFieldDefinition, ref customField);

            Parent.WebServices.CustomFields.UpdateCustomFields(customFieldDataSet, validateOnly, autoCheckin);
        }

        /// <summary>
        /// Update custom fields
        /// </summary>
        /// <param name="customFieldDataSet">The CustomFieldDataSet</param>
        /// <param name="validateOnly">True to validate only</param>
        /// <param name="autoCheckin">True to automatically check in after creation</param>
        public void Update(CustomFieldDataSet customFieldDataSet, bool validateOnly, bool autoCheckin)
        {
            Parent.WebServices.CustomFields.UpdateCustomFields(customFieldDataSet, validateOnly, autoCheckin);
        }

        /// <summary>
        /// Determine if the custom field collection contains a specific property GUID 
        /// </summary>
        /// <param name="propertyGuid">The property GUID to look for</param>
        /// <returns>True if contains key, false otherwise</returns>
        public bool ContainsKey(Guid propertyGuid)
        {
            return CustomFieldsCollection.ContainsKey(propertyGuid);
        }

        #endregion

        #region Private Methods

        ///<summary>
        ///Returns an enumerator that iterates through a collection.
        ///</summary>
        ///
        ///<returns>
        ///An <see cref="T:System.Collections.IEnumerator"></see> object that can be used to iterate through the collection.
        ///</returns>
        ///<filterpriority>2</filterpriority>
        IEnumerator IEnumerable.GetEnumerator()
        {
            return ((IEnumerable<Guid>) this).GetEnumerator();
        }

        #endregion

        #region Internal Methods

        /// <summary>
        /// Load custom field information from Project Server
        /// </summary>
        internal void LoadCustomFields()
        {
            if (_CustomFieldsCollection == null)
            {
                _CustomFieldsCollection = new Dictionary<Guid, string>();
            }
            else
            {
                _CustomFieldsCollection.Clear();
            }

            using (CustomFieldDataSet customFieldDataSet = Parent.WebServices.CustomFields.ReadCustomFields(CustomFieldFilters.ListMinimumInformation, false))
            {
                foreach (CustomFieldDataSet.CustomFieldsRow customField in customFieldDataSet.CustomFields.Rows)
                {
                    _CustomFieldsCollection.Add(customField.MD_PROP_UID, customField.MD_PROP_NAME);
                }
            }
        }

        #endregion

        #region Public Indexers

        public string this[Guid guid]
        {
            get { return CustomFieldsCollection[guid]; }
        }        

        #endregion

    }
}

---