Skip to main content

Create custom data attribute for Sitecore 9 Form Field

Create custom data attribute for Sitecore 9 Form Field

attribute, custom data attribute, form, forms, Sitecore, sitecore9,

Sitecore Forms provides you default form field like Text, Single-line text, Multi-line text, Email, Telephone, Checkbox except this it is very easy to create our custom Sitecore form field and custom Sitecore form field attribute.

In this blog, we are going to discuss how to create custom Sitecore form field attribute in existing Single-line text.

  • Move to the location /sitecore/templates/System/Forms/Fields/Field and add CustomAttribute field with Single-Line Text
attribute, custom data attribute, forms, Sitecore, sitecore9, form

  • Switch to Core db and go to this location /sitecore/client/Applications/FormsBuilder/Components/Layouts/PropertyGridForm/PageSettings/Common/Styling
  • Create duplication item of CssClass and rename it with CustomAttribute
  • Update FormLabel to Custom Attribute
  • Add BindingConfiguration to customAttribute
attribute, custom data attribute, forms, Sitecore, sitecore9, form
  • Now go to this location "/sitecore/client/Applications/FormsBuilder/Components/Layouts/PropertyGridForm/PageSettings/Settings/SingleLineText/Details" in core DB and in ControlDefinitions field select CustomAttribute which you have created 
  • Now create new custom view model CustomSingleLineViewModel in your code
   public class CustomSingleLineViewModel : StringInputViewModel  
     public string CustomAttribute { get; set; }  
     protected override void InitItemProperties(Item item)  
       CustomAttribute = StringUtil.GetString(item.Fields["CustomAttribute"]);  
     protected override void UpdateItemFields(Item item)  

  • Now go to this location Views\FormBuilder\FieldTemplates and open SingleLineText.cshtml
  • Update cshtml code and replace namespace
 @using Sitecore.ExperienceForms.Mvc.Html  
 @model Sitecore.Foundation.Forms.Fields.CustomSingleLineViewModel  
 <label for="@Html.IdFor(m => Model.Value)" class="@Model.LabelCssClass custom-form__label" custom-attribute="@Model.CustomAttribute">@Html.DisplayTextFor(t => Model.Title)</label>  
 <input id="@Html.IdFor(m => Model.Value)" name="@Html.NameFor(m => Model.Value)" class="@Model.CssClass form-control form-control__primary" type="text" value="@Model.Value" @if (Model.MaxLength > 0) { <text> maxlength="@Model.MaxLength" </text> } placeholder="@Model.PlaceholderText" data-sc-tracking="@Model.IsTrackingEnabled" data-sc-field-name="@Model.Name" @Html.GenerateUnobtrusiveValidationAttributes(m => m.Value) />  
 @Html.ValidationMessageFor(m => Model.Value)  

  • In master db, move into this location /sitecore/system/Settings/Forms/Field Types/Basic/Single-Line Text and update Model Type with new viewmodel
attribute, custom data attribute, forms, Sitecore, sitecore9, form

  • Go to Form explorer and create new form and drag Single-line text
  • Now you can see Custom Attribute field
attribute, custom data attribute, forms, Sitecore, sitecore9, form

attribute, custom data attribute, forms, Sitecore, sitecore9, form


gurjot said…
HI Swati,
I have a requirement - 3 dropdown fields where input of 1 is dependent on others.
eg - DD1 - companies- > (load only relevant products), DD2 - Products, (on bases of State selected, load relevant regions). DD3 - Regions. so the cases will be like nxnxn as if user slects dd2 firts and i have to update other 2 acc to the dd value.

I am using Sitecore 9 update 1, and I am thinking to call Ajax method on change of any of the dd field. Do you have any source where I can find the relevant solution and how to hit ajax and load lists.
Swati Gupta said…
You can follow this document I hope this will work in your case
gurjot said…
Hi Swati,

Sorry for replying way too late.
Actually I was able to pull up this by Sitecore Knowledge article and your blog.
Thanks for the help :)
Unknown said…
Hi Swati/gurjot,

Apologies for asking this here. I had the same requirement about the dropdown.The above link doesn't seem to work. Could you please provide an article for this?

Popular posts from this blog

Sitecore Certification Sample Questions

Sitecore Certification Sample Questions I have completed the Sitecore 9 certification in 2019 and Sitecore 8.2 Certification in 2018. Let me tell you if you have some knowledge about Sitecore then it will be easier for you to understand questions and clear certification exam. Your main focus should be to understand the questions and answers carefully because it is too confusing There will be two options to give the exam: Install the software in your laptop (Laptop should have mic and webcam) Authorized training Center If you have proper Internet, then you can choose option 1 otherwise option 2 is a good choice. Disclaimer : Please note that the below question is only for information purpose only. Below question does not claim the accuracy of the content. Sample Questions: Question 1: What is the name of Component architecture guideline of Sitecore? Answer : Helix Question 2 : What is horizontal scaling and vertical scaling? Answer :  https://doc.

Sitecore 9 Forms: Google reCaptcha field

Sitecore 9 Forms: Google reCaptcha field  Re-Captcha is the most important part of any form’s submission. Google reCaptcha run internet bot detector and determined whether a user is a bot or not.  Sitecore Forms does not provide Google reCaptcha field, which was available in WFFM before, so I have created my custom Google reCaptcha.   Below you can find step by step process to create Google reCaptcha field. Create patch config for reCaptcha Sitekey and SecretKey <?xml version="1.0"?> <configuration xmlns:patch="" xmlns:set=""> <sitecore> <settings> <setting name="ReCaptchaSiteKey" value="site-key" /> <setting name="ReCaptchaSecretKey" value="secret-key" /> </settings> </sitecore> </configuration> Create new viewmodel class RecaptchaViewMode

Create Sitecore Custom Admin Page

Create Sitecore Custom Admin Page Sitecore provides you lots of Admin pages just like ShowConfig.aspx, cache.aspx, Logs.aspx, howServicesConfig.aspx, etc. which you can check from here http://<yoursite>/sitecore/admin/. All Sitecore Admin pages is available in this folder “sitecore/admin/*” Sometimes there can be requirement that you want to create custom Admin page which will be accessible to Admin/Non-Admin user. Here is an example: Create aspx page “CustomAdminPage.aspx” inside “<root>/sitecore/admin” folder <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="CustomAdminPage.aspx.cs" Inherits="Namespace.CustomAdminPage" %> <!DOCTYPE html> <html xmlns=""> <head runat="server"> <title>Custom Admin Page</title> <link rel="stylesheet" type="text/css" href="/sitecore/she