Wednesday, May 18, 2011

Microsoft Dynamics CRM 2011 Plugin - How to Retrieve OptionSets Label Text

In Microsoft Dynamics CRM 4 it was easier to retrieve Picklist data labels in Plugins but in CRM 2011 as Picklist is replaced by OptionsSet and in plugin we can no longer retrieve Picklist label form the entity attribute property bag. The Plugin sample code below contains helper methods that can be used to fetch the OptionSet label value.

 [C# Plugin Code]


using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Microsoft.Xrm.Sdk;
using Microsoft.Crm.Sdk;
using Microsoft.Xrm.Sdk.Query;
using Microsoft.Xrm.Sdk.Messages;

namespace WOD.Crm.AutoNumbering
{
    public class wod_Plugin : IPlugin
    {

        public void Execute(IServiceProvider serviceProvider)
        {
            // Obtain the execution context from the service provider.
            Microsoft.Xrm.Sdk.IPluginExecutionContext context = (Microsoft.Xrm.Sdk.IPluginExecutionContext)
                serviceProvider.GetService(typeof(Microsoft.Xrm.Sdk.IPluginExecutionContext));

            // Obtain the CRM Service Factor and Organization Service Objects.
            IOrganizationServiceFactory wod_serviceFactory = (IOrganizationServiceFactory)serviceProvider.GetService(typeof(IOrganizationServiceFactory));
            IOrganizationService wod_CrmService = wod_serviceFactory.CreateOrganizationService(context.UserId);

            // Checking if Input Target is Entity Object.
if (context.InputParameters.Contains("Target") &&
                    context.InputParameters["Target"] is Entity)
                {
                    // Obtain the target entity from the input parameters.
                    Entity entity = (Entity)context.InputParameters["Target"];

                    // 1st Parameter is CRM Service Object, 2nd is Entity Logical Name,  
                    // 3rd is OptionSet name and 4th is OptionSet value.  

                    string wod_labelValue = wodRetrieveOptionSetLabel(wod_CrmService, wod_Entity.LogicalName, "wod_date_position", 10231);
                }
        }

         // Method to retrieve OptionSet label value
        Private string wodRetrieveOptionSetLabel(IOrganizationService CrmWebService, string prmEntityName, string prmAttributeName, int prmOptionSetValue)
        {
            string wod_ReturnLabel = string.Empty;

            OptionMetadataCollection wod_OptionsSetLabels = null;

            wod_OptionsSetLabels = wodRetrieveOptionSetMetaDataCollection(ref CrmWebService, prmEntityName, prmAttributeName);

            foreach (OptionMetadata wod_OptionMetdaData in wod_OptionsSetLabels)
            {
                if (wod_OptionMetdaData.Value == prmOptionSetValue)
                {
                    wod_ReturnLabel = wod_OptionMetdaData.Label.UserLocalizedLabel.Label;
                    break;
                }
            }

            return wod_ReturnLabel;
        }

         // Method to Retrieve OptionSet Options Metada Data Collection.
        Private OptionMetadataCollection wodRetrieveOptionSetMetaDataCollection( IOrganizationService CrmWebService, string prmEntityName, string prmAttributeName)
        {

            OptionMetadataCollection wod_ReturnOptionsCollection = null;
            RetrieveEntityRequest wod_RetrieveEntityRequest = new RetrieveEntityRequest();
            RetrieveEntityResponse wod_RetrieveEntityResponse = new RetrieveEntityResponse();

            wod_RetrieveEntityRequest.LogicalName = prmEntityName;

            wod_RetrieveEntityRequest.EntityFilters = Microsoft.Xrm.Sdk.Metadata.EntityFilters.Attributes;

            wod_RetrieveEntityResponse = (RetrieveEntityResponse)CrmWebService.Execute(wod_RetrieveEntityRequest);

            foreach (AttributeMetadata wod_AttributeMetadata in wod_RetrieveEntityResponse.EntityMetadata.Attributes)
            {
                if (wod_AttributeMetadata.AttributeType == AttributeTypeCode.Picklist &&
                    wod_AttributeMetadata.LogicalName == prmAttributeName)
                {
                    wod_ReturnOptionsCollection = ((PicklistAttributeMetadata)wod_AttributeMetadata).OptionSet.Options;
                    break;
                }
            }

            return wod_ReturnOptionsCollection;
        }

    }
}


No comments:

Post a Comment

Post a Comment