CmsMessageManager

The CmsMessageManager class manages messages in the Ektron CMS.

Namespace

Ektron.Cms.Framework.Settings.CmsMessageManager

Constructors

  • CmsMessageManager()
  • CmsMessageManager(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.
  • MessageService. Gets instance to ICmsMessage.
  • RequestInformation. Gets information about the current request.
  • SitePath. Gets the site path.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.Messaging.CmsMessageData)

Adds a message based on information in an CmsMessageData object. The method populates the message.Id with the newly created ID.

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

  • * Title
  • Is Default
  • * Message Type ID
  • * Subject
  • * HTML Body

Parameters

Returns

Returns the custom CmsData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTitleLabel" AssociatedControlID="uxTitle" CssClass="span-3 last" runat="server" Text="* Title:" />
        <ektronUI:TextField  ID="uxTitle" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsDefaultLabel" AssociatedControlID="uxIsDefault" CssClass="span-3 last" runat="server" Text=" Is Default:" />
        <ektronUI:Button DisplayMode="Checkbox" Text="" ID="uxIsDefault" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageTypeIdLabel" AssociatedControlID="uxMessageTypeId" CssClass="span-3 last" runat="server" Text="* Message Type Id:" />
        <ektronUI:TextField  ID="uxMessageTypeId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="5" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxSubjectLabel" AssociatedControlID="uxSubject" CssClass="span-3 last" runat="server" Text="* Subject:" />
        <ektronUI:TextField  ID="uxSubject" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxHtmlBodyLabel" AssociatedControlID="uxHtmlBody" CssClass="span-3 last" runat="server" Text="* Html Body:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxHtmlBody" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</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.Messaging;
using Ektron.Cms.Framework.Settings;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            CmsMessageTypeManager cmsMessageTypeManager = new CmsMessageTypeManager();
            CmsMessageTypeData cmsMessageTypeData = cmsMessageTypeManager.GetItem(long.Parse(uxMessageTypeId.Text));

            CmsMessageManager cmsMessageManager = new CmsMessageManager();
            CmsMessageData cmsMessageData = new CmsMessageData()
            {
                Title = uxTitle.Text ,
                IsDefaultMessage = uxIsDefault.Checked,
                Subject = uxSubject.Text ,
                MessageType = cmsMessageTypeData,
                HtmlBody = uxHtmlBody.Text    
            };

            cmsMessageManager.Add(cmsMessageData);

            MessageUtilities.UpdateMessage(uxMessage,  "Message data added with Id " + cmsMessageData.Id, Message.DisplayModes.Success);

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

Delete

Delete(System.Int64)

Deletes a message (CmsMessageData object) 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

  • * ID

Parameters

  • id. The ID of the message to delete

Remarks

Validate the item with GetItem() before deleting it.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageIdLabel" AssociatedControlID="uxMessageId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxMessageId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li>
</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.Framework.Settings;
using Ektron.Cms.Messaging;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
             long messageId = long.Parse(uxMessageId.Text);
             CmsMessageManager cmsMessageManager = new CmsMessageManager();
             CmsMessageData cmsMessageData = cmsMessageManager.GetItem(messageId);

             if (cmsMessageData != null)
             {
                 cmsMessageManager.Delete(messageId);
                 MessageUtilities.UpdateMessage(uxMessage, "Message deleted.", Message.DisplayModes.Success);
             }
             else
             {
                 MessageUtilities.UpdateMessage(uxMessage, "Message does not exists.", Message.DisplayModes.Error);
             }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetDefaultItemByType

GetDefaultItemByType(System.Int64)

Retrieves the default message for a message type in the CMS. All available languages of the message are returned as part of the CmsMessageData object collection.

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

  • * ID

Parameters

  • messageTypeId. The ID of the message type to retrieve the default message for.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageTypeIdLabel" AssociatedControlID="uxMessageTypeId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxMessageTypeId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxTitle" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxMessageType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxSubject" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxHtmlBody" 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.Messaging;
using Ektron.Cms.Framework.Settings;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long messageTypeId = long.Parse(uxMessageTypeId.Text);

            CmsMessageManager cmsMessageManager = new CmsMessageManager();
            CmsMessageDataCollection cmsMessageData = cmsMessageManager.GetDefaultItemByType(messageTypeId);

            if (cmsMessageData != null && cmsMessageData.Count > 0)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for message with ID " + cmsMessageData[0].Id.ToString() + " are below (Only top item in the collection is displayed)", Message.DisplayModes.Success);

                uxTitle.Text = "Title : " + cmsMessageData[0].Title;
                uxMessageType.Text = "Message Type : " + cmsMessageData[0].MessageType.Name;
                uxSubject.Text = "Subject : " + cmsMessageData[0].Subject;
                uxHtmlBody.Text = "Html Body : " + cmsMessageData[0].HtmlBody;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Message does not exists.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(Ektron.Cms.CmsMessageData)

Retrieves the properties of a specific CmsMessageData 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

  • * ID

Parameters

  • id. The ID of the message to retrieve.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageIdLabel" AssociatedControlID="uxMessageId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxMessageId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxTitle" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxMessageType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxSubject" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxHtmlBody" 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.Framework.Settings;
using Ektron.Cms.Messaging;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long messageId = long.Parse(uxMessageId.Text);

            CmsMessageManager cmsMessageManager = new CmsMessageManager();
            CmsMessageData cmsMessageData = cmsMessageManager.GetItem(messageId);

            if (cmsMessageData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for message with ID " + cmsMessageData.Id.ToString() + " are below", Message.DisplayModes.Success);

                uxTitle.Text = "Title : " + cmsMessageData.Title;
                uxMessageType.Text = "Message Type : " + cmsMessageData.MessageType.Name;
                uxSubject.Text = "Subject : " + cmsMessageData.Subject;
                uxHtmlBody.Text = "Html Body : " + cmsMessageData.HtmlBody;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Message does not exists.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItemCollection

GetItemCollection(System.Int64)

Retrieves a single message from the CMS in all available languages.

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

  • * ID

Parameters

  • id. ID of the message to retrieve.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageIdLabel" AssociatedControlID="uxMessageId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxMessageId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxTitle" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxMessageType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxSubject" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxHtmlBody" 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.Framework.Settings;
using Ektron.Cms.Messaging;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long messageId = long.Parse(uxMessageId.Text);

            CmsMessageManager cmsMessageManager = new CmsMessageManager();
            CmsMessageDataCollection cmsMessageData = cmsMessageManager.GetItemCollection(messageId);

            if (cmsMessageData != null && cmsMessageData.Count > 0)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for message with ID " + cmsMessageData[0].Id.ToString() + " are below (Only top item in the collection is displayed)", Message.DisplayModes.Success);

                uxTitle.Text = "Title : " + cmsMessageData[0].Title;
                uxMessageType.Text = "Message Type : " + cmsMessageData[0].MessageType.Name;
                uxSubject.Text = "Subject : " + cmsMessageData[0].Subject;
                uxHtmlBody.Text = "Html Body : " + cmsMessageData[0].HtmlBody;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Message does not exists.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(CmsMessageCriteria)

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

  • CMS Message Property
  • * Object Value

Parameters

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="uxCmsMessagePropertyLabel" AssociatedControlID="uxCmsMessageProperty" CssClass="span-6 last" runat="server" Text="CmsMessageProperty:" />
        <asp:DropDownList ID="uxCmsMessageProperty" runat="server">
            <asp:ListItem>MessageTypeId</asp:ListItem>
            <asp:ListItem>Title</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-6 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-6" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
            
<asp:ListView ID="uxCmsMessageDataListView" 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>
                        Title
                    </th>
                    <th>
                        Subject
                    </th>
                    <th>
                        Html Body
                    </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("Title")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Subject")%>
            </td>
            <td class="devsite-method">
                <%# Eval("HtmlBody")%>
            </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.Common;
using Ektron.Cms.Messaging;
using Ektron.Cms.Framework.Settings;

.aspx.cs code-behind method

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

            CmsMessageCriteria criteria = new CmsMessageCriteria();
            if (uxCmsMessageProperty.SelectedItem.Text == "MessageTypeId")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(CmsMessageProperty.MessageTypeId , CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(CmsMessageProperty.Title , CriteriaFilterOperator.Contains, Objectvalue);
            }
            criteria.AddFilter(CmsMessageProperty.LanguageId, CriteriaFilterOperator.EqualTo, cmsMessageManager.RequestInformation.ContentLanguage);

          
            List<CmsMessageData> cmsMessageDataList = cmsMessageManager.GetList(criteria);

            uxCmsMessageDataListView.Visible = true;
            uxCmsMessageDataListView.DataSource = cmsMessageDataList;
            uxCmsMessageDataListView.DataBind();

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

Update

Update(Ektron.Cms.CmsMessageData)

Updates an existing CmsMessageData object 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

  • * ID
  • Title
  • Message Type ID
  • Subject
  • HTML Body

Parameters

Returns

Returns the custom CmsData object updated.

Remarks

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

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageIdLabel" AssociatedControlID="uxMessageId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField  ID="uxMessageId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTitleLabel" AssociatedControlID="uxTitle" CssClass="span-3 last" runat="server" Text=" Title:" />
        <ektronUI:TextField  ID="uxTitle" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageTypeIdLabel" AssociatedControlID="uxMessageTypeId" CssClass="span-3 last" runat="server" Text=" Message Type Id:" />
        <ektronUI:TextField  ID="uxMessageTypeId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxSubjectLabel" AssociatedControlID="uxSubject" CssClass="span-3 last" runat="server" Text=" Subject:" />
        <ektronUI:TextField  ID="uxSubject" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxHtmlBodyLabel" AssociatedControlID="uxHtmlBody" CssClass="span-3 last" runat="server" Text=" Html Body:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxHtmlBody" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</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.Framework.Settings;
using Ektron.Cms.Messaging;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long messageId = long.Parse(uxMessageId.Text);
           
            CmsMessageTypeManager cmsMessageTypeManager = new CmsMessageTypeManager();
            CmsMessageManager cmsMessageManager = new CmsMessageManager();
            CmsMessageData cmsMessageData = cmsMessageManager.GetItem(messageId);

            if (cmsMessageData != null)
            {
                cmsMessageData.Title = (uxTitle.Text != string.Empty ? uxTitle.Text : cmsMessageData.Title);
                cmsMessageData.Subject = (uxSubject.Text != string.Empty ? uxSubject.Text : cmsMessageData.Subject);
                cmsMessageData.HtmlBody = (uxHtmlBody.Text != string.Empty ? uxHtmlBody.Text : cmsMessageData.HtmlBody);
                cmsMessageData.MessageType = (uxMessageTypeId.Text != string.Empty ? cmsMessageTypeManager.GetItem(long.Parse(uxMessageTypeId.Text)) : cmsMessageData.MessageType);

                cmsMessageManager.Update(cmsMessageData);

                MessageUtilities.UpdateMessage(uxMessage,  "Message Updated", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Message does not exists.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

CmsMessageCriteria

Namespace

Ektron.Cms.Messaging

Constructors

  • CmsMessageCriteria()
    public CmsMessageCriteria()
  • CmsMessageCriteria(Ektron.Cms.Messaging.CmsMessageProperty, EkEnumeration.OrderByDirection)
    public CmsMessageCriteria(Ektron.Cms.Messaging.CmsMessageProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the CmsMessageProperty are:

    • HtmlBody
    • Id
    • IsDefault
    • LanguageId
    • MessageTypeId
    • MessageTypeName
    • MessageTypeScope
    • SiteId
    • Subject
    • TextBody
    • Title

CmsMessageData

Namespace

Ektron.Cms.Messaging

Properties

  • CmsMessageData()
    public CmsMessageData()
  • CmsMessageData(string, string, string, string, int, long, bool)
    public CmsMessageData(string title, string subject,
  string htmlBody, string textBody, int languageId,
  long messageTypeId, bool isDefault)
  • HtmlBody. Gets or sets the Html Body of the Message. Depending on the delivery mechanism of the message, either the TextBody or HtmlBody may be used.
    public string HtmlBody { set; get; }
  • IsDefaultMessage. Gets or sets the IsDefault flag for this message. If true, this message is the defualt used for the MessageType.
    public bool IsDefaultMessage { set; get; }
  • MessageType. Gets or sets the the message type of this message.
    public Ektron.Cms.Messaging.CmsMessageTypeData
  MessageType { set; get; }
  • SiteId. Gets or sets the Id of the site that the message is associated with.
    public long SiteId { set; get; }
  • Subject. Gets or sets the Subject of the Message.
    public string Subject { set; get; }
  • TextBody. Gets or sets the Html Body of the Message. Depending on the delivery mechanism of the message, either the TextBody or HtmlBody may be used.
    public string TextBody { set; get; }
  • Title. Gets or Sets the Title of the Message.
    public string Title { set; get; }
  • Ektron.Cms.Messaging.CmsMessageData.Validate(). Validates that the data object is in a valid state for persisting. It returns a collection of ValidationResult messages if the object is not valid.
    public override ValidationResults Validate()