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.

Testimonials module: Create the widget designer for the Submit testimonial view

After you Testimonials module: Create the Testimonials view, you need to create the Submit testimonial view widget designer. 

Create the custom widget

To create the class for the view, perform the following.

  1. In Visual Studio, in Solution Explorer, open the context menu of folder ControlDesigners and click Add » Class...
  2. In the Name input field, enter SubmitTestimonialDesigner.
  3. Add the following namespaces in the new class:
    using System.Collections.Generic;
    using System.Web.UI;
    using Telerik.Sitefinity.Web.UI.ControlDesign;
  4. Change the class definition to:
    public class SubmitTestimonialDesigner : ControlDesignerBase
    {
     
    }
  5. Save the file.

Create the template

To create the template of the designer view, perform the following:

  1. In the context menu of folder ControlDesigners, click Add » Class...
  2. In the Name input field, enter SubmitTestimonialDesignerTemplate.ascx and click Add.
  3. Open the newly created file and clear its content.
  4. Define the markup by pasting the following code:
    <div class="sfContentViews">
        <div id="RotatorOptions">
            <div>
                <div id="groupSettingPageSelect">
                        <ul class="sfTargetList">
                            <li>
                                <label for="AutoPublish" class="sfTxtLbl">Auto-Publish Testimonials</label>
                                <input type="checkbox" id="AutoPublish" />
                            </li>
                        </ul>
                </div>
            </div>
        </div>
    </div>
  5. Save the file.

In the markup above, you defined a field for controlling whether to auto publish the testimonial.

Implement the ControlDesignerBase class

To implement the ControlDesignerBase class in the SubmitTestimonialDesigner.cs file, perform the following:

  1. Reference the embedded template by pasting the following code into SubmitTestimonialDesigner.cs:
    private string _layoutTemplatePath = "~/Modules/Testimonials/ControlDesigners/SubmitTestimonialDesignerTemplate.ascx";
     
    public override string LayoutTemplatePath
    {
        get { return _layoutTemplatePath; }
        set { _layoutTemplatePath = value; }
    }
     
    protected override string LayoutTemplateName
    {
        get { return null; }
    }
  2. Override the InitializeControls method by pasting the following code:
    protected override void InitializeControls(Telerik.Sitefinity.Web.UI.GenericContainer container)
    {
        base.DesignerMode = ControlDesignerModes.Simple;
    }
  3. Save the file.

Implement the client component

You must store the client class in a JavaScript file in the project. The JavaScript file is where the view is located.

To create the file, perform the following:

  1. In the context menu of folder ControlDesigners, click Add » New Item...
  2. In the left pane, select Visual C# Items » Web.
  3. Click JScript File and in the Name input field, enter SubmitTestimonialDesigner.
  4. Open the newly created file.
  5. Add the following code to it:
    Type.registerNamespace("SitefinityWebApp.Modules.Testimonials.ControlDesigners");
     
    SitefinityWebApp.Modules.Testimonials.ControlDesigners.SubmitTestimonialDesigner = function (element) {
        SitefinityWebApp.Modules.Testimonials.ControlDesigners.SubmitTestimonialDesigner.initializeBase(this, [element]);
    }
     
     
    SitefinityWebApp.Modules.Testimonials.ControlDesigners.SubmitTestimonialDesigner.prototype = {
        initialize: function () {
            SitefinityWebApp.Modules.Testimonials.ControlDesigners.SubmitTestimonialDesigner.callBaseMethod(this, 'initialize');
     
        },
        dispose: function () {
            SitefinityWebApp.Modules.Testimonials.ControlDesigners.SubmitTestimonialDesigner.callBaseMethod(this, 'dispose');
        },
        refreshUI: function () {
            var data = this._propertyEditor.get_control();
            jQuery("#AutoPublish").attr('checked', data.AutoPublish);
        },
        applyChanges: function () {
     
            var controlData = this._propertyEditor.get_control();
     
            controlData.AutoPublish = jQuery("#AutoPublish").attr('checked') == "checked";
        }
    }
     
    SitefinityWebApp.Modules.Testimonials.ControlDesigners.SubmitTestimonialDesigner.registerClass('SitefinityWebApp.Modules.Testimonials.ControlDesigners.SubmitTestimonialDesigner', Telerik.Sitefinity.Web.UI.ControlDesign.ControlDesignerBase);
    if (typeof (Sys) !== 'undefined') Sys.Application.notifyScriptLoaded();
  6. Save the file.

For more information, see Overview: Widget designers.

Reference the client script

You must reference the client component from the view class. You do this by overriding for the GetScriptReferences method. In it you must create a script reference for your client component. When creating the reference, you must specify the name of the embedded resource that contains the client component and the assembly it resides in. The name of the resource follows the same naming conventions as the name of the template. Add the following code in the GetScriptReferences method:

private string _scriptPath = "~/Modules/Testimonials/ControlDesigners/SubmitTestimonialDesigner.js";
 
public string DesignerScriptPath
{
    get { return _scriptPath; }
    set { _scriptPath = value; }
}
 
public override IEnumerable<ScriptReference> GetScriptReferences()
{
    var scripts = base.GetScriptReferences() as List<ScriptReference>;
    if (scripts == null) return base.GetScriptReferences();
 
    scripts.Add(new ScriptReference(DesignerScriptPath));
    return scripts.ToArray();
}

Back To Top

Next: Testimonials module: Create the Submit testimonial view