Topics

All topics

Site components

Create yes/no 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 yes/no choice field:

  • Field CLR type: typeof(bool).FullName
  • User friendly data type: UserFriendlyDataType.YesNo
  • DB type: BIT
  • Field type: typeof(ChoiceField).FullName

When creating a yes/no field you must also perform the following in:

  • Where you set the properties of the field definition, you must set additional property RenderChoiceAs. It gets or sets how the choices are rendered in the UI. Set this property to the following value: RenderChoicesAs.SingleCheckBox.
  • Where you create the field definition, you must also create a choice item that represents the yes/no question.
    To do this perform the following:
    1. Create an instance of the ChoiceItem class.
    2. Set the Text property of the instance to the question.
    3. Set the Value property of the instance to true.
    4. Add the item to a List of ChoiceItem.
    5. Serialize the list using a JavaScriptSerializer instance.
    6. Set the Choices property of the WcfFieldDefinition instance to the serialized value.

Use the following code example:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
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;
using Telerik.Sitefinity.Web.UI.Fields.Enums;
namespace SitefinityWebApp
{
public class CreateYesNoFieldOfProducts
{
public static void CreateYesNoField(Guid productTypeId, string fieldName, string fieldLabel, string question)
{
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(bool).FullName;
UserFriendlyDataType userFriendlyDataType = UserFriendlyDataType.YesNo;
var wcfField = new WcfField()
{
Name = fieldName,
ContentType = productClrType.FullName,
FieldTypeKey = userFriendlyDataType.ToString(),
IsCustom = true,
//Database mapping
DatabaseMapping = new WcfDatabaseMapping()
{
ClrType = fieldClrType,
ColumnName = fieldName.ToLower(),
Nullable = true,
DbType = "BIT"
},
//Field definition
Definition = new WcfFieldDefinition()
{
Title = fieldLabel,
FieldName = fieldName,
FieldType = typeof(ChoiceField).FullName,
RenderChoiceAs = RenderChoicesAs.SingleCheckBox
}
};
ChoiceItem yesNoItem = new ChoiceItem()
{
Text = question,
Value = "true",
Selected = false
};
List<ChoiceItem> items = new List<ChoiceItem>();
items.Add(yesNoItem);
JavaScriptSerializer serializer = new JavaScriptSerializer();
wcfField.Definition.Choices = serializer.Serialize(items);
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 CreateYesNoFieldOfProducts.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 classification fields