WebCalendarManager

The WebCalendarManager class manages calendars.

Namespace

Ektron.Cms.Framework.Calendar.WebCalendarManager

Constructors

  • WebCalendarManager()
  • WebCalendarManager(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.
  • CalendarService. Calendar Service
  • 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.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.Common.Calendar.WebCalendarData)

Adds a new Web Calendar to the CMS.

This method takes one argument for the WebCalendarData class. When you add the Web Calendar, the method returns a new WebCalendar ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Parent Folder ID
  • * Web Calendar Name
  • Description

Parameters

  • calendar. WebCalendarData object to add.

Returns

Returns the WebCalendarData object added.

Remarks

Validate the parent folder using GetItem() before you add the Web calendar.

.aspx code snippet

<ol class="formFields">
  <li class="clearfix">
    <ektronUI:Label ID="uxWebcalendarNameLabel"
      AssociatedControlID="uxWebcalendarName"
      CssClass="span-4 last" runat="server" 
      Text="* Webcalendar Name :" />
    <ektronUI:TextField ID="uxWebcalendarName" 
      CssClass="span-4" runat="server" 
      ValidationGroup="RegisterValidationGroup" />
  </li>
  <li class="clearfix">
    <ektronUI:Label ID="uxParentFolderIDLabel"
      AssociatedControlID="uxParentFolderID"
      CssClass="span-4 last" runat="server"
      Text="Parent FolderID :" />
    <ektronUI:TextField ID="uxParentFolderID"
      CssClass="span-4" runat="server"
      ValidationGroup="RegisterValidationGroup" Text="0" />
  </li>
  <li class="clearfix">
    <ektronUI:Label ID="uxWebcalendarDescriptionLabel"
      AssociatedControlID="uxWebcalendarDescription"
      CssClass="span-4 last" runat="server" Text="Description :" />
    <asp:TextBox TextMode="MultiLine" Rows="3"
      ID="uxWebcalendarDescription" CssClass="span-4"
      runat="server" ValidationGroup="RegisterValidationGroup" />
  </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>
  <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4"
     runat="server" Text="* - Required" />
