Events Module

Events Module

Setting up the calendar

Starting on July 16, 2018 new prices systems are now in effect for the Google Maps Platform. This is only in affect if you are using the GeoCodes attribute in this module. Please see the User Guide and view this option's billing here.

  1. Linking To link to the calendar month view you must use a query string variable. The link looks like this: /AudienceSystemName/NavigationItemSystemName.aspx?calendar=y
  2. Module Designer There is a new tab in Site Architecture > Module Designer > Events called Calendar Month View. This is where you control the design of the calendar view.
  3. Attribute Definitions
    • Header Content The html that will show up above the calendar.
    • Event Item Content Here you can use cp:scripting to build and display any information from the relation. Each event’s data will show up in its own DIV. In order to make the event titles link to their details view, you must build the link yourself. Here is an example: /Main/Events/[cp:scripting key='Column' name='AutoNumber' format='' /].aspx. The CSS for the div that holds the event data and its title link is handled in the attribute called "Event Title CSS". The default is “<a href="#">[cp:scripting key='Column' name='Title' format='' /]</a>”
    • Link to Day View This will link the calendar's date to the List View for a single day of events.
    • Display Top Events This will filter the top events by in a single day.
    • Record Filter This is the number of events to show in a single day.
    • Calendar See More Link This will show a linkk to the List View for a single day of events if there is more events than the Record Filter displays.
    • See More Link Text This is the text for the See More Link. It defaults to See More..
    • Grid Color A color picker that will set the color of the calendar grid lines. The default is black.
    • Title Bar CSS This is where you control the CSS class for the bar where the month navigation and month name is.
    • Event Title CSS Here is where you control the div and its child controls (links) for the event data. So there is no need to add a class definition to the Event Item Content html.
    • Event Day Cell CSS For the days that have events on them, you may control the look of the cell that holds the title.
    • Day Header CSS The class definition for the cells that hold the day names.
    • Day Cell CSS This class definition controls all the day cells that do not have an event or is not the current day.
    • Today’s Day Cell CSS This class definition controls the current day’s cell.
    • Calendar Date Number CSS This class definition controls the date numbers.
    • Previous Navigation Type This is an attribute switch that will allow you to choose between an image or text for the month navigation.
    • Next Navigation Type This is an attribute switch that will allow you to choose between an image or text for the month navigation.
    • Footer Content The html that will display under the calendar.
  4. CSS classes for Calendar
    • Day Class cpsty_CalendarDayCell
    • Day Header Class cpsty_CalendarDayHeader
    • Today Day Class cpsty_CalendarTodaysDayCell
    • Title Class cpsty_CalendarTitleBar
    • Other Month Day Class cpsty_CalendarOtherMonth
    • Weekend Day Class cpsty_CalendarWeekendDayStyle
    • Day Class cpsty_CalendarDayStyle
    • Date Number Class cpsty_CalendarDateNumber


CalendarDate This databind method displays the Calendar date.

[cp:literal:databind key='CalendarDate("m")' /]
Property Description
Key The term which will have its alias displayed if it exists, otherwise the term itself will be displayed.
format The date formats. For valid formats please Click here


DateSelector This cpcontrol populates the dropdown with dates based on passed values for pastMonths and futureMonths attributes.

[cp:control key='DateSelector' cpsys_src='/Modules/Events/Common/Calendar/DateSelector.ascx' pastMonths='58' futureMonths='49' format='{0:y}' /]
Property Description
Key The term which will have its alias displayed if it exists, otherwise the term itself will be displayed.
pastMonths An integer value to calculate starting date. It calculates the starting date based on current date. Its default value is set to 12. Eg. If current date is 11/2011 and if this attribute is set to 12 then starting date will start from 11/2010.
futureMonths An integer value to calculate end date. It calculates the end date based on current date. Its default value is set to 12. Eg. If current date is 11/2011 and if this attribute is set to 26 then end date will be 01/2014.
format The format for date. The syntax for this should be : {0:format} eg: {0:y}. For formats please click here
pleaseSelectText The text to set text for Please Select. The 'Please Select...' text is set as it's default.


