TemplateManager

The TemplateManager class manages templates, which typically includes page headers, footers, and placeholders for content, forms, summaries, calendars, collections, or other page elements. For information about templates, see Working with Templates in the Ektron Reference.

Namespace

Ektron.Cms.Framework.Content.TemplateManager

Constructors

  • TemplateManager()
  • TemplateManager(ApiAccessMode)

Properties

  • ApiMode. Gets or sets the current API access mode. If set to Admin, the API runs with the permissions of an administrator.
  • ApplicationPath. Gets the application path to the Workarea.
  • ContentLanguage. Gets or sets the current content language.
  • InPreviewMode. Gets or sets the preview mode and returns true if the site is in preview mode.
  • IsCommerceEnabled. Checks for a commerce license.
  • RequestInformation. Gets information about the current request.
  • SitePath. Gets the site path.
  • TemplateService. Returns an instance of the business objects Template Service.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.TemplateData)

Adds a template based on information in a TemplateData object.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Template Name
  • Description
  • * Template File

Parameters

  • templateData. The TemplateData object to add.

Returns

TemplateData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTemplateNameLabel" AssociatedControlID="uxTemplateName" CssClass="span-3 last"
            runat="server" Text="*Template Name:" />
        <ektronUI:TextField ID="uxTemplateName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDescriptionLabel" AssociatedControlID="uxDescription" CssClass="span-3 last"
            runat="server" Text="Description :" />
        <ektronUI:TextField ID="uxDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <asp:Label ID="uxFilePathLabel" AssociatedControlID="uxFilePath" CssClass="span-3 last"
            runat="server" Text="*Template File :(Choose Template from Root of your website of Type'.aspx'):" />
        <asp:FileUpload ID="uxFilePath" size="29.75" CssClass="span-4" runat="server" />
    </li>
    <li class="clearfix" style="color: red;">
        <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            TemplateManager templateManager = new TemplateManager();
            string filename = uxFilePath.PostedFile.FileName.ToString();
            if (!(filename.Contains(".aspx")))
            {            
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Upload file with type '.aspx' {page} Only.", Message.DisplayModes.Error);
                return;
            }
            TemplateData templateData = new TemplateData()
            {
                TemplateName = uxTemplateName.Text,
                Description = uxDescription.Text,
                Type = Ektron.Cms.Common.EkEnumeration.TemplateType.Default,
                FileName = filename,
            };

            templateManager.Add(templateData);

            if (templateData.Id > 0)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Template Added with Id " + templateData.Id, Message.DisplayModes.Success);   
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Template already exists in the system.", Message.DisplayModes.Error);
                return;
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete

Delete(System.Int64)

Deletes a template from the CMS.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Template ID

Parameters

  • templateId. The ID of the template to delete.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
        <li class="clearfix">
            <ektronUI:Label ID="uxTemplateIdLabel" AssociatedControlID="uxTemplateId" CssClass="span-3 last"
                runat="server" Text="*Template Id:" />
            <ektronUI:TextField ID="uxTemplateId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
        </li>
        <li class="clearfix" style="color: red;">
            <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
                Text="Status:" />
        </li>
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
    </ol>
              
    <ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>                           
</ol>

.aspx.cs code-behind namespace

<ol class="formFields">
        <li class="clearfix">
            <ektronUI:Label ID="uxTemplateIdLabel" AssociatedControlID="uxTemplateId" CssClass="span-3 last"
                runat="server" Text="*Template Id:" />
            <ektronUI:TextField ID="uxTemplateId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
        </li>
        <li class="clearfix" style="color: red;">
            <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
                Text="Status:" />
        </li>
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
    </ol>
              
    <ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>                           
</ol>

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            TemplateManager templateManager = new TemplateManager();
            long templateId = long.Parse(uxTemplateId.Text);
            TemplateData templateData = templateManager.GetItem(templateId);
            if (templateData != null)
            {
                templateManager.Delete(templateId);
                MessageUtilities.UpdateMessage(uxMessage, "Template with ID " + templateId + " has been Deleted.", Message.DisplayModes.Success);               
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Template Id.", Message.DisplayModes.Error);
                return;
            }

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(Ektron.Cms.TemplateData)

