Click here to Skip to main content
Click here to Skip to main content

Calendar Planner

, 6 May 2013 CPOL
Rate this:
Please Sign up or sign in to vote.
A control similar to the Outlook Calendar control.

WeekPlanner/Calendar.png

Introduction 

During my job I was in need of a .NET WinForms control which would allow to fetch data from the database and manipulate it like in Outlook Calendar Planner (add, delete, drag items), but with a few differences. Instead of showing the time information in the left side of the control, it was necessary to retrieve and show columnar data from the database. I found some similar controls: A Professional Calendar/Agenda View That You Will Use, Calendar DayView Control, and Day, Week, and Month Calendar Controls, but none of them met my requirements. For commercial components, I didn't want to pay. So I created my own Calendar Planner.

Control Features

The control consists of rows with items and columns in the left side, as you can see from the screenshot below.

WeekPlanner/CalendarRow.png

Each item in a row can be updated individually. You can change the background color, specify text, drag it, change date, etc. In the left side of the calendar you can add columns with some text, it may be used in order to retrieve data from different data sources (for example, from DB or XML file). The component can show date intervals in two modes: daily and weekly. In daily mode, each date shows day name, as in the screenshot above. In weekly mode, the date shows the week number, as in the screenshot below. Control supports rows nesting. For this you can set a row as collapsible. 

WeekPlanner/CalendarRow2.png

Background

In order to manage the behaviour of the control, you can use different properties. Some of them are:

  • CurrentDate: gets/sets calendar date.
  • DatesIntervalMode: possible modes to show date intervals in the header.
  • DayCount: day count to show by the calendar.
  • GridCellHeight: height of each row.
  • HeaderStylemode: possible modes to fill background header.
  • IsAllowedDraggingBetweenRows: allows/disallows item drag/drop between rows.
  • ItemHeight: height of each item.
  • LeftMargin: margin of left column.
  • SelectedRowindex: gets the index of the selected row.
  • SelectedItem: gets the selected item.
  • Rows: list of rows of the calendar.
  • Items: list of items of the row. 
  • Columns: columns in the left side of the control.
  • IsAllowedTreeViewDrawing: Enables\Disables lines drawing like in tree view 

Events:

  • ItemClick: occurs when an item is clicked.
  • ItemDoubleClick: occurs when an item is double-clicked.
  • RowClick: occurs when a row is clicked.
  • RowDoubleClick: occurs when a row is double-clicked.
  • ItemDatesChanged: occurs when an item date range has changed.
  • ItemTextEdited: occurs when an item text is edited.

Using the code

The control doesn't support data binding, so you must write your own logic for rows with items saving and fetching.

Each row of the control, this is the class WeekPlannerRow with different properties (such as BackColor, Name, and others). The calendar consists of a list of rows in the class WeekPlannerRowCollection: List<WeekPlannerRow>.

In turn each row contains a list of items WeekPlannerItemCollection:List<WeekPlannerItem>. An item is the class WeekPlannerItem with some properties: StartDate, EndDate, Subject, BackColor, and others.

Also, each row has columns, and all related methods can be found in the DataColumns class. This class contains an array of classes DataValue with properties like: Name (name of column), Width (width of column), and Text (text for column header). Also, the DataValue class has a list ValueColorCollection : List<weekplanneritem>. The purpose of the ValueColor<weekplanneritem> class is to show text information in a column in different colors.

In order to add columns, you can use this code:

weekPlanner1.Columns.Add("ColumnName1", string.Empty, 150);
weekPlanner1.Columns.Add("ColumnName2", string.Empty, 150);
// 150 is the width of column

Rows adding happens this way:

// creates new instance of the List of Items, which will be added to the row
var itemCollection = new WeekPlannerItemCollection(); 
// creates new instance of item, which will be added to the row's items list
var item = new WeekPlannerItem(); 
item.StartDate = DateTime.Now.AddDays(0); 
item.EndDate = DateTime.Now.AddDays(0); 
item.Subject = "1 date"; 
item.BackColor = Color.YellowGreen; 
// adds item to the list
itemCollection.Add(item); 
// creates new instance of the columns, which will be added to the row
var ColumnRows = new DataColumns(weekPlanner1.Calendar); 
// adds random text to the column ColumnName1,
// which was created in the code snippet above
ColumnRows["ColumnName1"].Data.Add(Guid.NewGuid().ToString().Substring(0, 8)); 
// adds another random text to the column ColumnName1 
ColumnRows["ColumnName1"].Data.Add(Guid.NewGuid().ToString().Substring(0, 8)); 
// adds random text to the column ColumnName2
ColumnRows["ColumnName2"].Data.Add(Guid.NewGuid().ToString().Substring(0, 8)); 
// adds row to the calendar
weekPlanner1.Rows.Add(ColumnRows, itemCollection);

Here is the code for items adding:

// gets calendar rows collection
var rows = weekPlanner1.Rows; 
// finds selected row by index
var row = rows.ElementAt(weekPlanner1.SelectedRowIndex); 
// creates new instance of item, which will
// be added to the row's items list
var item = new WeekPlannerItem(); 
item.StartDate = DateTime.Now.AddDays(0); 
item.EndDate = DateTime.Now.AddDays(0); 
item.Subject = "Example"; 
item.BackColor = Color.YellowGreen; 
// adds item to the row
row.Items.Add(item);