TaxonomySelector This cpcontrol populates the dropdown with taxonomies for passed parentTaxonomyId.

[cp:control key='TaxonomySelector' cpsys_src='/Modules/Events/Common/Calendar/TaxonomySelector.ascx' parentTaxonomyId='' futureMonths='49' pleaseSelectText='' /]
Property Description
Key The term which will have its alias displayed if it exists, otherwise the term itself will be displayed.
parentTaxonomyId A guid value for Parent Taxonomy Id. It takes the Root taxonomy id if it is left empty.
pleaseSelectText The text to set text for Please Select. The 'Please Select...' text is set as it's default.
showSubCategories This will create a children Taxonomy dropdown. It's values are true or false. It is set to false by default.
subCategoriesPleaseSelectText The text to set text for Please Select for the children Taxonomy dropdown. The 'Please Select...' text is set as it's default.


ViewSelector This cpcontrol populates with List and Grid options to display the Events. This control can be used in Header Content of any Calendar View as per requirement.

[cp:control key='ViewSelector' cpsys_src='/Modules/Events/Common/Calendar/ViewSelector.ascx' pleaseSelectText='' /]
Property Description
Key The term which will have its alias displayed if it exists, otherwise the term itself will be displayed.
pleaseSelectText The text to set text for Please Select. The 'Please Select...' text is set as it's default.

Setting up the Calendar List View

  1. Linking To link to the calendar list view you must use a query string variable. The link looks like this: /AudienceSystemName/NavigationItemSystemName.aspx?list=y There is also an option for a Day List View. The link looks like this: AudienceSystemName/NavigationItemSystemName.aspx?list=day&date=MM-dd-yyyy if the date is left empty it will show the current day.
  2. Module Designer There is a new tab in Site Architecture > Module Designer > Events called Calendar List View. This is where you control the design of the calendar view.
  3. Attribute Definitions
    • Css Class The css classes for calendar list view contents. You can write css classes for list view contents.
    • Header Content The html that will show up above the calendar list view. Here you can use calendar cpcontrols like DateSelector, TaxonomySelector and View Selector. To display the selected date in header, the databind 'DisplaySelectedDate(string dateFormat)' can be used. The databind WeekView(string text) and MonthView(string text) can be used here to switch to week and month view respectively.
    • Day Header Content Here you can use cp:scripting to build and display any information from the relation. This will be displayed as header for each event in the list. For example : [cp:scripting key='Column' name='EventStartDate' dataType='datetime' format='{0:MMM d, yyyy}' /] This will display Event start date of each event as its header.
    • Item Content Here you can use cp:scripting to build and display any information from the relation. In order to make the event titles link to their details view, you must build the link yourself. Here is an example: /Main/Events/[cp:scripting key='Column' name='AutoNumber' format='' /].aspx. To show the body copy of event, you can use databind 'ViewDetails(object dataItem, String text, string cssClassVDLink)', this will display content of each event with View Details link to link to Details view of Event.
    • Footer Content The html that will display under the calendar list view.


DisplaySelectedDate This databind works in Header Content of CalendarListView tab for Events Module. This dipslays the Selected date from DateSelector in List View if date is selected from DateSelector control otherwise displays the Current month date.

[cp:literal:databind key='DisplaySelectedDate(Container.DataItem,"MMMM yyyy")' /]
Property Description
Key The term which will have its alias displayed if it exists, otherwise the term itself will be displayed.
dataItem The current DataItem.
dateFormat The date formats. No need to pass 0, just pass the format as string. For example: DisplaySelectedDate("d"). The default value is "y". For valid formats please Click here


ViewDetails This databind works in Item Content of CalendarListView tab for Events Module. This dipslays the content of each event with View Event Details link if content length is more than 256 characters. This link points to the Details View of the event.

[cp:literal:databind key='ViewDetails(Container.DataItem,"View Event Details","CssClassNameForLink")' /]
Property Description
Key The term which will have its alias displayed if it exists, otherwise the term itself will be displayed.
dataItem The current DataItem.
text The text(label) for View Event Details link. The default value is 'View Event Details'.
cssClass The name of css class which will be applied to View Event Details link.