Retrieves the properties of a specific TemplateData object.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Template ID

Parameters

  • templateId. The ID of the template to retrieve.

Returns

TemplateData object found.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTemplateIdLabel" AssociatedControlID="uxTemplateId" CssClass="span-3 last"
            runat="server" Text="*Template Id:" />
        <ektronUI:TextField ID="uxTemplateId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix" style="color: red;">
        <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
</ol>
              
    <ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
        <li class="clearfix">
        <asp:Literal ID="uxTemplateName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxTemplateDescription" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFileName" runat="server"></asp:Literal>
    </li>               
</ol>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            TemplateManager templateManager = new TemplateManager();
            long templateId = long.Parse(uxTemplateId.Text);
            TemplateData templateData = templateManager.GetItem(templateId);
            if (templateData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for Template with ID " + templateId + " are below", Message.DisplayModes.Success);

                uxTemplateName.Text = "Template Name : " + templateData.TemplateName;
                uxTemplateDescription.Text = "Template Description : " + templateData.Description;
                uxFileName.Text = "FileName : " + templateData.FileName;
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Template Id.", Message.DisplayModes.Error);
                return;
            }

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(Ektron.Cms.Common.TemplateCriteria)

Retrieves lists of objects.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Template Property
  • * Object Value

Parameters

  • criteria. Object used to perform filtering based on several TemplateData object properties.

Returns

A list of TemplateData objects found.

Criteria use

The DataProperty enum works with its criteria class and defines the properties that the Manager class uses to filter and order. Specify zero (0) or more criteria to retrieve the objects you want. The criteria object also lets you set the number of items to return, define paging data, and modify sorting.

Criteria objects
  • Condition. The Logical operator to apply to the filters. The default value is "AND". The criteria condition controls the operator for the default filter group and the AND-ing\Or-ing the filter groups together.
    public Ektron.Cms.Common.LogicalOperation Condition { set; get; }
  • FilterGroups. Gets a list of filter groups. Filter groups can be created to do filter grouping (that is, parentheses in the where clause). The groups use the criteria's condition like other filters, but can use their own condition internally.
    public 
  System.Collections.Generic.List<CriteriaFilterGroup<ActivityCommentProperty>> 
  FilterGroups { get; }
  • Filters. Lists of filters defined in this criteria object. To add new Filters, you can add them here or use the AddFilter method (recommended).
    public 
  System.Collections.Generic.List<CriteriaFilter<ActivityCommentProperty>> 
  Filters { get; }
  • GroupByField. The group by field to apply to the results.
    public 
  Ektron.Cms.Activity.ActivityCommentProperty 
  GroupByField { set; get; }
  • OrderByDirection. Sets the order direction (ascending or descending).
    public EkEnumeration.OrderByDirection 
  OrderByDirection { set; get; }
  • OrderByField . Set the property used to order the results.
    public Ektron.Cms.Activity.ActivityCommentProperty 
  OrderByField { set; get; }
  • PagingInfo. By default, page size is 50 for improved performance. Example paging Info: 
    PagingInfo pageinfo = new PagingInfo();
pageinfo.CurrentPage=1;
pageinfo.RecordsPerPage = 100;
criteria.PagingInfo = pageinfo;
Constructor(property, orderbyDirection)

Sorts the results by a property in ascending or descending order.

AddFilter(property, operator, value)

Filters the results based on the conditions defined in this method.

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo, Objectvalue);
LogicalOperation Condition

Filters the array of items based on the logical condition set in the AddFilter properties. 

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo,Objectvalue);
List<CriteriaFilterGroup> FilterGroups

Binds data to a listview or gridview.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTemplatePropertyLabel" AssociatedControlID="uxTemplateProperty" CssClass="span-4 last" runat="server" Text="*TemplateProperty : " />
        <asp:DropDownList ID="uxTemplateProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>TemplateName</asp:ListItem>
            <asp:ListItem>FileName</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 last" runat="server" Text="* ObjectValue:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li>
</ol>
           
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
<asp:ListView ID="uxTemplateDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                        <th>
                        FileName
                    </th>
                    <th>
                        TemplateName
                    </th>
                    <th>
                        Description
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
                <td class="devsite-method">
                <%# Eval("FileName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("TemplateName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Description")%>
            </td>
        </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Common;