History

  • 09.08.2011
    • Initial release.
  • 20.08.2011
    • Added new events OnItemDatesChanged, OnItemTextEdited.
  • 04.09.2011
    • Added new events OnItemMouseHover, OnItemMouseLeave.
  • 11.10.2011
    • Now each row increases its height individually.  
  • 24.04.2013
    • Added new property IsAllowedTreeViewDrawing, event OnRowLeftColumnClick.  
    • Added new row properties IsVisibleIsExpandedAncestorNameIsCollapsible.   

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Yury Yuhno
Software Developer Axon Cable
Latvia Latvia
No Biography provided

Comments and Discussions

 
QuestionMake some item unmovable/unclickable PinmemberYAllTaken4-Jun-14 22:37 
QuestionMonth View? PinmemberRRJP20-Nov-13 21:18 
AnswerRe: Month View? PinmemberRRJP20-Nov-13 22:57 
QuestionBackground Color of individual Cells PinmemberMember 101956688-Oct-13 5:26 
QuestionNICE WORK!! PinmemberPaulo Lima2-Oct-13 8:36 
Questionload from DB Pinmembertony5551-Oct-13 5:02 
Questionover lapping Pinmembertony5551-Oct-13 2:55 
QuestionHow retrieve column inside text? PinmemberAlb7525-Jul-13 4:00 
AnswerRe: How retrieve column inside text? [modified] PinmemberRajibXYZ7-Nov-13 20:22 
Questiondragging items PinmemberYAllTaken24-Jun-13 0:58 
AnswerRe: dragging items PinmemberYury Yuhno25-Jun-13 19:22 
GeneralRe: dragging items [modified] PinmemberYAllTaken26-Jun-13 1:45 
GeneralRe: dragging items PinmemberYury Yuhno26-Jun-13 22:41 
QuestionNice Work PinmemberMember 1010526016-Jun-13 22:21 
AnswerRe: Nice Work PinmemberMember 1010526019-Jun-13 2:59 
AnswerRe: Nice Work PinmemberYury Yuhno26-Jun-13 0:22 
GeneralSuper work Pinmembergoms3rd8-May-13 0:09 
GeneralMy vote of 5 PinmemberFernandoUY7-May-13 3:48 
GeneralMy vote of 5 PinmemberRenju Vinod29-Apr-13 2:05 
GeneralMy vote of 5 PinmemberDaniel Cruz25-Apr-13 9:02 
GeneralMy vote of 5 PinmemberSudhakar Shinde24-Apr-13 0:59 
Questionweekends in different color PinmembertheBartman6927-Mar-13 22:25 
SuggestionRe: weekends in different color Pinmembertanguy humblot29-Aug-13 2:59 
QuestionVery nice control PinmemberMember 831661425-Feb-13 1:59 
Question10 minute division Pinmemberpedro_portway14-Oct-12 7:57 
GeneralMy vote of 5 PinmemberIan A Stewart4-Sep-12 8:08 
QuestionToolTip into weekplanneritem Pinmembertacho4-Sep-12 6:14 
AnswerRe: ToolTip into weekplanneritem PinmemberYAllTaken29-Jul-13 1:13 
AnswerRe: ToolTip into weekplanneritem PinmemberRajibXYZ1-Nov-13 2:01 
QuestionHelp please : Calendar language ?? PinmemberEL HANI Abdelatif15-May-12 11:38 
SuggestionRe: Help please : Calendar language ?? PinmemberAlain BOURLAND17-Jul-12 2:32 
GeneralRe: Help please : Calendar language ?? PinmemberEL HANI Abdelatif21-Dec-12 11:43 
QuestionVery Nice Pinmembervictorbos18-Oct-11 2:52 
GeneralRe: Very Nice PinmemberYury Yuhno18-Oct-11 20:53 
Thanks. I'm happy that you like it.
GeneralMy vote of 4 PinmemberSledgeHammer0114-Oct-11 11:39 
QuestionVB Net? Pinmemberisensa7-Oct-11 9:56 
AnswerRe: VB Net? PinmemberDavidSullivan12-Oct-11 8:39 
GeneralMy vote of 5 PinmemberJanvdK20-Sep-11 8:19 
GeneralMy vote of 4 PinmemberMember 191236720-Sep-11 4:42 
QuestionSupport for Minutes or Hours? PinmemberRheedHamilton19-Sep-11 14:35 
AnswerRe: Support for Minutes or Hours? PinmemberMember 1010526016-Jun-13 22:32 
GeneralRe: Support for Minutes or Hours? Pinmemberjibola11-Oct-13 2:31 
QuestionNice Article! PinmemberMember 45586616-Sep-11 9:48 
AnswerRe: Nice Article! Pinmemberknoami18-Oct-11 23:19 
QuestionNice Article! PinmemberMember 45586616-Sep-11 9:47 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web04 | 2.8.141015.1 | Last Updated 6 May 2013
Article Copyright 2011 by Yury Yuhno
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid