Select a site

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.

Custom settings section: Implement the code-behind

  1. Open the Products module project in Visual Studio. 
  2. In the context menu of the ProductCatalogSample, click Add » Class.
  3. In the Name input field, enter CustomBasicSettingsView.
  4. Open the file and add the following namespaces:
    using System;
    using System.Web.UI;
    using Telerik.Sitefinity.Abstractions.VirtualPath;
    using Telerik.Sitefinity.Abstractions.VirtualPath.Configuration;
    using Telerik.Sitefinity.Configuration.Web.UI.Basic;
    using Telerik.Sitefinity.Configuration;
    using Telerik.Sitefinity.Web.UI.Fields;
    using Telerik.Sitefinity.Localization;
    using Telerik.Sitefinity.Modules.Forms;
  5. Change the class definition to:
    public class CustomBasicSettingsView : BasicSettingsView
        {
        }
  6. Reference the embedded template by pasting the following code into the class body:
    protected override string LayoutTemplateName
            {
                get
                {
                    return null;
                }
            }
     
            public override string LayoutTemplatePath
            {
                get
                {
                    if (string.IsNullOrEmpty(base.LayoutTemplatePath))
                        return CustomBasicSettingsView.layoutTemplateName;
                    return base.LayoutTemplatePath;
                }
                set
                {
                    base.LayoutTemplatePath = value;
                }
            }
     
            public static readonly string layoutTemplateName = GenerateVirtualPath("ProductCatalogSample.CustomBasicSettingsView.ascx");
  7. Because the basic settings view is created in a class library outside of the SitefinityWebApp, you must add logic to generate the virtual path obtained when registering the custom module:
    private static string GenerateVirtualPath(string path)
           {
               var virtualPathConfig = Telerik.Sitefinity.Configuration.Config.Get<VirtualPathSettingsConfig>();
               VirtualPathElement element = null;
               virtualPathConfig.VirtualPaths.TryGetValue("~/SFProducts/*", out element);
               if (element == null)
               {
                   var jobsModuleVirtualPathConfig = new VirtualPathElement(virtualPathConfig.VirtualPaths)
                   {
                       VirtualPath = "~/SFProducts/*",
                       ResolverName = "EmbeddedResourceResolver",
                       ResourceLocation = "ProductsModule"
                   };
                   virtualPathConfig.VirtualPaths.Add(jobsModuleVirtualPathConfig);
                   ConfigManager.GetManager().SaveSection(virtualPathConfig);
                   VirtualPathManager.Reset();
               }
               return "~/SFProducts/" + path;
           }
  8. Provide a property for accessing the DropDownField and CheckBoxesField ChoiceField controls.
  9. Provide a property for accessing the descriptionLiteral.
  10. Override the InitializeControls method in the following way:
    /// <inheritdoc />
            protected override void InitializeControls(System.Web.UI.Control viewContainer)
            {
                base.InitializeControls(viewContainer);
     
                BindDropDownField();
                BindCheckBoxesField();
     
                this.CustomSettingsDescriptionLabel.Text = string.Format(Res.Get<ProductsResources>().CustomSettingsDescription, akismetSampleLink);
     
            }

    In the sample above, the detailsLiteral is using a read-only variable pointing to the Akismet module in GitHub:

  11. Bind the two ChoiceField controls in the code-behind with some sample values.
    You can use the same approach by getting any content via the managers and bind the ChoiceField controls.
    Following are the code blocks of the two methods:
    private void BindDropDownField()
            {
                this.DropDownField.Choices.Clear();
     
                //adds a default value -Select-
                this.DropDownField.Choices.Add(
                    new ChoiceItem()
                    {
                        Text = string.Format("-{0}-", Res.Get<Labels>().Select),
                        Value = Guid.Empty.ToString()
                    });
                this.DropDownField.AddDefaultChoices();
            }

    private void BindCheckBoxesField()
            {
                this.CheckBoxesField.AddDefaultChoices();
            }

    You can implement an Extension method to bind the ChoiceField. This tutorial uses the AddDefaultChoices extension method in the following way:

    public static class ChoiceFieldExtensions
        {
            public static void AddDefaultChoices(this ChoiceField choiceField)
            {
                choiceField.Choices.Add(new ChoiceItem() { Text = Res.Get<FormsResources>().FirstChoice, Value = Res.Get<FormsResources>().FirstChoice });
                choiceField.Choices.Add(new ChoiceItem() { Text = Res.Get<FormsResources>().SecondChoice, Value = Res.Get<FormsResources>().SecondChoice });
                choiceField.Choices.Add(new ChoiceItem() { Text = Res.Get<FormsResources>().ThirdChoice, Value = Res.Get<FormsResources>().ThirdChoice });
            }
        }
  12. Override the GetScriptDescriptors method in the following way:
    /// <inheritdoc />
    protected override ScriptControlDescriptor GetScriptDescriptor()
    {
        return new ScriptControlDescriptor(this.GetType().FullName, this.ClientID);
    }

Back To Top

Next: Custom settings section: Additional resources required