TaskManager

The TaskManager class manages tasks. See Assigning and Managing Tasks in the Ektron Reference for information about tasks.

Namespace

Ektron.Cms.Framework.Settings.TaskManager

Constructors

  • TaskManager()
  • TaskManager(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.
  • TaskManagerService. Returns an instance of the business objects task manager service.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.TaskData)

Adds a task based on information in a TaskData 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
  • * Priority
  • * State
  • * User ID
  • * Content ID
  • * Start Date Time
  • * End Date Time
  • Description

Parameters

Returns

The added TaskData object.

.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="uxPriorityLabel" AssociatedControlID="uxPriority" CssClass="span-3 last" runat="server" Text="* Priority:" />
        <asp:DropDownList ID="uxPriority" runat="server">
            <asp:ListItem Value="1">Low</asp:ListItem>
            <asp:ListItem Value="2">Normal</asp:ListItem>
            <asp:ListItem Value="3">High</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxStateLabel" AssociatedControlID="uxState" CssClass="span-3 last" runat="server" Text="* State:" />
        <asp:DropDownList ID="uxState" runat="server">
            <asp:ListItem Value="1">NotStarted</asp:ListItem>
            <asp:ListItem Value="2">Active</asp:ListItem>
            <asp:ListItem Value="3">AwaitingData</asp:ListItem>
            <asp:ListItem Value="4">OnHold</asp:ListItem>
            <asp:ListItem Value="5">Pending</asp:ListItem>
            <asp:ListItem Value="6">Reopened</asp:ListItem>
            <asp:ListItem Value="7">Completed</asp:ListItem>
            <asp:ListItem Value="8">Archived</asp:ListItem>
            <asp:ListItem Value="9">Deleted</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-3 last" runat="server" Text="* User Id:" />
        <ektronUI:TextField  ID="uxUserId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text ="10005" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxContentIdLabel" AssociatedControlID="uxContentId" CssClass="span-3 last" runat="server" Text="* Content Id:" />
        <ektronUI:TextField  ID="uxContentId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="30" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxStartDateLabel" AssociatedControlID="uxStartDate" CssClass="span-3 last"
            runat="server" Text="*Start DateTime :" />
        <ektronUI:DatePicker Rows="3" ID="uxStartDate" CssClass="span-4" runat="server" Text="MM/DD/YYYY"
            ValidationGroup="RegisterValidationGroup" />
        <asp:DropDownList ID="uxStartTime" runat="server">
            <asp:ListItem>12</asp:ListItem>
            <asp:ListItem>1</asp:ListItem>
            <asp:ListItem>2</asp:ListItem>
            <asp:ListItem>3</asp:ListItem>
            <asp:ListItem>4</asp:ListItem>
            <asp:ListItem>5</asp:ListItem>
            <asp:ListItem>6</asp:ListItem>
            <asp:ListItem>7</asp:ListItem>
            <asp:ListItem>8</asp:ListItem>
            <asp:ListItem>9</asp:ListItem>
            <asp:ListItem>10</asp:ListItem>
            <asp:ListItem>11</asp:ListItem>
        </asp:DropDownList>
        <asp:DropDownList ID="uxStartPeriod" runat="server">
            <asp:ListItem>AM</asp:ListItem>
            <asp:ListItem>PM</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxEndDateLabel" AssociatedControlID="uxEndDate" CssClass="span-3 last"
            runat="server" Text="*End DateTime :" />
        <ektronUI:DatePicker Rows="3" ID="uxEndDate" CssClass="span-4" runat="server" Text="MM/DD/YYYY"
            ValidationGroup="RegisterValidationGroup" />
        <asp:DropDownList ID="uxEndTime" runat="server">
            <asp:ListItem>1</asp:ListItem>
            <asp:ListItem>2</asp:ListItem>
            <asp:ListItem>3</asp:ListItem>
            <asp:ListItem>4</asp:ListItem>
            <asp:ListItem>5</asp:ListItem>
            <asp:ListItem>6</asp:ListItem>
            <asp:ListItem>7</asp:ListItem>
            <asp:ListItem>8</asp:ListItem>
            <asp:ListItem>9</asp:ListItem>
            <asp:ListItem>10</asp:ListItem>
            <asp:ListItem>11</asp:ListItem>
            <asp:ListItem>12</asp:ListItem>
        </asp:DropDownList>
        <asp:DropDownList ID="uxEndPeriod" runat="server">
            <asp:ListItem>AM</asp:ListItem>
            <asp:ListItem>PM</asp:ListItem>
        </asp:DropDownList>
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxTaskDescriptionLabel" AssociatedControlID="uxTaskDescription" CssClass="span-3 last" runat="server" Text="Description :" />
        <asp:TextBox TextMode="MultiLine" Rows="3" ID="uxTaskDescription" 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;
