Topics

All topics

Site components

Create multiple choice fields
Development

To learn more about the different steps to create a custom field, read the For developers: Create custom fields for product types article.

Here is a list of the things that are specific for the multiple choice field:

  • Field CLR type: typeof(string).FullName
  • User friendly data type: UserFriendlyDataType.MultipleChoice
  • DB type: VARCHAR
  • Field type: typeof(ChoiceField).FullName

When creating a multiple choice field, where you create the field definition, you must also create the available choices for the field.

To do this perform the following:

  1. For each choice create an instance of the ChoiceItem class.
  2. Set the Text and Value properties of the instance.
  3. Add the items to a List of ChoiceItem.
  4. Serialize the list using a JavaScriptSerializer instance.
  5. Set the Choices property of the WcfFieldDefinition instance to the serialized value.

NOTE: When creating a multiple choice field, store your choices into an enumeration. The choices are not stored in the MetaField instance. The enumeration will help you work with the choices when setting or getting the value of the field via code.

Use the following code example:

using System;
using System.Collections.Generic;
using System.Web.Script.Serialization;
using Telerik.Sitefinity.Data.Metadata;
using Telerik.Sitefinity.Ecommerce.Catalog.Model;
using Telerik.Sitefinity.Metadata.Model;
using Telerik.Sitefinity.Model;
using Telerik.Sitefinity.ModuleEditor.Web.Services.Model;
using Telerik.Sitefinity.Modules.Ecommerce.Common;
using Telerik.Sitefinity.Utilities.TypeConverters;
using Telerik.Sitefinity.Web.UI.Fields;
namespace SitefinityWebApp
{
public class CreateMultichoiceFieldOfProduct
{
public static void CreateMultichoiceField(Guid productTypeId, string fieldName, string fieldLabel, List<string> choices)
{
EcommerceManager ecommerceManager = EcommerceManager.GetManager();
ProductType productType = ecommerceManager.GetProductType(productTypeId);
if (productType == null)
{
return; //The product type does not exist.
}
Type productClrType = TypeResolutionService.ResolveType(productType.ClrType);
string fieldClrType = typeof(string).FullName;
UserFriendlyDataType userFriendlyDataType = UserFriendlyDataType.MultipleChoice;
var wcfField = new WcfField()
{
Name = fieldName,
ContentType = fieldClrType,
FieldTypeKey = userFriendlyDataType.ToString(),
IsCustom = true,
//Database mapping
DatabaseMapping = new WcfDatabaseMapping()
{
ClrType = fieldClrType,
ColumnName = fieldName.ToLower(),
Nullable = true,
DbType = "VARCHAR"
},
//Field definition
Definition = new WcfFieldDefinition()
{
Title = fieldLabel,
FieldName = fieldName,
FieldType = typeof(ChoiceField).FullName,
}
};
List<ChoiceItem> choiceItems = new List<ChoiceItem>();
foreach (string choice in choices)
{
ChoiceItem choiceItem = new ChoiceItem()
{
Text = choice,
Value = choice,
Selected = false
};
choiceItems.Add(choiceItem);
}
JavaScriptSerializer serializer = new JavaScriptSerializer();
wcfField.Definition.Choices = serializer.Serialize(choiceItems);
CustomFieldsContext.Validate(wcfField, productClrType);
var typeContext = new CustomFieldsContext(productClrType.FullName);
typeContext.SaveFieldDefinition(wcfField, productClrType.Name, null);
typeContext.SaveChanges();
using (MetadataManager metadataManager = MetadataManager.GetManager())
{
MetaType metaType = metadataManager.GetMetaType(productClrType);
MetaField metaField = metadataManager.CreateMetafield(fieldName);
CustomFieldsContext.SetFieldDatabaseMappings(metaField, metaType, userFriendlyDataType, wcfField, metadataManager);
metaField.Title = fieldLabel;
metaField.MetaAttributes.Add(new MetaFieldAttribute { Name = "UserFriendlyDataType", Value = userFriendlyDataType.ToString() });
metaField.MetaAttributes.Add(new MetaFieldAttribute { Name = "IsCommonProperty", Value = "true" });
metaType.Fields.Add(metaField);
metadataManager.SaveChanges();
}
//SystemManager.RestartApplication(false);
}
}
}
view raw CreateMultichoiceFieldOfProduct.cs hosted with ❤ by GitHub

Want to learn more?

Increase your Sitefinity skills by signing up for our free trainings. Get Sitefinity-certified at Progress Education Community to boost your credentials.

Get started with Integration Hub | Sitefinity Cloud | Sitefinity SaaS

This free lesson teaches administrators, marketers, and other business professionals how to use the Integration hub service to create automated workflows between Sitefinity and other business systems.

Web Security for Sitefinity Administrators

This free lesson teaches administrators the basics about protecting yor Sitefinity instance and its sites from external threats. Configure HTTPS, SSL, allow lists for trusted sites, and cookie security, among others.

Foundations of Sitefinity ASP.NET Core Development

The free on-demand video course teaches developers how to use Sitefinity .NET Core and leverage its decoupled architecture and new way of coding against the platform.

Was this article helpful?

Next article

Create yes/no fields