Area: Episerver Commerce
Applies to versions: 10 and higher
Other versions:

Working with meta-field controls

Recommendations [hide]

Meta-field controls are rendered for custom fields. You can see examples of them when editing an entry or catalog nodes in the Catalog Management subsystem (legacy). This topic explains how to extend and customize meta-field controls.

How it works  

Meta-fields are rendered using default controls defined in the Admin/Apps/Core/MetaData/Controls/ folder. For example, the meta-field string is rendered using ShortStringControl.ascx.

You may have more specific data entry constraints than the default controls. For example, you want to add a custom status text field and ensure that only specific values are submitted. You want to keep it a simple string field in the database (to improve performance), but also want to prevent users from entering invalid data.

The simplest way to do this is to:

  1. Create a new custom user control (copy ShortStringControl.ascx).
  2. Change the textbox to a drop-down control with hard-coded values.
  3. Have the system use your control instead of the default one. To do that, the name of the control must match the name and metadata type of the meta-field to which you are mapping the control. See table and description below.

Another example is: you want to override ImplementationStatus fields with a metadata field type of ShortString. You can do this as follows:

  1. Name the control ImplementationStatus.ShortStringControl.ascx.
  2. Create the ImplementationStatus meta-field as a Short String in the Catalog portion of the Administration tab.
  3. Add the field to a meta-class.

When you edit a catalog entry with this meta-class (containing the ImplementationStatus field), the field is represented with your custom control.

Note: If using custom meta-fields (such as year) with search filters in places like the Shopping Options sidebar control, use the Float type instead of Decimal.

The engine lets you override how the meta-field is rendered for the scopes listed in the following table. The position reflects the order engine validating the controls, if the control exists, which renders the field and evaluation stops.

Scope Control name
Specific meta field name in particular meta class MetaClassName.MetaFieldName.TypeName.ascx
 Specific meta field name for all meta classes MetaFieldName.TypeName.ascx
 Specific meta class MetaClassName.TypeName.ascx
 Default  TypeName.ascx
Do you find this information helpful? Please log in to provide feedback.

Last updated: Oct 24, 2016

Recommendations [hide]