using Ektron.Cms.Common;
using Ektron.Cms.Framework.Settings;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            TaskManager taskManager = new TaskManager();

            TaskData taskData = new TaskData()
            {
                TaskTitle = uxTitle.Text,
                LanguageID = taskManager.RequestInformation.ContentLanguage,
                AssignedToUserID = long.Parse(uxUserId.Text),
                AssignorUserId = taskManager.RequestInformation.UserId,
                Priority = (EkEnumeration.TaskPriority)int.Parse(uxPriority.SelectedItem.Value),
                ContentID = long.Parse(uxContentId.Text),
                ContentLanguage = taskManager.RequestInformation.ContentLanguage,
                State = int.Parse(uxState.SelectedItem.Value).ToString(),
                StartDate = DateTime.Parse(uxStartDate.Text + " " + uxStartTime.SelectedItem.Text + ":00:00 " + uxStartPeriod.SelectedItem.Text).ToString(),
                DueDate = DateTime.Parse(uxEndDate.Text + " " + uxEndTime.SelectedItem.Text + ":00:00 " + uxEndPeriod.SelectedItem.Text).ToString() ,
                Description  = uxTaskDescription.Text  
            };

            taskManager.Add(taskData);

            MessageUtilities.UpdateMessage(uxMessage, "Task added with Id " + taskData.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 task 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. ID of the task to delete.

Remarks

Validate the item with GetItem() before deleting it.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaskIdLabel" AssociatedControlID="uxTaskId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxTaskId" 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-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;
using Ektron.Cms.Framework.Settings;

.aspx.cs code-behind method

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

            TaskManager taskManager = new TaskManager();
            TaskData taskData = taskManager.GetItem(taskId);

             if (taskData != null)
             {
                 taskManager.Delete(taskId);
                 MessageUtilities.UpdateMessage(uxMessage, "Task deleted.", Message.DisplayModes.Success);
             }
             else
             {
                 MessageUtilities.UpdateMessage(uxMessage,"Task 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.TaskData)

Retrieves the properties of a specific TaskData 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. ID of the task to retrieve.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaskIdLabel" AssociatedControlID="uxTaskId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxTaskId" 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="uxAssignedToUserID" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxStatus" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxPriority" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxStartDate" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDueDate" 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.Common;
using Ektron.Cms.Framework.Settings;

.aspx.cs code-behind method

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

            TaskManager taskManager = new TaskManager();
            TaskData taskData = taskManager.GetItem(taskId);

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

                uxTitle.Text = "Title : " + taskData.TaskTitle;
                uxAssignedToUserID.Text = "Assigned To User ID : " + taskData.AssignedToUserID;
                uxStatus.Text = "State : " + taskData.State;
                uxPriority.Text = "Priority : " + (EkEnumeration.TaskPriority)taskData.Priority;
                uxStartDate.Text = "Start Date : " + taskData.StartDate;
                uxDueDate.Text = "Due Date : " + taskData.DueDate ;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Task 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(Ektron.Cms.TaskCriteria)

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

  • Task Data 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="uxTaskDataPropertyLabel" AssociatedControlID="uxTaskDataProperty" CssClass="span-6 last" runat="server" Text="TaskDataProperty:" />
        <asp:DropDownList ID="uxTaskDataProperty" runat="server">
            <asp:ListItem>Title</asp:ListItem>
            <asp:ListItem>Priority(2,1,0)</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="uxTaskDataListView" 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>
                        Task Title
                    </th>
                    <th>
                        Priority
                    </th>
                    <th>
                        Content ID
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("TaskID")%>
            </td>
            <td class="devsite-method">
                <%# Eval("TaskTitle")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Priority")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ContentID")%>
            </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.Framework.Settings;

.aspx.cs code-behind method

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

            TaskCriteria criteria = new TaskCriteria();
            if (uxTaskDataProperty.SelectedItem.Text == "Title")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TaskProperty.Title, CriteriaFilterOperator.Contains, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TaskProperty.Priority, CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            List<TaskData> taskDataList = taskManager.GetList(criteria);

            uxTaskDataListView.Visible = true;
            uxTaskDataListView.DataSource = taskDataList;
            uxTaskDataListView.DataBind();

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

Update

Update(Ektron.Cms.TaskData)

Updates an existing TaskData 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
  • * Priority
  • * State
  • * User ID
  • * Content ID
  • * Start Date Time
  • * End Date Time
  • Description

Parameters

  • taskData. The TaskData object to add.

Returns

The added TaskData object.

Remarks

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

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaskIdLabel" AssociatedControlID="uxTaskId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField  ID="uxTaskId" 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="uxPriorityLabel" AssociatedControlID="uxPriority" CssClass="span-3 last" runat="server" Text="* Priority:" />
        <asp:DropDownList ID="uxPriority" runat="server">
            <asp:ListItem Value="1">Low</asp:ListItem>
            <asp:ListItem Value="2">Normal</asp:ListItem>
            <asp:ListItem Value="3">High</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxStateLabel" AssociatedControlID="uxState" CssClass="span-3 last" runat="server" Text="* State:" />
        <asp:DropDownList ID="uxState" runat="server">
            <asp:ListItem Value="1">NotStarted</asp:ListItem>
            <asp:ListItem Value="2">Active</asp:ListItem>
            <asp:ListItem Value="3">AwaitingData</asp:ListItem>
            <asp:ListItem Value="4">OnHold</asp:ListItem>
            <asp:ListItem Value="5">Pending</asp:ListItem>
            <asp:ListItem Value="6">Reopened</asp:ListItem>
            <asp:ListItem Value="7">Completed</asp:ListItem>
            <asp:ListItem Value="8">Archived</asp:ListItem>
            <asp:ListItem Value="9">Deleted</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-3 last" runat="server" Text="* User Id:" />
        <ektronUI:TextField  ID="uxUserId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text ="10005" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxContentIdLabel" AssociatedControlID="uxContentId" CssClass="span-3 last" runat="server" Text="* Content Id:" />
        <ektronUI:TextField  ID="uxContentId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="30" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxStartDateLabel" AssociatedControlID="uxStartDate" CssClass="span-3 last"
            runat="server" Text="*Start DateTime :" />
        <ektronUI:DatePicker Rows="3" ID="uxStartDate" CssClass="span-4" runat="server" Text="MM/DD/YYYY"
            ValidationGroup="RegisterValidationGroup" />
        <asp:DropDownList ID="uxStartTime" runat="server">
            <asp:ListItem>12</asp:ListItem>
            <asp:ListItem>1</asp:ListItem>
            <asp:ListItem>2</asp:ListItem>
            <asp:ListItem>3</asp:ListItem>
            <asp:ListItem>4</asp:ListItem>
            <asp:ListItem>5</asp:ListItem>
            <asp:ListItem>6</asp:ListItem>
            <asp:ListItem>7</asp:ListItem>
            <asp:ListItem>8</asp:ListItem>
            <asp:ListItem>9</asp:ListItem>
            <asp:ListItem>10</asp:ListItem>
            <asp:ListItem>11</asp:ListItem>
        </asp:DropDownList>
        <asp:DropDownList ID="uxStartPeriod" runat="server">
            <asp:ListItem>AM</asp:ListItem>
            <asp:ListItem>PM</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxEndDateLabel" AssociatedControlID="uxEndDate" CssClass="span-3 last"
            runat="server" Text="*End DateTime :" />
        <ektronUI:DatePicker Rows="3" ID="uxEndDate" CssClass="span-4" runat="server" Text="MM/DD/YYYY"
            ValidationGroup="RegisterValidationGroup" />
        <asp:DropDownList ID="uxEndTime" runat="server">
            <asp:ListItem>1</asp:ListItem>
            <asp:ListItem>2</asp:ListItem>
            <asp:ListItem>3</asp:ListItem>
            <asp:ListItem>4</asp:ListItem>
            <asp:ListItem>5</asp:ListItem>
            <asp:ListItem>6</asp:ListItem>
            <asp:ListItem>7</asp:ListItem>
            <asp:ListItem>8</asp:ListItem>
            <asp:ListItem>9</asp:ListItem>
            <asp:ListItem>10</asp:ListItem>
            <asp:ListItem>11</asp:ListItem>
            <asp:ListItem>12</asp:ListItem>
        </asp:DropDownList>
        <asp:DropDownList ID="uxEndPeriod" runat="server">
            <asp:ListItem>AM</asp:ListItem>
            <asp:ListItem>PM</asp:ListItem>
        </asp:DropDownList>
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxTaskDescriptionLabel" AssociatedControlID="uxTaskDescription" CssClass="span-3 last" runat="server" Text="Description :" />
        <asp:TextBox TextMode="MultiLine" Rows="3" ID="uxTaskDescription" 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;
using Ektron.Cms.Common;
using Ektron.Cms.Framework.Settings;

.aspx.cs code-behind method

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

            TaskManager taskManager = new TaskManager();
            TaskData taskData = taskManager.GetItem(taskId);

           if (taskData != null)
            {
                taskData.TaskTitle = (uxTitle.Text != string.Empty ? uxTitle.Text :taskData.TaskTitle);
                taskData.AssignedToUserID =( uxUserId.Text != string.Empty ? long.Parse(uxUserId.Text): taskData.AssignedToUserID);
                taskData.AssignorUserId  = taskManager.RequestInformation.UserId;
                taskData.Priority = (EkEnumeration.TaskPriority)int.Parse(uxPriority.SelectedItem.Value);
                taskData.ContentID = (uxContentId.Text != string.Empty ?long.Parse(uxContentId.Text): taskData.ContentID);
                taskData.ContentLanguage = taskManager.RequestInformation.ContentLanguage;
                taskData.State = int.Parse(uxState.SelectedItem.Value).ToString();
                taskData.StartDate = (uxStartDate.Text != string.Empty ? DateTime.Parse(uxStartDate.Text + " " + uxStartTime.SelectedItem.Text + ":00:00 " + uxStartPeriod.SelectedItem.Text).ToString() :taskData.StartDate);
                taskData.DueDate = (uxEndDate.Text != string.Empty ? DateTime.Parse(uxEndDate.Text + " " + uxEndTime.SelectedItem.Text + ":00:00 " + uxEndPeriod.SelectedItem.Text).ToString() :  taskData.DueDate);
                taskData.Description = uxTaskDescription.Text != string.Empty ? uxTaskDescription.Text : taskData.Description;

                taskManager.Update(taskData);

                MessageUtilities.UpdateMessage(uxMessage, "Task updated", Message.DisplayModes.Success);
           }
           else
           {
               MessageUtilities.UpdateMessage(uxMessage, "Task 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

TaskCriteria

Namespace

Ektron.Cms

Constructors

  • TaskCriteria()
    public TaskCriteria()
  • TaskCriteria(Ektron.Cms.Common.TaskProperty, EkEnumeration.OrderByDirection)
    public TaskCriteria(Ektron.Cms.Common.TaskProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the TaskProperty are:

    • AssignedToGroupId
    • AssignedToUserId
    • ContentId
    • Description
    • DueDate
    • Id
    • Priority
    • Title

TaskData

Namespace

Ektron.Cms

Properties

  • AssignedByUser
    public string AssignedByUser { set; get; }
  • AssignedByUserId
    public string AssignedByUserID { set; get; }
  • AssignedToUser. The username of the user who the task is assigned to. This value is populated when retrieving TaskData. While adding a new Task, use the AssignedToUserID property.
    public string AssignedToUser { set; get; }
  • AssignedToUserGroup
    public string AssignedToUserGroup { set; get; }
  • AssignedToUserID. The ID of the user to assign the task to. This is a required property to successfully assign a task to a user.
    public long AssignedToUserID { set; get; }
  • Assignor. The username of the user assigning the task.
    public string Assignor { set; get; }
  • AssignorUserId. The ID of the user assigning the task.
    public long AssignorUserId { set; get; }
  • AssignToUserGroupID
    public long AssignToUserGroupID { set; get; }
  • CommentDisplayName
    public string CommentDisplayName { set; get; }
  • CommentEmail
    public string CommentEmail { set; get; }
  • CommentURI
    public string CommentURI { set; get; }
  • ContentID
    public long ContentID { set; get; }
  • ContentLanguage
    public int ContentLanguage { set; get; }
  • ContentTitle
    public string ContentTitle { set; get; }
  • ContentType
    public EkEnumeration.CMSContentType ContentType { set; get; }
  • CreatedByUser
    public string CreatedByUser { set; get; }
  • CreatedByUserID
    public long CreatedByUserID { set; get; }
  • DateCreated
    public string DateCreated { set; get; }
  • DateModified
    public string DateModified { set; get; }
  • Description
    public string Description { set; get; }
  • DisplayDateCreated
    public string DisplayDateCreated { set; get; }
  • DisplayDateModified
    public string DisplayDateModified { set; get; }
  • DueDate
    public string DueDate { set; get; }
  • FolderId
    public long FolderId { set; get; }
  • Id
    public override long Id { set; get; }
  • ImpersonateUser
    public bool ImpersonateUser { set; get; }
  • Language
    public string Language { set; get; }
  • LanguageID
    public int LanguageID { set; get; }
  • LastComment
    public string LastComment { set; get; }
  • LastCommentUserID
    public long LastCommentUserID { set; get; }
  • ParentID
    public long ParentID { set; get; }
  • Priority
    public EkEnumeration.TaskPriority Priority { set; get; }
  • StartDate
    public string StartDate { set; get; }
  • State. One of the following values from Common.EkEnumeration.TaskState:
    • Prototype = "0"
    • NotStarted = "1"
    • Active = "2"
    • AwaitingData = "3"
    • OnHold = "4"
    • Pending = "5"
    • Reopened = "6"
    • Completed = "7"
    • Archived = "8"
    • Deleted = "9"
    public string State { set; get; }
  • Status. Obsolete: Use State
    public int Status { set; get; }
  • TaskID
    public long TaskID { set; get; }
  • TaskTitle
    public string TaskTitle { set; get; }
  • TaskTypeID
    public long TaskTypeID { set; get; }
  • UserInfo
    public Ektron.Cms.UserData UserInfo { set; get; }
  • Validate()
    public override ValidationResults Validate()