Select a site
Loading...

IMPORTANT: This version of Sitefinity CMS is out of support and the respective product documentation is no longer maintained and can be outdated. Use the version selector to view a supported product version.

Build a form widget: Implement the form widget class

You must inherit from the FieldControl class and the IFormFieldControl interface.

  1. Add a constructor.
  2. Add the public properties that show up in the dialog for Title, Description, and Example.
  3. Add properties for the controls added in the template.
  4. Using the GetDescriptors method, pass the controls client-side.
  5. Override the following abstract methods and properties:
    • InitializeControls method
      As with all Sitefinity CMS widgets that inherit from SimpleView, you must override the InitializeControls method. You can think of this as an alternative of the CreateChildControls method in custom ASP.NET controls.
      In this example, you are setting some labels and textbox values in the first method and using a helper method to get the current Sitefinity CMS user.
    • TitleControl property
      The property returns a control from the template of your widget control, which displays the title. When in Write mode, all field controls have a title, displayed in the backend form. In this example, you are getting the title of the widget from the TitleLabel.
    • DescriptionControl property
      The DescriptionControl must return a control from the template, which displays the description of your custom field control. You can have a different description in Read and Write mode. In this example, you are getting the description from a DescriptionLabel.
    • ExampleControl property
      The property returns a control from the template, which displays an example of the value that your field control expects from the user. In this example, you are getting the example from a ExampleLabel.
    • LayoutTemplateName property
      The LayoutTemplateName property is not specific to field controls, but to all widgets that inherit from SimpleView. This property is obsolete. You must use the LayoutTemplatePath instead. In this example, you can return null or String.Empty.
    • LayoutTemplatePath property
      Although it is not abstract, we recommend that you override the LayoutTemplatePath property. You must return a path to the template used by your widget. You can either use a path to an embedded resource or an external file. For more information, see VirtualPathProvider.
    • IFormFieldControl members
      • MetaField
        The property is used to persist data from the control to the database when form is submitted.  
        You can use complex properties with TypeConverter attribute that serializes to a primitive type.
      • Value
        The method is used to get and set the value of the widget.
        In this example, you are getting and setting the value from a textbox control.

Use the following code sample:

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Web.UI;
using System.Web.UI.WebControls;
using Telerik.Sitefinity.Data.Metadata;
using Telerik.Sitefinity.Metadata.Model;
using Telerik.Sitefinity.Model;
using Telerik.Sitefinity.Modules.Forms.Web.UI.Fields;
using Telerik.Sitefinity.Security;
using Telerik.Sitefinity.Security.Claims;
using Telerik.Sitefinity.Web.UI;
using Telerik.Sitefinity.Web.UI.ControlDesign;
using Telerik.Sitefinity.Web.UI.Fields;
using Telerik.Sitefinity.Web.UI.Fields.Enums;
namespace SitefinityWebApp.FormWidget
{
[DatabaseMapping(UserFriendlyDataType.ShortText)]
[PropertyEditorTitle("FormWidget Properties"), Telerik.Sitefinity.Web.UI.ControlDesign.ControlDesigner(typeof(SitefinityWebApp.FormWidget.Designer.FormWidgetDesigner))]
public class FormWidget : FieldControl, IFormFieldControl
{
public FormWidget()
{
this.Title = "FormWidget";
}
public override string Example { get; set; }
public override string Title { get; set; }
public override string Description { get; set; }
protected internal virtual Label TitleLabel
{
get
{
return this.Container.GetControl<Label>("titleLabel", true);
}
}
protected internal virtual Label DescriptionLabel
{
get
{
return Container.GetControl<Label>("descriptionLabel", true);
}
}
protected internal virtual Label ExampleLabel
{
get
{
return this.Container.GetControl<Label>("exampleLabel", this.DisplayMode == FieldDisplayMode.Write);
}
}
public override IEnumerable<ScriptDescriptor> GetScriptDescriptors()
{
var descriptor = new ScriptControlDescriptor(typeof(FormWidget).FullName, this.ClientID);
descriptor.AddElementProperty("textbox", this.TextBox1.ClientID);
descriptor.AddProperty("dataFieldName", this.MetaField.FieldName); //the field name of the corresponding widget
return new[] { descriptor };
}
protected override void InitializeControls(GenericContainer container)
{
// Set the label values
this.ExampleLabel.Text = this.Example;
this.TitleLabel.Text = this.Title;
this.DescriptionLabel.Text = this.Description;
this.TextBox1.Text = GetCurrentSitefinityUser();
}
private static string GetCurrentSitefinityUser()
{
var identity = ClaimsManager.GetCurrentIdentity();
var userId = identity.UserId;
if (userId != Guid.Empty)
{
var userProfile = UserProfileManager.GetManager().GetUserProfiles(userId).FirstOrDefault() as Telerik.Sitefinity.Security.Model.SitefinityProfile;
if (userProfile != null)
{
return userProfile.FirstName + " " + userProfile.LastName;
}
}
return String.Empty;
}
protected override WebControl TitleControl
{
get
{
return this.TitleLabel;
}
}
protected override WebControl DescriptionControl
{
get
{
return this.DescriptionLabel;
}
}
protected override WebControl ExampleControl
{
get
{
return this.ExampleLabel;
}
}
protected override string LayoutTemplateName
{
get
{
return string.Empty;
}
}
public override string LayoutTemplatePath
{
get
{
if (string.IsNullOrEmpty(base.LayoutTemplatePath))
return FormWidget.layoutTemplatePath;
return base.LayoutTemplatePath;
}
set
{
base.LayoutTemplatePath = value;
}
}
public static readonly string layoutTemplatePath = "SitefinityWebApp.FormWidget.FormWidget.ascx";
[TypeConverter(typeof(ExpandableObjectConverter))]
public IMetaField MetaField
{
get
{
if (this.metaField == null)
{
this.metaField = this.LoadDefaultMetaField();
}
return this.metaField;
}
set
{
this.metaField = value;
}
}
public override object Value
{
get
{
return this.TextBox1.Text;
}
set
{
this.TextBox1.Text = value.ToString();
}
}
protected virtual TextBox TextBox1
{
get
{
return this.Container.GetControl<TextBox>("TextBox1", true);
}
}
private IMetaField metaField = null;
public const string scriptReference = "~/FormWidget/FormWidget.js";
}
}
view raw FormWidget.cs hosted with ❤ by GitHub

Back To Top

Next: Build a form widget: Implement the template