</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.Site;
using Ektron.Cms.Framework.Calendar;
using Ektron.Cms.Common.Calendar;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
 {
   try
   {
     if (!string.IsNullOrEmpty(uxWebcalendarName.Text))
     {
       long folderID = Convert.ToInt64(uxParentFolderID.Text);

       FolderManager folderManager = new FolderManager();
       FolderData folderData = folderManager.GetItem(folderID);
       //Check whether entered folderID is Valid or NOT.
       if (folderData != null)
       {
         WebCalendarManager WebcalendarManager = new WebCalendarManager();

         //Set the WebCalendar Details
         WebCalendarData WebcalendarData = new WebCalendarData()
           {
             Name = uxWebcalendarName.Text,
             ParentId = folderID,
             Description = uxWebcalendarDescription.Text,
           };

          //Add a webcalender with given details.
          WebcalendarManager.Add(WebcalendarData);
          MessageUtilities.UpdateMessage(uxMessage,
            "WebCalendar Saved with Id " + WebcalendarData.Id,
            Message.DisplayModes.Success);
            }
              else
            {
              uxStatus.Visible = true;
              MessageUtilities.UpdateMessage(uxStatus,
                "Please Enter Valid Parent Folder ID.",
                Message.DisplayModes.Error);
              return;
             }
         }
           else
           {
             uxStatus.Visible = true;
             MessageUtilities.UpdateMessage(uxStatus,
             "Please Enter WebcalendarName and try again.",
             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 Web Calendar 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

  • * Web Calendar ID

Parameters

  • id. The ID of the calendar to delete.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
  <li class="clearfix">
    <ektronUI:Label ID="uxWebcalendarIDLabel"
       AssociatedControlID="uxWebcalendarID" CssClass="span-4 last"
       runat="server" Text="WebcalendarID :" />
    <ektronUI:TextField ID="uxWebcalendarID" CssClass="span-4"
       runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
  </li>                   
  <ektronUI:Button ID="uxSubmit" runat="server"
    OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
  <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4"
     runat="server" Text="* - Required" />
</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.Site;
using Ektron.Cms.Framework.Calendar;
using Ektron.Cms.Common.Calendar;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
  {
    try
    {
      WebCalendarManager WebcalendarManager = new WebCalendarManager();
      long WebcalenderID = Convert.ToInt64(uxWebcalendarID.Text);

      if (WebcalenderID > 0)
      {
        WebCalendarData WebcalendarData =
          WebcalendarManager.GetItem(WebcalenderID);
        if (WebcalendarData != null)
        {
          //Delete a webcalender
          WebcalendarManager.Delete(WebcalenderID);
          MessageUtilities.UpdateMessage(uxMessage,
           "WebCalendar with ID: " + WebcalenderID +
           " has been Deleted", Message.DisplayModes.Success);
        }
        else
        {
          MessageUtilities.UpdateMessage(uxMessage,
           "Please Enter a Valid Webcalender ID",
           Message.DisplayModes.Error);
        }

      }
      else
      {
        MessageUtilities.UpdateMessage(uxMessage,
          "Please Enter a Valid Webcalender ID",
          Message.DisplayModes.Error);
      }
      uxPageMultiView.SetActiveView(uxViewMessage);
    }
    catch (Exception ex)
    {
      MessageUtilities.UpdateMessage(uxMessage,
        ex.Message, Message.DisplayModes.Error);
      uxPageMultiView.SetActiveView(uxViewMessage);
    }
  }
}

GetCalendarFeed

GetCalendarFeed(System.Int64)

Retrieves the Calendar representation of the supplied calendar ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Web Calendar ID

Parameters

  • calendarId. ID of calendar to retrieve ICalendar feed for.

.aspx code snippet

<ol class="formFields">
  <li class="clearfix">
     <ektronUI:Label ID="uxWebcalendarIDLabel"
        AssociatedControlID="uxWebcalendarID" CssClass="span-4 last"
        runat="server" Text="* Webcalendar ID :" />
     <ektronUI:TextField ID="uxWebcalendarID" CssClass="span-4"
        runat="server" ValidationGroup="RegisterValidationGroup" Text="88" />
  </li>
    <ektronUI:Button ID="uxSubmit" runat="server"
      OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel"
      CssClass="span-4" runat="server" Text="* - Required" />
</ol>
       
<ol class="formFields">
  <li class="clearfix">
     <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
  </li>
  <li class="clearfix">
     <asp:Literal ID="uxFeed" 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.Site;
using Ektron.Cms.Framework.Calendar;
using Ektron.Cms.Common.Calendar;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
  {
    try
    {
      WebCalendarManager WebcalendarManager = new WebCalendarManager();
      long WebcalenderID = Convert.ToInt64(uxWebcalendarID.Text);

      if (WebcalenderID > 0)
      {
        //Returns the ICalendar representation of the supplied calendar Id.     
        String feed = WebcalendarManager.GetICalendarFeed(WebcalenderID);
        MessageUtilities.UpdateMessage(uxMessage,
          "ICalendar representation of the supplied calendar Id: "
          + WebcalenderID + " is below", Message.DisplayModes.Success);
        uxFeed.Text = feed;
       }
       else
       {
         MessageUtilities.UpdateMessage(uxMessage,
          "Please Enter a Valid Webcalender ID.",
            Message.DisplayModes.Error);
       }
       uxPageMultiView.SetActiveView(uxViewMessage);
     }
     catch (Exception ex)
     {
       MessageUtilities.UpdateMessage(uxMessage,
         ex.Message, Message.DisplayModes.Error);
       uxPageMultiView.SetActiveView(uxViewMessage);
     }
  }

GetItem

GetItem(System.Int64)

Retrieves the properties of a specific Web Calendar object.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Web Calendar ID

Parameters

  • calendarId. The ID of the calendar to retrieve.

Returns

Retrieved WebCalendarData object.

.aspx code snippet

<ol class="formFields">
 <li class="clearfix">
   <ektronUI:Label ID="uxWebcalendarIDLabel"
     AssociatedControlID="uxWebcalendarID" CssClass="span-4 last"
     runat="server" Text="* Webcalendar ID :" />
   <ektronUI:TextField ID="uxWebcalendarID" CssClass="span-4"
     runat="server" ValidationGroup="RegisterValidationGroup" Text="88" />
 </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>
 <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4"
    runat="server" Text="* - Required" />
</ol>
       
<ol class="formFields">
  <li class="clearfix">
  <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
  </li>
  <li class="clearfix">
  <asp:Literal ID="uxWebcalendarName" runat="server"></asp:Literal>
  </li>
  <li class="clearfix">
  <asp:Literal ID="uxWebcalendarDescription" runat="server"></asp:Literal>
  </li>
  <li class="clearfix">
  <asp:Literal ID="uxWebcalendarParentID" 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.Site;
using Ektron.Cms.Framework.Calendar;
using Ektron.Cms.Common.Calendar;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
  {
    try
    {
      WebCalendarManager WebcalendarManager = new WebCalendarManager();
      long WebcalenderID = Convert.ToInt64(uxWebcalendarID.Text);

      if (WebcalenderID > 0)
      {
        //Get a webcalender     
        WebCalendarData WebcalendarData
          = WebcalendarManager.GetItem(WebcalenderID);
        if (WebcalendarData != null)
        {
          MessageUtilities.UpdateMessage(uxMessage,
            "WebCalendar Details for ID: " + WebcalenderID 
            + " are below", Message.DisplayModes.Success);
          uxWebcalendarName.Text = "WebCalendar Name : " 
            + WebcalendarData.Name;
          uxWebcalendarDescription.Text = "Description  : " 
            + WebcalendarData.Description;
          uxWebcalendarParentID.Text = "Parent Folder ID : " 
            + WebcalendarData.ParentId;
        }
        else
        {
          uxStatus.Visible = true;
          MessageUtilities.UpdateMessage(uxStatus,
            "Please Enter a Valid Webcalender ID",
            Message.DisplayModes.Error);
          return;
         }
      }
      else
      {
        uxStatus.Visible = true;
        MessageUtilities.UpdateMessage(uxStatus,
          "Please Enter a Valid Webcalender 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.Calendar.WebEventCriteria)

Retrieves lists of objects through the GetList(WebEventCriteria) method.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Calendar Property
  • * Object Value

Parameters

  • criteria. Criteria used to retrieve calendars.

Returns

List with retrieved WebCalendarData items.

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="uxCalendarPropertyLabel"
      AssociatedControlID="uxCalendarProperty"
      CssClass="span-4 last" runat="server" Text="*CalendarProperty :" />
    <asp:DropDownList ID="uxCalendarProperty" runat="server">
      <asp:ListItem>Id</asp:ListItem>
      <asp:ListItem>Title</asp:ListItem>
      <asp:ListItem>Description</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" Text="88" />
  </li>
  <ektronUI:Button ID="uxSubmit" runat="server"
    OnClick="uxSubmit_Click" Text="GetList"></ektronUI:Button>
  <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4"
    runat="server" Text="* - Required" />
</ol>
          
<ol class="formFields">
  <li class="clearfix">
    <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
  </li>
  <li class="clearfix"></li>
  <asp:ListView ID="uxCalendarlistView" 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>Name</th>
          <th>Description</th>
          <th>ParentId</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("Name")%></td>
      <td class="devsite-method"><%# Eval("Description")%></td>
      <td class="devsite-method"><%# Eval("ParentId")%></td>
    </tr>
  </ItemTemplate>
  </asp:ListView>
</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.Site;
using Ektron.Cms.Framework.Calendar;
using Ektron.Cms.Common.Calendar;
using Ektron.Cms.Common;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
  {
    try
    {
      WebCalendarManager WebcalendarManager = new WebCalendarManager();
      object Objectvalue;
      string Property = uxCalendarProperty.SelectedItem.Text;

      WebCalendarCriteria criteria = new WebCalendarCriteria();
      criteria.OrderByField = WebCalendarProperty.Id;
      criteria.OrderByDirection = EkEnumeration.OrderByDirection.Ascending;

      if (Property == "Id")
      {
        Objectvalue = Convert.ToInt64(uxObjectValue.Text);
        criteria.AddFilter(WebCalendarProperty.Id,
          CriteriaFilterOperator.EqualTo, Objectvalue);
      }
      else if (Property == "Title")
      {
        Objectvalue = uxObjectValue.Text;
        criteria.AddFilter(WebCalendarProperty.FolderName,
          CriteriaFilterOperator.Contains, Objectvalue);
      }
      else
      {
        Objectvalue = uxObjectValue.Text;
        criteria.AddFilter(WebCalendarProperty.Description,
          CriteriaFilterOperator.Contains, Objectvalue);
      }
      List<WebCalendarData> webCalendarList
        = WebcalendarManager.GetList(criteria);          
           
      //Display the Web Calender List
      uxCalendarlistView.Visible = true;
      uxCalendarlistView.DataSource = webCalendarList;
      uxCalendarlistView.DataBind();

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

GetPublicCalendar

GetPublicCalendar(System.Int64)

Retrieves a calendar with only public fields populated.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Webcalendar ID (User ID or Group ID)

Parameters

  • calendarId

Returns

WebCalendarData with only public fields populated.

.aspx code snippet

<ol class="formFields">
  <li class="clearfix">
    <ektronUI:Label ID="uxWebcalendarIDLabel"
      AssociatedControlID="uxWebcalendarID" CssClass="span-4 last"
      runat="server" Text="* Webcalendar ID :" />
    <ektronUI:TextField ID="uxWebcalendarID" CssClass="span-4"
      runat="server" ValidationGroup="RegisterValidationGroup" Text="88" />
  </li>
  <ektronUI:Button ID="uxSubmit" runat="server"
    OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
  <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4"
    runat="server" Text="* - Required" />
</ol>
       
<ol class="formFields">
  <li class="clearfix">
  <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
  </li>
  <li class="clearfix">
  <asp:Literal ID="uxWebcalendarName" runat="server"></asp:Literal>
  </li>
  <li class="clearfix">
  <asp:Literal ID="uxWebcalendarDescription" 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.Site;
using Ektron.Cms.Framework.Calendar;
using Ektron.Cms.Common.Calendar;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
  {
    try
    {
      WebCalendarManager WebcalendarManager = new WebCalendarManager();
      long WebcalenderID = Convert.ToInt64(uxWebcalendarID.Text);

      if (WebcalenderID > 0)
      {
        //Get a Public webcalender     
        WebCalendarData WebcalendarData
          = WebcalendarManager.GetPublicCalendar(WebcalenderID);
        if (WebcalendarData != null)
        {
          MessageUtilities.UpdateMessage(uxMessage,
            "WebCalendar Details for ID: " + WebcalenderID
            + " are below", Message.DisplayModes.Success);
          uxWebcalendarName.Text = "WebCalendar Name : "
            + WebcalendarData.Name;
          uxWebcalendarDescription.Text = "Description  : "
            + WebcalendarData.Description;
        }
        else
        {
          MessageUtilities.UpdateMessage(uxMessage,
            "Please Enter a Valid Webcalender ID",
            Message.DisplayModes.Error);
        }
      }
      else
      {
         MessageUtilities.UpdateMessage(uxMessage,
           "Please Enter a Valid Webcalender ID",
           Message.DisplayModes.Error);
      }
      uxPageMultiView.SetActiveView(uxViewMessage);
    }
    catch (Exception ex)
    {
      MessageUtilities.UpdateMessage(uxMessage, ex.Message,
        Message.DisplayModes.Error);
      uxPageMultiView.SetActiveView(uxViewMessage);
    }
  }

GetPublicCalendar

GetPublicCalendar(Ektron.Cms.Common.EkEnumeration.WorkSpace,System.Int64)

Get public calendar by owner type and owner ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Work Space
  • * Owner ID (User ID or Group ID)

Parameters

  • ownerId
  • ownerType. Owner type either User or Group.

.aspx code snippet

<ol class="formFields">
  <li class="clearfix">
    <ektronUI:Label ID="uxWorkSpaceLabel" AssociatedControlID="uxWorkSpace"
      CssClass="span-4 last" runat="server" Text="*WorkSpace :" />
    <asp:DropDownList ID="uxWorkSpace" runat="server">
      <asp:ListItem>UserId</asp:ListItem>
      <asp:ListItem>GroupID</asp:ListItem>                           
    </asp:DropDownList>
  </li>
  <div class="ektronTopSpace">
  </div>
  <li class="clearfix">
    <ektronUI:Label ID="uxOwnerIDLabel" AssociatedControlID="uxOwnerID"
      CssClass="span-4 last"  
      runat="server" Text="*Owner ID (UserId/ GroupId) :" />
    <ektronUI:TextField ID="uxOwnerID" CssClass="span-4"
      runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
  </li>
  <div class="ektronTopSpace">
  </div>                    
  <li class="clearfix">
    <ektronUI:Button ID="uxSubmit" runat="server"
      OnClick="uxSubmit_Click" Text="GetCalendar"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4"
      runat="server" Text="* - Required" />
  </li>
</ol>
            
<ol class="formFields">
  <li class="clearfix">
    <ektronUI:Message ID="uxMessage" DisplayMode="Information"
      Visible="false" runat="server" />
  </li>
  <li class="clearfix">
    <asp:Literal ID="uxWebcalendarName" runat="server"></asp:Literal>
  </li>
  <li class="clearfix">
    <asp:Literal ID="uxWebcalendarDescription" 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.Site;
using Ektron.Cms.Framework.Calendar;
using Ektron.Cms.Common.Calendar;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
  {
    try
    {
      WebCalendarManager WebcalendarManager = new WebCalendarManager();
      long ownerID = Convert.ToInt64(uxOwnerID.Text);
      WebCalendarData WebcalendarData = new WebCalendarData();
      if (ownerID > 0)
      {
        if (uxWorkSpace.SelectedValue == "UserId")
        {
          //Get a Public webcalender     
          WebcalendarData = 
            WebcalendarManager.GetPublicCalendar(EkEnumeration.WorkSpace.User,
            ownerID);
        }
        else
        {
          //Get a Public webcalender     
          WebcalendarData = 
            WebcalendarManager.GetPublicCalendar(EkEnumeration.WorkSpace.Group,
            ownerID);
        }
        if (WebcalendarData != null)
        {
          MessageUtilities.UpdateMessage(uxMessage,
            "WebCalendar Details for ID: " + WebcalendarData.Id
              + " are below", Message.DisplayModes.Success);
          uxWebcalendarName.Text = "WebCalendar Name : " 
              + WebcalendarData.Name;
          uxWebcalendarDescription.Text = "Description  : "
              + WebcalendarData.Description;
        }
        else
        {
          MessageUtilities.UpdateMessage(uxMessage,
            "Please Enter a Valid Owner ID", Message.DisplayModes.Error);
        }
      }
      else
      {
        MessageUtilities.UpdateMessage(uxMessage,
          "Please Enter a Valid Owner ID", Message.DisplayModes.Error);
      }
      uxPageMultiView.SetActiveView(uxViewMessage);
    }
    catch (Exception ex)
    {
      MessageUtilities.UpdateMessage(uxMessage, ex.Message,
        Message.DisplayModes.Error);
      uxPageMultiView.SetActiveView(uxViewMessage);
    }
  }

Update

Update(Ektron.Cms.WebCalendarData)

Updates an existing WebCalendar item in the CMS.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Web Calendar ID
  • Web Calendar Name
  • Description

Parameters

  • calendar. WebCalendarData object to update.

Returns

Returns the WebCalendarData object updated.

Remarks

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

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

.aspx code snippet

<ol class="formFields">
  <li class="clearfix">
    <ektronUI:Label ID="uxWebcalendarIDLabel"
      AssociatedControlID="uxWebcalendarID" CssClass="span-4 last"
      runat="server" Text="WebcalendarID :" />
    <ektronUI:TextField ID="uxWebcalendarID" CssClass="span-4"
      runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
  </li>
  <li class="clearfix">
    <ektronUI:Label ID="uxWebcalendarNameLabel"
      AssociatedControlID="uxWebcalendarName" CssClass="span-4 last"
      runat="server" Text="WebcalendarName :" />
    <ektronUI:TextField ID="uxWebcalendarName" CssClass="span-4"
      runat="server" ValidationGroup="RegisterValidationGroup" />
  </li>
  <li class="clearfix">
    <ektronUI:Label ID="uxWebcalendarDescriptionLabel"
      AssociatedControlID="uxWebcalendarDescription"
      CssClass="span-4 last" runat="server" Text="Description :" />
    <ektronUI:TextField ID="uxWebcalendarDescription"
      CssClass="span-4" runat="server"
      ValidationGroup="RegisterValidationGroup" />
  </li>
  <ektronUI:Button ID="uxSubmit" runat="server"
    OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
  <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4"
    runat="server" Text="* - Required" />
</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.Site;
using Ektron.Cms.Framework.Calendar;
using Ektron.Cms.Common.Calendar;

.aspx.cs code-behind method

protected void Page_Init(object sender, EventArgs e)
  {
    ApiTitle = "Ektron.Cms.Framework.Calendar.WebCalendarManager";
    SelectedAccordion = "uxTabCalendar";
    ComponentName = "Ektron.Cms.Framework.Calendar.WebCalendarManager";
    ComponentUrl = "Framework/Calendar/WebCalendarManager/";
    DocumentationName = "Ektron.Cms.Framework.Calendar.WebCalendarManager.Update(Ektron.Cms.Common.Calendar.WebCalendarData)";
    this.IsDemoSafe = false;
   // CBWebCalendarManager.DefaultContentID = ContentID;
  }
  protected void uxSubmit_Click(object sender, EventArgs e)
  {
    try
    {
      WebCalendarManager WebcalendarManager = new WebCalendarManager();

      //Set the WebCalendar Details
      WebCalendarData WebcalendarData =
        WebcalendarManager.GetItem(Convert.ToInt64(uxWebcalendarID.Text));
      if (WebcalendarData != null)
      {
        WebcalendarData.Name = uxWebcalendarName.Text != string.Empty 
          ? uxWebcalendarName.Text : WebcalendarData.Name;
        WebcalendarData.Description = uxWebcalendarDescription.Text
          != string.Empty ? uxWebcalendarDescription.Text 
          : WebcalendarData.Description;

        //Update webcalender with given details.
        WebcalendarManager.Update(WebcalendarData);
        MessageUtilities.UpdateMessage(uxMessage,
          "WebCalendar with ID: " + WebcalendarData.Id 
            + " has been updated", Message.DisplayModes.Success);
       }
       else
       {
         MessageUtilities.UpdateMessage(uxMessage,
           "Please Enter Valid Calendar ID", Message.DisplayModes.Error);
       }
       uxPageMultiView.SetActiveView(uxViewMessage);
     }
     catch (Exception ex)
     {
       MessageUtilities.UpdateMessage(uxMessage, ex.Message,
         Message.DisplayModes.Error);
       uxPageMultiView.SetActiveView(uxViewMessage);
     }
  }

Data Classes

WebCalendarCriteria

Namespace

Ektron.Cms.Common.Calendar

Constructors

  • WebCalendarCriteria()
    public WebCalendarCriteria()
  • WebCalendarCriteria(Ektron.Cms.Common.WebCalendarProperty, EkEnumeration.OrderByDirection)
    public WebCalendarCriteria(Ektron.Cms.Common.WebCalendarProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the WebCalendarProperty are:

    • Description
    • FolderName
    • FolderPath
    • Id
    • ParentId

WebCalendarData

Namespace

Ektron.Cms.Common.Calendar

Properties

  • IsValid(ValidationResults). Validates the Calendar object and returns a list of errors.
    public bool IsValid(ValidationResults validationResult)
  • LoadFolderData(Ektron.Cms.FolderData)
    public void LoadFolderData(Ektron.Cms.FolderData folderData)
  • WebCalendarData()
    public WebCalendarData()