WebEventManager
The WebEventManager class manages schedules that appear on user calendars.
Namespace
Ektron.Cms.Framework.Calendar.WebEventManager
Constructors
Constructors
WebEventManager()WebEventManager(ApiAccessMode)
Properties
Properties
ApiMode. Gets or sets the current API access mode. If set toAdmin, 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.UserId. Gets or sets the ID of the currently logged-in user.WebEventManagerService. WebEvent manager service.
Methods
Methods
Add. Adds a new event to a Web Calendar.
Add
Add(Ektron.Cms.Common.Calendar.WebEventData)
Adds a new event to a Web Calendar.
This method takes one argument for the WebEventData class. When you add the Web Calendar, the method returns a new WebEvent 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 Event Title
- * Web Calendar ID
- Location
- Description
- * Start Date Time
- * End Date Time
Parameters
eventData. WebEventData object to add.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxWebEventTitleLabel" AssociatedControlID="uxWebEventTitle" CssClass="span-4 last"
runat="server" Text="* WebEvent Title :" />
<ektronUI:TextField ID="uxWebEventTitle" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<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="uxLocationLabel" AssociatedControlID="uxLocation" CssClass="span-4 last"
runat="server" Text="Location :" />
<ektronUI:TextField ID="uxLocation" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxWebEventDescriptionLabel" AssociatedControlID="uxWebEventDescription"
CssClass="span-4 last" runat="server" Text="Description :" />
<asp:TextBox TextMode="MultiLine" Rows="3" ID="uxWebEventDescription" CssClass="span-4"
runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxStartDateLabel" AssociatedControlID="uxStartDate" CssClass="span-4 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-4 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>
<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(uxWebEventTitle.Text))
{
WebEventManager webeventManager = new WebEventManager();
String st = uxStartDate.Text + " " + uxStartTime.SelectedItem.Text + ":00:00 " + uxStartPeriod.SelectedItem.Text;
String et = uxEndDate.Text + " " + uxEndTime.SelectedItem.Text + ":00:00 " + uxEndPeriod.SelectedItem.Text;
DateTime startdatetime = DateTime.Parse(st);
DateTime endDatetime = DateTime.Parse(et);
//Set the WebEvent Details
WebEventData WebeventData = new WebEventData()
{
Title = uxWebEventTitle.Text,
FolderId = Convert.ToInt64(uxWebcalendarID.Text),
Location = uxLocation.Text,
Description = uxWebEventDescription.Text,
EventStart = startdatetime,
EventEnd = endDatetime,
};
//Add a webEvent with given details.
webeventManager.Add(WebeventData);
MessageUtilities.UpdateMessage(uxMessage, "WebEvent Saved with Id " + WebeventData.Id, Message.DisplayModes.Success);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter WebEvent title and try again", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
CancelOccurrence. Cancels an occurrence of a recurring event.
CancelOccurrence
CancelOccurrence(System.Int64, System.DateTime)
Cancels an occurrence of a recurring event.
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
- * Recurring Web Event ID
- * Event Occurrence Date
Parameters
eventId. ID of the recurring event for which to cancel an occurrence.occurrenceStartUtc. The event occurrence date to cancel.
Returns
ID of the event variance created for the cancellation.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxWebEventIDLabel" AssociatedControlID="uxWebEventID" CssClass="span-4 last"
runat="server" Text="*Recurring WebEventID :" />
<ektronUI:TextField ID="uxWebEventID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
Text="0" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxStartDateLabel" AssociatedControlID="uxStartDate" CssClass="span-4 last"
runat="server" Text="*EventOccurance Date :" />
<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>
<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
{
WebEventManager webeventManager = new WebEventManager();
String st = uxStartDate.Text + " " + uxStartTime.SelectedItem.Text + ":00:00 " + uxStartPeriod.SelectedItem.Text;
DateTime startdatetime = DateTime.Parse(st).ToUniversalTime();
long eventid = Convert.ToInt64(uxWebEventID.Text);
//Check the WebEvent Details
WebEventData WebeventData = webeventManager.GetItem(eventid);
if (WebeventData != null)
{
//Cancels an occurence of a recurring event.
long cancelID = webeventManager.CancelOccurrence(eventid, startdatetime);
MessageUtilities.UpdateMessage(uxMessage, "Canceled an occurence of a supplied recurring Web Event ID : " + eventid, Message.DisplayModes.Success);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Web Calendar Event ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
CreateVariance (1). Creates a WebEventData object representing a variance event for the supplied recurring event ID.
CreateVariance
CreateVariance(System.Int64, System.DateTime)
Creates a WebEventData object representing variance event for the supplied recurring event ID. The WebEventData object is not yet saved and should be passed to Add() when ready for saving.
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
- * Recurring Web Event ID
- * Event Occurrence Date
Parameters
eventId. ID of the recurring event for which to create a variance.occurrenceStartUtc. The event occurrence date for which to create a variance.
Returns
An unsaved WebEvent representing the event variance.
Remarks
You should pass the WebEventData to Add() when you are ready to save the object.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxWebEventIDLabel" AssociatedControlID="uxWebEventID" CssClass="span-4 last"
runat="server" Text="*Recurring WebEventID :" />
<ektronUI:TextField ID="uxWebEventID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
Text="251" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxStartDateLabel" AssociatedControlID="uxStartDate" CssClass="span-4 last"
runat="server" Text="*EventOccurance Date :" />
<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>
<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
{
WebEventManager webeventManager = new WebEventManager();
String st = uxStartDate.Text + " " + uxStartTime.SelectedItem.Text + ":00:00 " + uxStartPeriod.SelectedItem.Text;
DateTime startdatetime = DateTime.Parse(st);
long eventid = Convert.ToInt64(uxWebEventID.Text);
//Check the WebEvent Details
WebEventData webEventData = webeventManager.GetItem(eventid);
if (webEventData != null)
{
//Creates a variance event for the supplied recurring event id.
webEventData = webeventManager.CreateVariance(eventid, startdatetime);
uxTitle.Text = webEventData.Title;
uxDate.Text = webEventData.EventStart.ToShortDateString() + " " + webEventData.EventStart.ToShortTimeString();
MessageUtilities.UpdateMessage(uxMessage, "Created a variance event for the supplied recurring Web Event ID : " + eventid, Message.DisplayModes.Success);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Web Calendar Event ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
CreateVariance (2). Creates a WebEventData object representing a variance event for the supplied recurring event ID.
CreateVariance
CreateVariance(System.Int64, System.DateTime, System.DateTime)
Creates a WebEventData object representing variance event for the supplied recurring event id. The WebEventData object has not been saved yet and should be passed to Add() when ready for saving.
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
- * Recurring Web Event ID
- * Event Occurrence Date
- * Start Date Time
Parameters
eventId. ID of the recurring event for which to create a variance.occurrenceStartUtc. The event occurrence date for which to create a variance.newStartUtc. The new occurrence start date; Coordinated Universal Time (UTC).
Returns
An unsaved WebEvent representing the event variance.
Remarks
You should pass the WebEventData to Add() when you are ready to save the object.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxWebEventIDLabel" AssociatedControlID="uxWebEventID" CssClass="span-4 last"
runat="server" Text="*Recurring WebEventID :" />
<ektronUI:TextField ID="uxWebEventID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
Text="251" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxEventOccuranceDateLabel" AssociatedControlID="uxEventOccuranceDate"
CssClass="span-4 last" runat="server" Text="*EventOccurance Date :" />
<ektronUI:DatePicker Rows="3" ID="uxEventOccuranceDate" CssClass="span-4" runat="server"
Text="MM/DD/YYYY" ValidationGroup="RegisterValidationGroup" />
<asp:DropDownList ID="uxEventOccuranceTime" 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="uxEventOccurancePeriod" runat="server">
<asp:ListItem>AM</asp:ListItem>
<asp:ListItem>PM</asp:ListItem>
</asp:DropDownList>
</li>
<li class="clearfix">
<ektronUI:Label ID="uxStartDateLabel" AssociatedControlID="uxStartDate" CssClass="span-4 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>
<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
{
WebEventManager webeventManager = new WebEventManager();
String et = uxEventOccuranceDate.Text + " " + uxEventOccuranceTime.SelectedItem.Text + ":00:00 " + uxEventOccurancePeriod.SelectedItem.Text;
String st = uxStartDate.Text + " " + uxStartTime.SelectedItem.Text + ":00:00 " + uxStartPeriod.SelectedItem.Text;
DateTime EventOccuranceDatetime = DateTime.Parse(et);
DateTime startdatetime = DateTime.Parse(st);
long eventid = Convert.ToInt64(uxWebEventID.Text);
//Check the WebEvent Details
WebEventData webEventData = webeventManager.GetItem(eventid);
if (webEventData != null)
{
//Creates a variance event for the supplied recurring event id.
webEventData = webeventManager.CreateVariance(eventid, EventOccuranceDatetime, startdatetime);
uxTitle.Text = webEventData.Title;
uxDate.Text = webEventData.EventStart.ToShortDateString() + " " + webEventData.EventStart.ToShortTimeString();
MessageUtilities.UpdateMessage(uxMessage, "Created a variance event for the supplied recurring Web Event ID : " + eventid, Message.DisplayModes.Success);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Web Calendar Event ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
Delete. Deletes a Web calendar event from the CMS.
Delete
Delete(System.Int64)
Deletes a Web calendar event 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 Event ID
Parameters
id. ID of WebEvent to delete.
Remarks
Validate the item using GetItem() before deleting.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxWebEventIDLabel" AssociatedControlID="uxWebEventID" CssClass="span-4 last"
runat="server" Text="* WebEventID :" />
<ektronUI:TextField ID="uxWebEventID" 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
{
WebEventManager webeventManager = new WebEventManager();
long eventid = Convert.ToInt64(uxWebEventID.Text);
//Check the WebEvent Details
WebEventData WebeventData = webeventManager.GetItem(eventid);
if (WebeventData != null)
{
//Delete a webEvent with given ID.
webeventManager.Delete(eventid);
MessageUtilities.UpdateMessage(uxMessage, "Web Event ID : " + WebeventData.Id + " has been Deleted from the Calendar.", Message.DisplayModes.Success);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid WebEvent ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetEventOccurrenceList (date/time). Returns a list of events for the calendar that occur during the supplied time period.
GetEventOccurrenceList (date/time)
GetEventOccurrenceList(System.Int64,System.DateTime,System.DateTime,System.Boolean)
Returns a list of events for the calendar that occur during the supplied time period. This will return all event occurrences including individual occurrences for recurring events.
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
- * Start Date Time
- * End Date Time
Parameters
calendarId. ID of the calendar to retrieve events for.startUtc. Start of search span.endUtc. End of search span.
Returns
Retrieved list of WebEventData objects.
.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">
<ektronUI:Label ID="uxStartDateLabel" AssociatedControlID="uxStartDate" CssClass="span-4 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-4 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>
<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="uxEventlistView" runat="server" ItemPlaceholderID="aspItemPlaceholder"
Visible="false">
<EmptyDataTemplate>
Criteria did not match any records.</EmptyDataTemplate>
<LayoutTemplate>
<table class="devsite-api-method">
<thead>
<tr>
<th>
WebEvent Id
</th>
<th>
Title
</th>
<th>
Location
</th>
<th>
Start Date
</th>
<th>
End Date
</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("Location")%>
</td>
<td class="devsite-method">
<%# Eval("EventStart")%>
</td>
<td class="devsite-method">
<%# Eval("EventEnd")%>
</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;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
WebEventManager webeventManager = new WebEventManager();
long calendarId = Convert.ToInt64(uxWebCalendarID.Text);
String st = uxStartDate.Text + " " + uxStartTime.SelectedItem.Text + ":00:00 " + uxStartPeriod.SelectedItem.Text;
String et = uxEndDate.Text + " " + uxEndTime.SelectedItem.Text + ":00:00 " + uxEndPeriod.SelectedItem.Text;
DateTime startdatetime = DateTime.Parse(st);
DateTime endDatetime = DateTime.Parse(et);
//Check the WebEvent Details
List<WebEventData> webeventList = webeventManager.GetEventOccurrenceList(calendarId, startdatetime, endDatetime);
if (webeventList != null)
{
//Display the Web Event Details
uxEventlistView.Visible = true;
uxEventlistView.DataSource = webeventList;
uxEventlistView.DataBind();
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Calendar ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetEventOccurrenceList (event taxonomy). Retrieves a list of events for the calendar that occur during the supplied time period.
GetEventOccurrenceList (event taxonomy)
GetEventOccurrenceList(System.Int64,System.DateTime,System.DateTime, System.Collections.Generic.List)
Retrieves a list of events for the calendar that occur during the supplied time period. This will return all event occurrences including individual occurrences for recurring events.
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
- * Start Date Time
- * End Date Time
- Taxonomy Property
- * Object Value
Parameters
criteria. Criteria used to restrict Web Event retrieval.
Returns
Retrieved list of WebEventData objects.
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="uxEventPropertyLabel" AssociatedControlID="uxEventProperty" CssClass="span-3 last"
runat="server" Text="*EventTaxonomyProperty :" />
<asp:DropDownList ID="uxEventProperty" runat="server">
<asp:ListItem>Taxonomy Id</asp:ListItem>
<asp:ListItem>Id</asp:ListItem>
</asp:DropDownList>
</li>
<div class="ektronTopSpace"></div>
<li class="clearfix">
<ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-3 last"
runat="server" Text="*ObjectValue :" />
<ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
Text="189" />
</li>
<li class="clearfix">
<ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetList"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using Ektron.Cms; using Ektron.Cms.Common; using Ektron.Cms.Framework.Organization; using Ektron.Cms.Organization; using Ektron.Cms.Framework.Calendar; using Ektron.Cms.Common.Calendar; using Ektron.Site.Developer; using Ektron.Cms.Framework.UI.Controls.EktronUI;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
object Objectvalue;
var Property = uxEventProperty.SelectedItem.Text;
WebEventManager webeventManager = new WebEventManager();
EventTaxonomyCriteria criteria = new EventTaxonomyCriteria();
criteria.OrderByField = EventProperty.Title;
criteria.OrderByDirection = EkEnumeration.OrderByDirection.Descending;
if (Property == "Id")
{
Objectvalue = Convert.ToInt64(uxObjectValue.Text);
criteria.AddFilter(EventProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
}
else
{
Objectvalue = Convert.ToInt64(uxObjectValue.Text);
criteria.AddFilter(EventTaxonomyProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
}
//Check the WebEvent Details
List<WebEventData> webeventList = webeventManager.GetEventOccurrenceList(criteria);
if (webeventList != null)
{
//Display the Web Event Details
uxEventlistView.Visible = true;
uxEventlistView.DataSource = webeventList;
uxEventlistView.DataBind();
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetEventOccurrenceList (taxonomy). Returns a list of events for the calendar that occur during the supplied time period.
GetEventOccurrenceList (taxonomy)
GetEventOccurrenceList(System.Int64,System.DateTime,System.DateTime,System.Collections.Generic.List,System.Boolean)
Returns a list of events for the calendar that occur during the supplied time period. This will return all event occurrences including individual occurrences for recurring events.
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
- * Start Date Time
- * End Date Time
- Taxonomy Property
- * Object Value
Parameters
calendarId. ID of the calendar to retrieve events for.startUtc. Start of search span.endUtc. End of search span.-
TaxonomyIds. List of the taxonomies assigned to the event.
Returns
Retrieved list of WebEventData objects.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="Label1" AssociatedControlID="uxWebCalendarID" CssClass="span-4 last"
runat="server" Text="*WebCalendar ID :" />
<ektronUI:TextField ID="TextField1" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
Text="88" />
</li>
<li class="clearfix">
<ektronUI:Label ID="Label2" AssociatedControlID="uxStartDate" CssClass="span-4 last"
runat="server" Text="*Start DateTime :" />
<ektronUI:DatePicker Rows="3" ID="DatePicker1" CssClass="span-4" runat="server" Text="MM/DD/YYYY"
ValidationGroup="RegisterValidationGroup" />
<asp:DropDownList ID="DropDownList1" 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="DropDownList2" runat="server">
<asp:ListItem>AM</asp:ListItem>
<asp:ListItem>PM</asp:ListItem>
</asp:DropDownList>
</li>
<li class="clearfix">
<ektronUI:Label ID="Label3" AssociatedControlID="uxEndDate" CssClass="span-4 last"
runat="server" Text="*End DateTime :" />
<ektronUI:DatePicker Rows="3" ID="DatePicker2" CssClass="span-4" runat="server" Text="MM/DD/YYYY"
ValidationGroup="RegisterValidationGroup" />
<asp:DropDownList ID="DropDownList3" 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="DropDownList4" runat="server">
<asp:ListItem>AM</asp:ListItem>
<asp:ListItem>PM</asp:ListItem>
</asp:DropDownList>
</li>
<li class="clearfix">
<ektronUI:Label ID="Label4" AssociatedControlID="uxTaxonomyProperty" CssClass="span-4 last"
runat="server" Text="Taxonomy Property:" />
<asp:DropDownList ID="DropDownList5" runat="server">
<asp:ListItem>Taxonomy Id</asp:ListItem>
<asp:ListItem>Taxonomy Name</asp:ListItem>
</asp:DropDownList>
</li>
<li class="clearfix">
<ektronUI:Label ID="Label5" AssociatedControlID="uxObjectValue" CssClass="span-4 last"
runat="server" Text="* Object Value:" />
<ektronUI:TextField ID="TextField2" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
Text="189" />
</li>
<li class="clearfix">
<ektronUI:Button ID="Button1" runat="server" OnClick="uxSubmit_Click" Text="GetList"></ektronUI:Button>
<ektronUI:Label ID="Label6" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using Ektron.Cms; using Ektron.Cms.Common; using Ektron.Cms.Framework.Organization; using Ektron.Cms.Organization; using Ektron.Cms.Framework.Calendar; using Ektron.Cms.Common.Calendar; using Ektron.Site.Developer; using Ektron.Cms.Framework.UI.Controls.EktronUI;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
object Objectvalue;
TaxonomyCriteria criteria = new TaxonomyCriteria();
if (uxTaxonomyProperty.SelectedItem.Text == "Taxonomy Id")
{
Objectvalue = Convert.ToInt64(uxObjectValue.Text);
criteria.AddFilter(TaxonomyProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
}
else
{
Objectvalue = uxObjectValue.Text;
criteria.AddFilter(TaxonomyProperty.Name, CriteriaFilterOperator.Contains, Objectvalue);
}
TaxonomyManager taxonomyManager = new TaxonomyManager();
List<TaxonomyData> taxonomyItemList = taxonomyManager.GetList(criteria);
WebEventManager webeventManager = new WebEventManager();
long calendarId = Convert.ToInt64(uxWebCalendarID.Text);
String st = uxStartDate.Text + " " + uxStartTime.SelectedItem.Text + ":00:00 " + uxStartPeriod.SelectedItem.Text;
String et = uxEndDate.Text + " " + uxEndTime.SelectedItem.Text + ":00:00 " + uxEndPeriod.SelectedItem.Text;
DateTime startdatetime = DateTime.Parse(st);
DateTime endDatetime = DateTime.Parse(et);
//Check the WebEvent Details
List<WebEventData> webeventList = webeventManager.GetEventOccurrenceList(calendarId, startdatetime, endDatetime, taxonomyItemList.ConvertAll(IdsOnly));
if (webeventList != null)
{
//Display the Web Event Details
uxEventlistView.Visible = true;
uxEventlistView.DataSource = webeventList;
uxEventlistView.DataBind();
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Calendar ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
private static long IdsOnly(TaxonomyData input)
{
return input.Id;
}
GetEventOccurrenceList (Web event). Retrieves a list of events for the calendar that occur during the supplied time period.
GetEventOccurrenceList (Web event)
GetEventOccurrenceList(System.Int64,System.DateTime,System.DateTime)
Retrieves a list of events for the calendar that occur during the supplied time period. This will return all event occurrences including individual occurrences for recurring events.
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
- * Start Date Time
- * End Date Time
Parameters
criteria. Criteria used to restrict WebEvent retrieval.
Returns
Retrieved list of WebEventData objects.
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="uxEventPropertyLabel" AssociatedControlID="uxEventProperty" CssClass="span-3 last"
runat="server" Text="*EventProperty :" />
<asp:DropDownList ID="uxEventProperty" runat="server">
<asp:ListItem>Id</asp:ListItem>
<asp:ListItem>Title</asp:ListItem>
<asp:ListItem>Location</asp:ListItem>
</asp:DropDownList>
</li>
<li class="clearfix">
<ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-3 last"
runat="server" Text="*ObjectValue :" />
<ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
Text="251" />
</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="uxEventlistView" runat="server" ItemPlaceholderID="aspItemPlaceholder"
Visible="false">
<EmptyDataTemplate>
Criteria did not match any records.</EmptyDataTemplate>
<LayoutTemplate>
<table class="devsite-api-method">
<thead>
<tr>
<th>
WebEvent Id
</th>
<th>
Title
</th>
<th>
Location
</th>
<th>
Start Date
</th>
<th>
End Date
</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("Location")%>
</td>
<td class="devsite-method">
<%# Eval("EventStart")%>
</td>
<td class="devsite-method">
<%# Eval("EventEnd")%>
</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;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
object Objectvalue;
string Property = uxEventProperty.SelectedItem.Text;
WebEventManager webeventManager = new WebEventManager();
WebEventCriteria criteria = new WebEventCriteria();
criteria.OrderByField = EventProperty.Title;
criteria.OrderByDirection = EkEnumeration.OrderByDirection.Descending;
if (Property == "Id")
{
Objectvalue = Convert.ToInt64(uxObjectValue.Text);
criteria.AddFilter(EventProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
}
else if (Property == "Title")
{
Objectvalue = uxObjectValue.Text;
criteria.AddFilter(EventProperty.Title, CriteriaFilterOperator.Contains, Objectvalue);
}
else
{
Objectvalue = uxObjectValue.Text;
criteria.AddFilter(EventProperty.Location, CriteriaFilterOperator.Contains, Objectvalue);
}
List<WebEventData> webEventList = webeventManager.GetEventOccurrenceList(criteria);
//Display the Web Event Details
uxEventlistView.Visible = true;
uxEventlistView.DataSource = webEventList;
uxEventlistView.DataBind();
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetItem. Retrieves the properties of a specific WebEvent object.
GetItem
GetItem(System.Int64)
Retrieves the properties of a specific WebEvent 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 Event ID
Parameters
eventId. ID of the event to retrieve.
Returns
Retrieved WebEventData object.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxWebEventIDLabel" AssociatedControlID="uxWebEventID" CssClass="span-4 last"
runat="server" Text="* WebEventID :" />
<ektronUI:TextField ID="uxWebEventID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
Text="251" />
</li>
<ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetItem"></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>
<li class="clearfix">
<asp:Literal ID="uxWebEventTitle" runat="server"></asp:Literal>
</li>
<li class="clearfix">
<asp:Literal ID="uxWebEventDescription" runat="server"></asp:Literal>
</li>
<li class="clearfix">
<asp:Literal ID="uxWebEventLocation" runat="server"></asp:Literal>
</li>
<li class="clearfix">
<asp:Literal ID="uxWebEventStartDate" runat="server"></asp:Literal>
</li>
<li class="clearfix">
<asp:Literal ID="uxWebEventEndDate" 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
{
WebEventManager webeventManager = new WebEventManager();
long eventid = Convert.ToInt64(uxWebEventID.Text);
//Check the WebEvent Details
WebEventData WebeventData = webeventManager.GetItem(eventid);
if (WebeventData != null)
{
//Display the Web Event Details
MessageUtilities.UpdateMessage(uxMessage, "Web Event Details for ID : " + WebeventData.Id + " are below", Message.DisplayModes.Success);
uxWebEventTitle.Text = "Web Event Title : " + WebeventData.Title;
uxWebEventDescription.Text = "Description : " + WebeventData.Description;
uxWebEventLocation.Text = "Location : " + WebeventData.Location;
uxWebEventStartDate.Text = "Start Date : " + WebeventData.EventStart;
uxWebEventEndDate.Text = " End Date : " + WebeventData.EventEnd;
}
else
{
MessageUtilities.UpdateMessage(uxMessage,"Please Enter Valid WebEvent ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetList (date/time). Retrieves lists of objects.
GetList (date/time)
GetList(System.Int64,System.DateTime,System.DateTime)
Retrieves lists of objects.
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
- * Start Date Time
- * End Date Time
Parameters
calendarId. ID of the calendar for which to retrieve events.startUtc. Start of time period to retrieve.endUtc. End of time period to retrieve.
Returns
Retrieved list of WebEventData objects.
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="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">
<ektronUI:Label ID="uxStartDateLabel" AssociatedControlID="uxStartDate" CssClass="span-4 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-4 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>
<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="uxEventlistView" runat="server" ItemPlaceholderID="aspItemPlaceholder"
Visible="false">
<EmptyDataTemplate>
Criteria did not match any records.</EmptyDataTemplate>
<LayoutTemplate>
<table class="devsite-api-method">
<thead>
<tr>
<th>
WebEvent Id
</th>
<th>
Title
</th>
<th>
Location
</th>
<th>
Start Date
</th>
<th>
End Date
</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("Location")%>
</td>
<td class="devsite-method">
<%# Eval("EventStart")%>
</td>
<td class="devsite-method">
<%# Eval("EventEnd")%>
</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;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
WebEventManager webeventManager = new WebEventManager();
long calendarId = Convert.ToInt64(uxWebCalendarID.Text);
String st = uxStartDate.Text + " " + uxStartTime.SelectedItem.Text + ":00:00 " + uxStartPeriod.SelectedItem.Text;
String et = uxEndDate.Text + " " + uxEndTime.SelectedItem.Text + ":00:00 " + uxEndPeriod.SelectedItem.Text;
DateTime startdatetime = DateTime.Parse(st);
DateTime endDatetime = DateTime.Parse(et);
//Check the WebEvent Details
List<WebEventData> webeventList = webeventManager.GetList(calendarId, startdatetime, endDatetime);
if (webeventList != null)
{
//Display the Web Event Details
uxEventlistView.Visible = true;
uxEventlistView.DataSource = webeventList;
uxEventlistView.DataBind();
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Calendar ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetList (ID). Retrieves lists of objects.
GetList (ID)
GetList(System.Int64)
Retrieves lists of objects.
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 the calendar for which to retrieve events.
Returns
Retrieved list of WebEventData objects.
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="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="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="uxEventlistView" runat="server" ItemPlaceholderID="aspItemPlaceholder"
Visible="false">
<EmptyDataTemplate>
Criteria did not match any records.</EmptyDataTemplate>
<LayoutTemplate>
<table class="devsite-api-method">
<thead>
<tr>
<th>
WebEvent Id
</th>
<th>
Title
</th>
<th>
Location
</th>
<th>
Start Date
</th>
<th>
End Date
</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("Location")%>
</td>
<td class="devsite-method">
<%# Eval("EventStart")%>
</td>
<td class="devsite-method">
<%# Eval("EventEnd")%>
</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;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
WebEventManager webeventManager = new WebEventManager();
long calendarId = Convert.ToInt64(uxWebCalendarID.Text);
//Check the WebEvent Details
List<WebEventData> webeventList = webeventManager.GetList(calendarId);
if (webeventList != null)
{
//Display the Web Event Details
uxEventlistView.Visible = true;
uxEventlistView.DataSource = webeventList;
uxEventlistView.DataBind();
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Calendar ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetList (taxonomy). Returns a list of WebEvents based upon the supplied criteria.
GetList (taxonomy)
GetList(Ektron.Cms.EventTaxonomyCriteria)
Returns a list of WebEvents based upon the supplied criteria.
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
- * Event Property
- * Object Value
Parameters
criteria. Criteria used to restrict WebEvent retrieval.
Returns
Retrieved list of WebEventData objects.
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="uxEventPropertyLabel" AssociatedControlID="uxEventProperty" CssClass="span-3 last"
runat="server" Text="*EventTaxonomyProperty :" />
<asp:DropDownList ID="uxEventProperty" runat="server">
<asp:ListItem>Taxonomy Id</asp:ListItem>
<asp:ListItem>Id</asp:ListItem>
</asp:DropDownList>
</li>
<div class="ektronTopSpace"></div>
<li class="clearfix">
<ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-3 last"
runat="server" Text="*ObjectValue :" />
<ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
Text="189" />
</li>
<li class="clearfix">
<ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetList"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using Ektron.Cms; using Ektron.Cms.Common; using Ektron.Cms.Framework.Organization; using Ektron.Cms.Organization; using Ektron.Cms.Framework.Calendar; using Ektron.Cms.Common.Calendar; using Ektron.Site.Developer; using Ektron.Cms.Framework.UI.Controls.EktronUI;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
object Objectvalue;
var Property = uxEventProperty.SelectedItem.Text;
WebEventManager webeventManager = new WebEventManager();
EventTaxonomyCriteria criteria = new EventTaxonomyCriteria();
criteria.OrderByField = EventProperty.Title;
criteria.OrderByDirection = EkEnumeration.OrderByDirection.Descending;
if (Property == "Id")
{
Objectvalue = Convert.ToInt64(uxObjectValue.Text);
criteria.AddFilter(EventProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
}
else
{
Objectvalue = Convert.ToInt64(uxObjectValue.Text);
criteria.AddFilter(EventTaxonomyProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
}
//Check the WebEvent Details
List<WebEventData> webeventList = webeventManager.GetList(criteria);
if (webeventList != null)
{
//Display the Web Event Details
uxEventlistView.Visible = true;
uxEventlistView.DataSource = webeventList;
uxEventlistView.DataBind();
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetList (Web event). Retrieves lists of objects.
GetList (Web event)
GetList(Ektron.Cms.Common.Calendar.WebEventCriteria)
Retrieves lists of objects.
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
- * Event Property
- * Object Value
Parameters
criteria. Criteria used to restrict WebEvent retrieval.
Returns
Retrieved list of WebEventData objects.
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="uxEventPropertyLabel" AssociatedControlID="uxEventProperty" CssClass="span-3 last"
runat="server" Text="*EventProperty :" />
<asp:DropDownList ID="uxEventProperty" runat="server">
<asp:ListItem>Id</asp:ListItem>
<asp:ListItem>Title</asp:ListItem>
<asp:ListItem>Location</asp:ListItem>
</asp:DropDownList>
</li>
<li class="clearfix">
<ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-3 last"
runat="server" Text="*ObjectValue :" />
<ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
Text="251" />
</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="uxEventlistView" runat="server" ItemPlaceholderID="aspItemPlaceholder"
Visible="false">
<EmptyDataTemplate>
Criteria did not match any records.</EmptyDataTemplate>
<LayoutTemplate>
<table class="devsite-api-method">
<thead>
<tr>
<th>
WebEvent Id
</th>
<th>
Title
</th>
<th>
Location
</th>
<th>
Start Date
</th>
<th>
End Date
</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("Location")%>
</td>
<td class="devsite-method">
<%# Eval("EventStart")%>
</td>
<td class="devsite-method">
<%# Eval("EventEnd")%>
</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;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
object Objectvalue;
string Property = uxEventProperty.SelectedItem.Text;
WebEventManager webeventManager = new WebEventManager();
WebEventCriteria criteria = new WebEventCriteria();
criteria.OrderByField = EventProperty.Title;
criteria.OrderByDirection = EkEnumeration.OrderByDirection.Descending;
if (Property == "Id")
{
Objectvalue = Convert.ToInt64(uxObjectValue.Text);
criteria.AddFilter(EventProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
}
else if (Property == "Title")
{
Objectvalue = uxObjectValue.Text;
criteria.AddFilter(EventProperty.Title, CriteriaFilterOperator.Contains, Objectvalue);
}
else
{
Objectvalue = uxObjectValue.Text;
criteria.AddFilter(EventProperty.Location, CriteriaFilterOperator.Contains, Objectvalue);
}
List<WebEventData> webEventList = webeventManager.GetList(criteria);
//Display the Web Event Details
uxEventlistView.Visible = true;
uxEventlistView.DataSource = webEventList;
uxEventlistView.DataBind();
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetNonVariantEventList (date/time). Retrieves an EventVarianceDictionary containing all the variances for the supplied calendar in the given time frame.
GetNonVariantEventList (date/time)
GetVariantEventList(System.Int64,System.DateTime,System.DateTime)
Returns a list of original event data items for the calendar. For recurring events, this only returns the actual event items and not the occurrences or variants of recurring events.
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
- * Start Date Time
- * End Date Time
Parameters
calendarId. ID of the calendar for which to retrieve events.startUtc. Start of time period to retrieve.endUtc. End of time period to retrieve.
Returns
Retrieved list of WebEventData objects.
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="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">
<ektronUI:Label ID="uxStartDateLabel" AssociatedControlID="uxStartDate" CssClass="span-4 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-4 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>
<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="uxEventlistView" runat="server" ItemPlaceholderID="aspItemPlaceholder"
Visible="false">
<EmptyDataTemplate>
Criteria did not match any records.</EmptyDataTemplate>
<LayoutTemplate>
<table class="devsite-api-method">
<thead>
<tr>
<th>
WebEvent Id
</th>
<th>
Title
</th>
<th>
Location
</th>
<th>
Start Date
</th>
<th>
End Date
</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("Location")%>
</td>
<td class="devsite-method">
<%# Eval("EventStart")%>
</td>
<td class="devsite-method">
<%# Eval("EventEnd")%>
</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;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
WebEventManager webeventManager = new WebEventManager();
long calendarId = Convert.ToInt64(uxWebCalendarID.Text);
String st = uxStartDate.Text + " " + uxStartTime.SelectedItem.Text + ":00:00 " + uxStartPeriod.SelectedItem.Text;
String et = uxEndDate.Text + " " + uxEndTime.SelectedItem.Text + ":00:00 " + uxEndPeriod.SelectedItem.Text;
DateTime startdatetime = DateTime.Parse(st);
DateTime endDatetime = DateTime.Parse(et);
//Check the WebEvent Details
List<WebEventData> webeventList = webeventManager.GetNonVariantEventList(calendarId, startdatetime, endDatetime);
if (webeventList != null)
{
//Display the Web Event Details
uxEventlistView.Visible = true;
uxEventlistView.DataSource = webeventList;
uxEventlistView.DataBind();
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Calendar ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetNonVariantEventList (ID). Retrieves list of original eventdata items for the calendar.
GetNonVariantEventList (ID)
GetNonVariantEventList(System.Int64)
Retrieves list of original eventdata items for the calendar. For recurring events, this method returns only the actual event items and not the occurrences or variants of recurring events.
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 the calendar for which to retrieve events.
Returns
Retrieved list of WebEventData objects.
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="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="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="uxEventlistView" runat="server" ItemPlaceholderID="aspItemPlaceholder"
Visible="false">
<EmptyDataTemplate>
Criteria did not match any records.</EmptyDataTemplate>
<LayoutTemplate>
<table class="devsite-api-method">
<thead>
<tr>
<th>
WebEvent Id
</th>
<th>
Title
</th>
<th>
Location
</th>
<th>
Start Date
</th>
<th>
End Date
</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("Location")%>
</td>
<td class="devsite-method">
<%# Eval("EventStart")%>
</td>
<td class="devsite-method">
<%# Eval("EventEnd")%>
</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;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
WebEventManager webeventManager = new WebEventManager();
long calendarId = Convert.ToInt64(uxWebCalendarID.Text);
//Check the WebEvent Details
List<WebEventData> webeventList = webeventManager.GetNonVariantEventList(calendarId);
if (webeventList != null)
{
//Display the Web Event Details
uxEventlistView.Visible = true;
uxEventlistView.DataSource = webeventList;
uxEventlistView.DataBind();
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Calendar ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetVariantEventList (date/time). Retrieves an EventVarianceDictionary containing all the variances for the supplied calendar in the given time frame.
GetVariantEventList (date/time)
GetVariantEventList(System.Int64,System.DateTime,System.DateTime)
Retrieves an EventVarianceDictionary containing all the variances for the supplied calendar in the given time frame.
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
- * Start Date Time
- * End Date Time
Parameters
calendarId. ID of the calendar for which to retrieve events.startUtc. Start of time period to retrieve.endUtc. End of time period to retrieve.
Returns
Retrieved WebEventVarianceDictionary object which is a specialized Dictionary class for organizing event variances. Key is the recurring event ID. Value is collection of WebEvents that are variances associated with the original recurring event.
public class WebEventVarianceDictionary : System.Collections.Generic.Dictionary<long,List<WebEventData>>
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="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">
<ektronUI:Label ID="uxStartDateLabel" AssociatedControlID="uxStartDate" CssClass="span-4 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-4 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>
<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="uxEventlistView" runat="server" ItemPlaceholderID="aspItemPlaceholder"
Visible="false">
<EmptyDataTemplate>
Criteria did not match any records.</EmptyDataTemplate>
<LayoutTemplate>
<table class="devsite-api-method">
<thead>
<tr>
<th>
WebEvent Id
</th>
<th>
Title
</th>
<th>
Location
</th>
<th>
Start Date
</th>
<th>
End Date
</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("Location")%>
</td>
<td class="devsite-method">
<%# Eval("EventStart")%>
</td>
<td class="devsite-method">
<%# Eval("EventEnd")%>
</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;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
WebEventManager webeventManager = new WebEventManager();
long calendarId = Convert.ToInt64(uxWebCalendarID.Text);
String st = uxStartDate.Text + " " + uxStartTime.SelectedItem.Text + ":00:00 " + uxStartPeriod.SelectedItem.Text;
String et = uxEndDate.Text + " " + uxEndTime.SelectedItem.Text + ":00:00 " + uxEndPeriod.SelectedItem.Text;
DateTime startdatetime = DateTime.Parse(st);
DateTime endDatetime = DateTime.Parse(et);
//Check the WebEvent Details
WebEventVarianceDictionary webEventVarianceDictionary = webeventManager.GetVarianceEventList(calendarId, startdatetime, endDatetime);
List<WebEventData> webEventData = new List<WebEventData>();
if (webEventVarianceDictionary != null)
{
if (webEventVarianceDictionary.Count > 0)
{
foreach (KeyValuePair<long, List<WebEventData>> key in webEventVarianceDictionary)
{
webEventData.AddRange(key.Value);
}
}
//Display the Web Event Details
uxEventlistView.Visible = true;
uxEventlistView.DataSource = webEventData;
uxEventlistView.DataBind();
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Calendar ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetVariantEventList (ID). Retrieves an EventVarianceDictionary containing all the variances for the supplied calendar in the given time frame.
GetVariantEventList (ID)
GetVariantEventList(System.Int64)
Retrieves an EventVarianceDictionary containing all the variances for the supplied calendar in the given time frame.
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 the calendar for which to retrieve events.
Returns
Retrieved WebEventVarianceDictionary object which is a specialized Dictionary class for organizing event variances. Key is the recurring event ID. Value is collection of WebEvents that are variances associated with the original recurring event.
public class WebEventVarianceDictionary : System.Collections.Generic.Dictionary<long,List<WebEventData>>
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="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="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="uxEventlistView" runat="server" ItemPlaceholderID="aspItemPlaceholder"
Visible="false">
<EmptyDataTemplate>
Criteria did not match any records.</EmptyDataTemplate>
<LayoutTemplate>
<table class="devsite-api-method">
<thead>
<tr>
<th>
WebEvent Id
</th>
<th>
Title
</th>
<th>
Location
</th>
<th>
Start Date
</th>
<th>
End Date
</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("Location")%>
</td>
<td class="devsite-method">
<%# Eval("EventStart")%>
</td>
<td class="devsite-method">
<%# Eval("EventEnd")%>
</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;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
WebEventManager webeventManager = new WebEventManager();
long calendarId = Convert.ToInt64(uxWebCalendarID.Text);
//Check the WebEvent Details
WebEventVarianceDictionary webEventVarianceDictionary = webeventManager.GetVarianceEventList(calendarId);
List<WebEventData> webEventData = new List<WebEventData>();
if (webEventVarianceDictionary != null)
{
if (webEventVarianceDictionary.Count > 0)
{
foreach (KeyValuePair<long, List<WebEventData>> key in webEventVarianceDictionary)
{
webEventData.AddRange(key.Value);
}
}
//Display the Web Event Details
uxEventlistView.Visible = true;
uxEventlistView.DataSource = webEventData;
uxEventlistView.DataBind();
}
else
{
MessageUtilities.UpdateMessage(uxMessage,"Please Enter Valid Calendar ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
Update. Updates an existing WebEvent item in the CMS.
Update
Update(Ektron.Cms.WebEventData)
Updates an existing WebEvent 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 Event ID
- Web Event Title
- Location
- Description
- Start Date Time
- End Date Time
Parameters
eventData.WebEventDataobject to update.
Returns
Returns the WebEventData object updated.
Remarks
Validate the WebEvent item with GetItem() before you update the properties. Then, call Update with your modified WebEventData object.
NOTE: You cannot change all properties after the initial Add event, such as the WebEventData.Type.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxWebEventIDLabel" AssociatedControlID="uxWebEventID" CssClass="span-4 last"
runat="server" Text="* WebEventID :" />
<ektronUI:TextField ID="uxWebEventID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
Text="250" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxWebEventTitleLabel" AssociatedControlID="uxWebEventTitle" CssClass="span-4 last"
runat="server" Text=" WebEvent Title :" />
<ektronUI:TextField ID="uxWebEventTitle" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxLocationLabel" AssociatedControlID="uxLocation" CssClass="span-4 last"
runat="server" Text="Location :" />
<ektronUI:TextField ID="uxLocation" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxWebEventDescriptionLabel" AssociatedControlID="uxWebEventDescription"
CssClass="span-4 last" runat="server" Text="Description :" />
<asp:TextBox TextMode="MultiLine" Rows="3" ID="uxWebEventDescription" CssClass="span-4"
runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxStartDateLabel" AssociatedControlID="uxStartDate" CssClass="span-4 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-4 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>
<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 uxSubmit_Click(object sender, EventArgs e)
{
try
{
WebEventManager webeventManager = new WebEventManager();
String st = uxStartDate.Text + " " + uxStartTime.SelectedItem.Text + ":00:00 " + uxStartPeriod.SelectedItem.Text;
String et = uxEndDate.Text + " " + uxEndTime.SelectedItem.Text + ":00:00 " + uxEndPeriod.SelectedItem.Text;
DateTime startdatetime = DateTime.Parse(st);
DateTime endDatetime = DateTime.Parse(et);
long eventid = Convert.ToInt64(uxWebEventID.Text);
//Check the WebEvent Details
WebEventData WebeventData = webeventManager.GetItem(eventid);
if (WebeventData != null)
{
WebeventData.Title = uxWebEventTitle.Text != string.Empty ? uxWebEventTitle.Text : WebeventData.Title;
WebeventData.Description = uxWebEventDescription.Text != string.Empty ? uxWebEventDescription.Text : WebeventData.Description;
WebeventData.Location = uxLocation.Text != string.Empty ? uxLocation.Text : WebeventData.Location;
if (!string.IsNullOrEmpty(uxStartDate.Text)) { WebeventData.EventStart = startdatetime; }
if (!string.IsNullOrEmpty(uxEndDate.Text)) { WebeventData.EventEnd = endDatetime; }
WebeventData.DisplayTitle = uxWebEventTitle.Text != string.Empty ? uxWebEventTitle.Text : WebeventData.DisplayTitle;
//Update a webEvent with given details.
webeventManager.Update(WebeventData);
MessageUtilities.UpdateMessage(uxMessage, "Web Event Details has been Updated for Web Event ID : " + WebeventData.Id, Message.DisplayModes.Success);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Web Calendar Event ID and Try again.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
Data classes
Data Classes
EventTaxonomyCriteria
EventTaxonomyCriteria
Namespace
Ektron.Cms
Constructors
AddFilter(string, [bool])public Ektron.Cms.EventTaxonomyFilterGroup AddFilter(string taxonomyPath, [bool recursive = false])
AddFilter(long, [bool])public Ektron.Cms.EventTaxonomyFilterGroup AddFilter(long taxonomyId, [bool recursive = false])
AddFilter(Ektron.Cms.Common.EventTaxonomyProperty, Ektron.Cms.Common.CriteriaFilterOperator, object, [bool])public Ektron.Cms.EventTaxonomyFilterGroup AddFilter(Ektron.Cms.Common.EventTaxonomyProperty taxonomyProperty, Ektron.Cms.Common.CriteriaFilterOperator filterOperator, object value, [bool recursive = false])
EventTaxonomyCriteria()public EventTaxonomyCriteria()
EventTaxonomyCriteria(Ektron.Cms.Common.EventProperty, EkEnumeration.OrderByDirection)public EventTaxonomyCriteria(Ektron.Cms.Common.EventProperty orderByField, EkEnumeration.OrderByDirection orderByDirection)
GenerateSql(System.Data.Common.DbCommand, System.Collections.Generic.Dictionary<Ektron.Cms.Common.EventProperty,string>, out string, out string)public override void GenerateSql(System.Data.Common.DbCommand command, System.Collections.Generic.Dictionary<EventProperty,string> columnMap, out string whereClause, out string orderByClause)
-
ToCacheKey()public override string ToCacheKey()
TaxonomyGroupFilterspublic System.Collections.Generic.List<EventTaxonomyFilterGroup> TaxonomyGroupFilters { set; get; }
WebEventCriteria
WebEventCriteria
Namespace
Ektron.Cms.Common
Constructors
WebEventCriteria()public WebEventCriteria()
WebEventCriteria(Ektron.Cms.Common.WebEventProperty, EkEnumeration.OrderByDirection)public WebEventCriteria(Ektron.Cms.Common.WebEventProperty orderByField, EkEnumeration.OrderByDirection orderByDirection)
Accepted fields for the
WebEventPropertyare:- CalendarId
- DateCreated
- DateModified
- Description
- Duration
- EndUtc
- Id
- IsAllDay
- IsCancelled
- IsVariance
- LanguageId
- LastEditorFirstName
- LastEditorLastName
- Location
- ParentEventId
- RecurrenceEndDate
- RecurrenceId
- RecurrenceType
- StartUtc
- Status
- Title
WebEventData
WebEventData
Namespace
Ektron.Cms.Common.Calendar
Properties
CanDelete. Indicates whether the current user has permission to delete the event. It is filled only when loaded fromGetWebEventList.public bool CanDelete { set; get; }CanEdit. Indicates whether the current user has permission to edit the event. It is filled only when loaded fromGetWebEventList.public bool CanEdit { set; get; }Clone(). Returns a clone of the currentWebEventDataobject.public virtual Ektron.Cms.Common.Calendar.WebEventData Clone()
CreateVariance(System.DateTime). Creates a variance event for the current recurring event. Returns an unsavedWebEventrepresenting the event variance.occurrenceStartUtcis the event occurrence date for which to create a variance.public virtual Ektron.Cms.Common.Calendar.WebEventData CreateVariance(System.DateTime occurrenceStartUtc)
CreateVariance(System.DateTime, System.DateTime). Creates a variance event for the current recurring event. Returns an unsavedWebEventrepresenting the event variance.occurrenceStartUtcis the event occurrence date for which to create a variance.newStartUtcis the new occurrence start date (UTC).public virtual Ektron.Cms.Common.Calendar.WebEventData CreateVariance(System.DateTime originalStartUtc, System.DateTime newStartUtc)
CurrentEditor. Filled with the current editor if there is one.public long CurrentEditor { set; get; }CurrentTimeZone. Gets or sets the current timezone for the event. Setting the timezone will alter the value of theEventStartproperty based upon the new timezone's UTC Bias. The underlying UTC value of this event's eventstart property will not change. However, any new values applied toEventStartwill use the new TimeZone when setting the underlyingEventStartUtcvalue.public Ektron.Cms.Common.Calendar.TimeZoneInfo CurrentTimeZone { set; get; }Description. Gets or sets the description of the event.public string Description { set; get; }DisplayTitle. Gets or sets the display title of event. This could be different than the baseContent.Titleif this is a variant of a recurring event. In that case theContent.Titlemay be "Event Name (2)" and theDisplayTitlewould still be "Event Name".public string DisplayTitle { set; get; }Duration. Gets or sets the current duration of the event. Changing this will affect theEventEndtime.public System.TimeSpan Duration { set; get; }EventEnd. Gets and sets the event's end time based upon the current timezone. Setting this value will alterEventEndUTCbased upon the current timezone's UTC bias.public System.DateTime EventEnd { set; get; }EventEndUtc. Gets or sets theEventEndtime of the event in UTC time.public System.DateTime EventEndUtc { set; get; }EventStart. Gets and sets the event's start time based upon the current timezone. Setting this value will alterEventStartUTCbased upon the current timezone's UTC bias.public System.DateTime EventStart { set; get; }EventStartUtc. Gets or sets theEventStarttime of the event in UTC time.public System.DateTime EventStartUtc { set; get; }GetEventStartUtcForOccurrence(System.DateTime). Returns theEventStartUtcfor a specific event occurrence. This method is only applicable to recurring events. TheEventStartUtctime is based upon theEventStartfor originating timezone and may fluctuate. The localEventStartfor the originating timezone will always remain consistent. For example, an 8:00 AM ET is consistent in both standard and daylight time and therefore, the UTC value may change based upon the occurrence date.public System.DateTime GetEventStartUtcForOccurrence(System.DateTime occurrenceDate)
GetEventStartUtcForOccurrence(Ektron.Cms.Common.Calendar.WebEventData, System.DateTime). Returns theEventStartUtcfor event occurrence on the supplied date. This method is only applicable to recurring events. TheEventStartUtctime is based upon theEventStartfor originating timezone and may fluctuate. The localEventStartfor the originating timezone will always remain consistent. For example, an 8:00 AM ET is consistent in both standard and daylight time and therefore, the UTC value may change based upon the occurrence date. Exposing this statically so the logic can be used by recurrence managers without creating instance ofWebEventas they only requireWebEventDataclasses.public static System.DateTime GetEventStartUtcForOccurrence(Ektron.Cms.Common.Calendar.WebEventData eventData, System.DateTime occurrenceDate)
GetOriginalTimeZoneEventStart(). Returns the recurringEventStartin the originating timezone. This time should remain consistent for all occurrences. This method is only applicable to recurring events.public System.DateTime GetOriginalTimeZoneEventStart()
GetOriginalTimeZoneEventStart(Ektron.Cms.Common.Calendar.WebEventData). Returns the recurringEventStartin the originating timezone. This time should remain consistent for all occurrences. This method is only applicable to recurring events. Exposing this statically so the logic can be used by recurrence managers without creating instance ofWebEventas they only requireWebEventDataclasses.public static System.DateTime GetOriginalTimeZoneEventStart(Ektron.Cms.Common.Calendar.WebEventData eventData)
IsAllDay. Gets or sets theIsAllDayflag of the event. A true value means the event is an all day event with no actual start\end.public bool IsAllDay { set; get; }IsCancelled. Gets or sets theIsVarianceflag for the event. A true value means that this event is a cancelled occurrence of a recurring event.public bool IsCancelled { set; get; }IsRecurring. Gets a boolean value indicating if the current event is a recurring event.public bool IsRecurring { get; }IsVariance. Gets or sets theIsVarianceflag for the event. A true value means this event is a variance of an occurrence of a recurring event.public bool IsVariance { set; get; }Location. Gets or sets the location of the event.public string Location { set; get; }OriginalStartUtc. Gets or sets theOriginalStartUtctime. The originalOriginalStartUtcis the UTC time of the original occurrence of a recurring event. It is used to calculate TimeZone adjusted times of event occurrences.public System.DateTime OriginalStartUtc { set; get; }OriginalTimeZone. Gets or sets the original timezone for this eventpublic Ektron.Cms.Common.Calendar.TimeZoneInfo OriginalTimeZone { set; get; }ParentEventId. Gets or sets the recurrence ID of the event. The recurrence ID is the event ID of the original recurring event. This value is needed to tie event variances back to the original recurring event.public long ParentEventId { set; get; }Recurrence. Gets or sets the current recurrence pattern for the event.public Ektron.Cms.Common.RecurrenceData Recurrence { set; get; }UtcOffset. Gets theUtcOffsetof the current timezone.public System.TimeSpan UtcOffset { get; }Validate(). Validates the event object and returns a list of errors.public virtual ValidationResults Validate()
WebEventData()public WebEventData()