Setting up the Calendar Week View

  1. Linking To link to the calendar week view you must use a query string variable. The link looks like this: /AudienceSystemName/NavigationItemSystemName.aspx?week=y
  2. Module Designer There is a new tab in Site Architecture > Module Designer > Events called Calendar Week View. This is where you control the design of the calendar week view.
  3. Attribute Definitions
    • Css Class The css classes for calendar week view contents. You can write css classes for week view contents.
    • Header Content The html that will show up above the calendar week view. Here you can use cp:scripting to build and display any information from the relation. Here you can use calendar cpcontrol like TaxonomySelector to filter the content. To display the date for current week in header, the databind 'DisplayCurrentWeek(string dateFormat)' can be used. To navigate through previous and next week, the datbind 'Next(string textForLink)' and databind 'Previous(string textForLink)' can be used. The databind MonthView(string text) and ListView(string text) can be used to switch to Month and List View respectively.
    • Item Content Here you can use cp:scripting to build and display any information from the relation. In order to make the event titles link to their details view, you must build the link yourself. Here is an example: /Main/Events/[cp:scripting key='Column' name='AutoNumber' format='' /].aspx. The content can be alingned using tables or Divs.
    • Footer Content The html that will display under the calendar week view.


DisplayCurrentWeek This databind works in Header Content of CalendarWeekView tab for Events Module. This dipslays the date for Current week.

[cp:literal:databind key='DisplayCurrentWeek("dateFormat")' /]
Property Description
Key The term which will have its alias displayed if it exists, otherwise the term itself will be displayed.
dateFormat The date formats. The default format is {0:D}. Need to use format {0:dateformat}. For valid formats please Click here


DisplayDayInCurrentWeek This databind works in Header Content of CalendarWeekView tab for Events Module. This will display the date for Current week, adding or subracting days to the first day of the week.

[cp:literal:databind key='DisplayDayInCurrentWeek("daysToAdd", "dateFormat")' /]
Property Description
Key The term which will have its alias displayed if it exists, otherwise the term itself will be displayed.
daysToAdd This will add or subtract days to show the date. This will offset from the first day of the week. So to show the week end, use 6. It can be a positive or negative number.
dateFormat The date formats. The default format is {0:D}. Need to use format {0:dateformat}. For valid formats please Click here


NextWeek This databind works in Header Content of CalendarWeekView tab for Events Module. This dipslays the link to navigate to Next week events.
[cp:literal:databind key='NextWeek("Next")' /]
Property Description
Key The term which will have its alias displayed if it exists, otherwise the term itself will be displayed.
text The text for Next week. The defualt value is "Next Week".


PreviousWeek This databind works in Header Content of CalendarWeekView tab for Events Module. This dipslays the link to navigate to previous week events.

[cp:literal:databind key='PreviousWeek("Previous")' /]
Property Description
Key The term which will have its alias displayed if it exists, otherwise the term itself will be displayed.
text The text for Previous week. The defualt value is "Prev Week".


WeekView This databind displays a link to switch to Calendar Week View. This can be used in Header Content of any Calendar View.

[cp:literal:databind key='Centralpoint.WebSite.Modules.Events.Calendar.WeekView("Week")' /]
Property Description
Key The term which will have its alias displayed if it exists, otherwise the term itself will be displayed.
text The text for Week view link. The defualt value is "Week".


ListView This databind displays a link to switch to Calendar List View. This can be used in Header Content of any Calendar View.

[cp:literal:databind key='Centralpoint.WebSite.Modules.Events.Calendar.ListView("List")' /]
Property Description
Key The term which will have its alias displayed if it exists, otherwise the term itself will be displayed.
text The text for List view link. The defualt value is "List".


MonthView This databind displays a link to switch to Calendar Month View. This can be used in Header Content of any Calendar View.

[cp:literal:databind key='Centralpoint.WebSite.Modules.Events.Calendar.MonthView("Month")' /]
Property Description