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

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

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

namespace Mcs.Epm.MicrosoftProject.mpFx
{
    /// <summary>
    /// Wrapper class for Microsoft Project Server custom fields
    /// </summary>
    public class CustomFieldDefinition
    {
        #region Public Enums

        /// <summary>
        /// The attribute type
        /// </summary>
        public enum AttributeTypes
        {
            None,               //  Show just data
            LookupTable,        //  Backed by a lookup table
            Formula             //  Backed by a formulae
        }

        public enum DisplayTypes
        {
            None,               //  Not set
            Data,               //  Data
            GraphicalIndicators //  Indicators
        }

        #endregion
        
        #region Constructors

        /// <summary>
        /// Create an instance of CustomFieldDefinition with its name set
        /// </summary>
        /// <param name="name">The custom field's name</param>
        public CustomFieldDefinition(string name)
        {
            Name = name;
        }

        /// <summary>
        /// Given a CustomFieldDataSet.CustomFieldsRow, create an instance of CustomFieldDefinition
        /// </summary>
        /// <param name="customField">CustomFieldDataSet.CustomFieldsRow object</param>
        public CustomFieldDefinition(CustomFieldDataSet.CustomFieldsRow customField)
        {
            Type = (CustomField.Type) customField.MD_PROP_TYPE_ENUM;

            EntityGuid = customField.MD_ENT_TYPE_UID;
            Guid = customField.MD_PROP_UID;
            Name = customField.MD_PROP_NAME;
            IsRequired = customField.MD_PROP_IS_REQUIRED;
            
            if (!customField.IsMD_LOOKUP_TABLE_UIDNull())
            {
                AttributeType = AttributeTypes.LookupTable;
                LookupTableGuid = customField.MD_LOOKUP_TABLE_UID;

                if (!customField.IsMD_PROP_DEFAULT_VALUENull())
                {
                    DefaultValueGuid = customField.MD_PROP_DEFAULT_VALUE;
                }

                if (!customField.IsMD_PROP_IS_LEAF_NODE_ONLYNull())
                {
                    LeafOnly = customField.MD_PROP_IS_LEAF_NODE_ONLY;
                }

                if (!customField.IsMD_PROP_MAX_VALUESNull())
                {
                    MultiSelect = (CustomField.AcceptableMaxValues) customField.MD_PROP_MAX_VALUES;
                }
                
            } 
            else if (!customField.IsMD_PROP_FORMULANull())
            {
                AttributeType = AttributeTypes.Formula;
                Formula = customField.MD_PROP_FORMULA;
            }
            else
            {
                MultiSelect = CustomField.AcceptableMaxValues.DEFAULT;
                AttributeType = AttributeTypes.None;
            }

            if (!customField.IsMD_PROP_GRAPHICAL_INDICATORNull())
            {
                DisplayType = DisplayTypes.GraphicalIndicators;

                NonSummaryCriteriaString = customField.MD_PROP_GRAPHICAL_INDICATOR;
            }
            
            if (!customField.IsMD_PROP_PROJ_SUMM_GRAPHICAL_INDICATORNull())
            {
                DisplayType = DisplayTypes.GraphicalIndicators;

                ProjectSummaryCriteriaString = customField.MD_PROP_PROJ_SUMM_GRAPHICAL_INDICATOR;                
            }
            
            if (!customField.IsMD_PROP_SUMM_GRAPHICAL_INDICATORNull())
            {
                DisplayType = DisplayTypes.GraphicalIndicators;

                SummaryTaskCriteriaString = customField.MD_PROP_SUMM_GRAPHICAL_INDICATOR;                                
            }
            else
            {
                DisplayType = DisplayTypes.Data;
            }
            
            if (!customField.IsMD_PROP_GRAPHICAL_INDICATOR_TOOLTIPNull())
            {
                ShowValuesInTooltip = customField.MD_PROP_GRAPHICAL_INDICATOR_TOOLTIP;
            }
        }

        #endregion

        #region Public Properties

        /// <summary>
        /// Basic properties
        /// </summary>
        public CustomField.Type Type { get; set; }
        public Guid EntityGuid { get; set; } // MSProject.EntityCollection
        public Guid Guid { get; set; }
        public string Name { get; set; }
        public bool IsRequired { get; set; }
        public AttributeTypes AttributeType { get; set; }
        public DisplayTypes DisplayType { get; set; }

        //  Lookup table properties
        public Guid LookupTableGuid { get; set; }
        public Guid DefaultValueGuid { get; set; }
        public bool LeafOnly { get; set; }
        public CustomField.AcceptableMaxValues MultiSelect { get; set; }

        //  Formula properties
        public string Formula { get; set; }

        //  Graphical Indicators properties
        public string ProjectSummaryCriteriaString { get; set; }
        public string SummaryTaskCriteriaString { get; set; }
        public string NonSummaryCriteriaString { get; set; }
        public bool ShowValuesInTooltip { get; set; }

        #endregion
    }
}

---