using Ektron.Cms.Content;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            TemplateManager templateManager = new TemplateManager();
            object Objectvalue;

            TemplateCriteria criteria = new TemplateCriteria();
            if (uxTemplateProperty.SelectedItem.Text == "Id")
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                criteria.AddFilter(TemplateDataProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxTemplateProperty.SelectedItem.Text == "TemplateName")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TemplateDataProperty.TemplateName, CriteriaFilterOperator.Contains, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TemplateDataProperty.FileName, CriteriaFilterOperator.Contains, Objectvalue);
            }

            List<TemplateData> TemplateDataList = templateManager.GetList(criteria);

            uxTemplateDataListView.Visible = true;
            uxTemplateDataListView.DataSource = TemplateDataList;
            uxTemplateDataListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Update

Update(Ektron.Cms.TemplateData)

Updates an existing Template item in the CMS.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Template ID
  • Template Name
  • Description
  • Template File

Parameters

  • templateData. The TemplateData object to update.

Returns

Returns the custom TemplateData object updated.

Remarks

Validate the Template item with GetItem() before you update the properties. Then, call Update with your modified TemplateData object.

NOTE: You cannot change all properties after the initial Add event, such as the TemplateData.Type.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTemplateIdLabel" AssociatedControlID="uxTemplateId" CssClass="span-3 last"
            runat="server" Text="*Template Id:" />
        <ektronUI:TextField ID="uxTemplateId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTemplateNameLabel" AssociatedControlID="uxTemplateName" CssClass="span-3 last"
            runat="server" Text="Template Name:" />
        <ektronUI:TextField ID="uxTemplateName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDescriptionLabel" AssociatedControlID="uxDescription" CssClass="span-3 last"
            runat="server" Text="Description :" />
        <ektronUI:TextField ID="uxDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <asp:Label ID="uxFilePathLabel" AssociatedControlID="uxFilePath" CssClass="span-3 last"
            runat="server" Text="Template File :" />
        <asp:FileUpload ID="uxFilePath" size="29.75" CssClass="span-4" runat="server" />
    </li>
    <li class="clearfix" style="color: red;">
        <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            TemplateManager templateManager = new TemplateManager();
            long templateId = long.Parse(uxTemplateId.Text);
            TemplateData templateData = templateManager.GetItem(templateId);
            string filename = uxFilePath.PostedFile.FileName.ToString();
            
            if (templateData != null)
            {
                if (!string.IsNullOrEmpty(filename))
                {
                    if (!(filename.Contains(".aspx")))
                    {
                        uxStatus.Visible = true;
                        MessageUtilities.UpdateMessage(uxStatus, "Please Upload file with type '.aspx' {page} Only.", Message.DisplayModes.Error);
                        return;
                    }
                }
                
                templateData.TemplateName = uxTemplateName.Text != string.Empty ? uxTemplateName.Text : templateData.TemplateName;
                templateData.Description = uxDescription.Text != string.Empty ? uxDescription.Text : templateData.Description;
                templateData.FileName = uxFilePath.PostedFile.FileName.ToString() != string.Empty ? uxFilePath.PostedFile.FileName.ToString() : templateData.FileName;

                templateManager.Update(templateData);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus,"Please Enter valid Template Id.", Message.DisplayModes.Error);
                return;
            }
            if (templateData.Id > 0)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Template with Id " + templateData.Id + " has updated", Message.DisplayModes.Success);  
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Template already exists in the system.", Message.DisplayModes.Error);
                return;
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

TemplateData

Namespace

Ektron.Cms

Properties

  • Description 
    public string Description { set; get; }
  • FileName
    public string FileName { set; get; }
  • MasterLayoutID
    public long MasterLayoutID { set; get; }
  • SubType
    public Ektron.Cms.Controls.CmsWebService.TemplateSubType
   SubType { set; get; }
  • TemplateName
    public string TemplateName { set; get; }
  • Thumbnail
    public string Thumbnail { set; get; }
  • Type
    public Ektron.Cms.Controls.CmsWebService.TemplateType
  Type { set; get; }