Calendar Setup Properties

Calendar Config XML

Use this to control certain display functions of the calendar.

Example:

<CalendarConfig>

<Config>

<ViewType>Year</ViewType>

<EventBarShow>False</EventBarShow>

<Width>50%</Width>

</Config>

</CalendarConfig>

BackColor - String

The background color of the calendar.

BorderColor - String

The color of the calendar border.

BorderStyle - String

The style of the calendar border.

Options:

•    NotSet - The border style is not set

•    None - No border

•    Dotted - A dotted line

•    Dashed - A dashed line

•    Solid - A solid line

•    Double - A solid double line

•    Groove - A grooved border for a sunken border appearance

•    Ridge - A ridged border for a raised border appearance

•    Inset - An inset border for a sunken control appearance

•    Outset - An outset border for a raised control appearance

BorderWidth - String

The width of the calendar border.

CalendarSpanType

Sets the span type of a calendar item when there isn’t enough room to display all the text of the
calendar item.

Options:

•    Multiline – Wrap text

•    Overflowed – Do not wrap text

CellPadding - Integer

The cell padding of the calendar.

CellSpacing - Integer

The cell spacing of the calendar.

DayEndHour - Integer

The end hour of the work day.

DayStartHour - Integer

The start hour of the work day.

DrillDownEnabled - Boolean

When enabled, allows drill-down from Year to Month to Day.

EventBarEmptyColor - String

The color of the Event Bar when empty.

EventBarFilledColor - String

The color of the event time within the Event Bar.

EventBarShow - Boolean

When enabled, displays the Event Bar above each Calendar Item.

FirstDayOfWeek - String

First day of the week displayed within Work Week view.

Options:

•    Sunday

•    Monday

•    Tuesday

•    Wednesday

•    Thursday

•    Friday

•    Saturday

FontBold - Boolean

When enabled, displays the calendar items in bold.

FontItalics - Boolean

When enabled, displays the calendar items in italics.

FontName - String

Sets the name of the font used within a calendar item. This comes from the font names in
Windows Server 2003.

FontOverline - Boolean

When enabled, places a line above a calendar item.

FontSize - Integer

Sets the size of the font used within a calendar item.

FontStrikeout - Boolean

When enabled, places a line through a calendar item.

FontUnderline - Boolean

When enabled, places a line beneath a calendar item.

ForeColor - String

Sets the font color.

Height - String

The height of the calendar in either pixels or percentage. If the value is measured as a percentage, place a % symbol after the value (e.g., 50%). If the value is measures in pixels, simply specify the value (e.g., 50).

ItemHeight - Integer

The maximum height of each calendar item, including line wraps.

MaxDisplayedItems – Integer

The maximum number items displayed within the Month and Year view for each day or month.

MergeEvents - Boolean

When enabled, merges events with the same Title, Start Date, and End Date.

MinutesInterval - Integer

The interval of minutes used within a Week and Day view. This must be multiple of 60. The default is 30 and will show 2 tick marks.

MonthStartDate - DateTime

Sets the start date shown in a Month view.

MoreItemsText - String

Text used to denote that there are more items beyond the maximum displayed in a Year and Month
view.

SelectedDate - DateTime

Sets the highlighted date.

TaskItemWidth - Integer

The width of a task item displayed within the Task view.

TimescaleTopSpan - String

Controls the interval of days displayed within the Task view.

Options:

•    Month – Show interval of days by Month

•    Week – Show interval of days by Week

UseShadows - Boolean

When enabled, shows a shadow for each calendar item.

ViewType - String

The default view type shown when users view the calendar.

Options:

•    YearView - Indicates year view

•    MonthView - Indicates month view

•    WeekView - Indicates week view, vertical format

•    WorkWeekView - Indicates work week view, vertical format

•    WeekView2 - Indicates week view, two columns format

•    DayView - Indicates day view

•    TaskView - Indicates task view

WeekDayHeight - Integer

Sets the height in pixels of the weekday cell used in a Work Week view.

WeeksInMonth - Integer

Sets the amount of weeks displayed within each month.

Width - String

Controls the width in pixels and percentage of the Calendar. If the value is measured as a percentage, place a % symbol after the value (e.g., 50%). If the value is measures in pixels, simply specify the value (e.g., 50).

YearStartMonth - Integer

Sets the starting month displayed within a Year view.

Back to Top


Data Config XML

Controls the field mapping of required fields to data coming from the external XML source.

Example:

<DataConfig>

<Data>

<DataTextField>Title</DataTextField>

<DataStartDateField>Start Time</DataStartDateField>

<DataEndDateField>End Time</DataEndDateField>

<DataColorField>Color</DataColorField>

<DataDescriptionField>Description</DataDescriptionField>

<DataLinkField>URL</DataLinkField>

<DataRecurrenceField>Recurrence</DataRecurrenceField>

</Data>

</DataConfig>

DataColorField (Optional)

The name of the column used to represent a calendar item in a specific color.

DataDescriptionField (Optional)

The name of the column used to display a description for a calendar item. This is only presented when a user hovers over the calendar item.

DataEndDateField (Required)

The name of the column used as the End Date for a calendar item.

DataLinkField (Optional)

The name of the column used to link a calendar item.

DataRecurrenceField (Optional – For SharePoint Events Only)

The name of the SharePoint Event list column that manages the recurrence. The XML from this column will be parsed, and recurring events will be created and displayed within the calendar using the previous elements.

DataStartDateField (Required)

The name of the column used as the Start Date for a calendar item.

DataTextField (Required)

The name of the column used to display a calendar item.

Back to Top

 

Recurrence Maximum Start Date

When a SharePoint Event List Recurring item is collected and rendered, the calendar items for the recurring item will only go back as far as the amount of days entered in the property. This removes unneeded recurring events displayed in the past, increasing page performance.

Default: -180

Back to Top