wx.Calendar Class Reference

List of all members.

Public Member Functions

void AddHoliday (DateTime day, CalendarPeriod period, string name)
void AddHoliday (DateTime day, CalendarPeriod period)
void AddHoliday (DateTime day)
void AddHoliday (DateTime day, string name)
void AddSpecialDay (DateTime day, CalendarPeriod period, CalendarDateAttr attr, string name)
void AddSpecialDay (DateTime day, CalendarPeriod period, CalendarDateAttr attr)
void AddSpecialDay (DateTime day, CalendarDateAttr attr, string name)
void AddSpecialDay (DateTime day, CalendarDateAttr attr)
 Calendar ()
delegate void RequestFormatEventHandler (object sender, RequestFormatEventArgs args)

Static Public Member Functions

static
System.Collections.Generic.IList
< DateTime > 
DaysInPeriod (DateTime reference, CalendarPeriod repeat, DateTime periodStart, DateTime periodEnd)

Public Attributes

event
RequestFormatEventHandler 
OnRequestFormat

Classes

struct  DescrPeriodicalDay
struct  FormatDescr
class  RequestFormatEventArgs


Detailed Description

Assigns name and attributes to special days. These will be displayed in calendar controls if set to the appropriate property.

Add styles to the calendar and asign them to days.

You may either extend this by subclassing or providing event handlers.


Constructor & Destructor Documentation

wx.Calendar.Calendar (  ) 

Creates an empty calendar info. You may assign this to a calendar control.


Member Function Documentation

void wx.Calendar.AddHoliday ( DateTime  day,
CalendarPeriod  period,
string  name 
)

Defines day to be a holiday of the provided name that will automatically be repeated periodically.

void wx.Calendar.AddHoliday ( DateTime  day,
CalendarPeriod  period 
)

Defines day to be a holiday that will automatically be repeated periodically.

void wx.Calendar.AddHoliday ( DateTime  day  ) 

Defines day to be a holiday.

void wx.Calendar.AddHoliday ( DateTime  day,
string  name 
)

Defines day to be a holiday of the provided name.

void wx.Calendar.AddSpecialDay ( DateTime  day,
CalendarPeriod  period,
CalendarDateAttr  attr,
string  name 
)

void wx.Calendar.AddSpecialDay ( DateTime  day,
CalendarPeriod  period,
CalendarDateAttr  attr 
)

void wx.Calendar.AddSpecialDay ( DateTime  day,
CalendarDateAttr  attr,
string  name 
)

void wx.Calendar.AddSpecialDay ( DateTime  day,
CalendarDateAttr  attr 
)

static System.Collections.Generic.IList<DateTime> wx.Calendar.DaysInPeriod ( DateTime  reference,
CalendarPeriod  repeat,
DateTime  periodStart,
DateTime  periodEnd 
) [static]

This returns a list of days with a distance referring to repreat to day \ reference within a period of days. Example 1: Reference 1st of July 2008 and repeat CalendarPeriod.Monthly within the period starting with the 2nd May 2008 ranging to the 2nd Aug. 2008 will return the following DateTime instances: 1st of June, 1st of July, 1st of August.

Example 2: The parameters from example 1 but with reference 1st of Jan. 2008 will result into the same result.

Example 3: The parameters from example 1 but with period 2nd of July to 31th of July will result into an empty list.

delegate void wx.Calendar.RequestFormatEventHandler ( object  sender,
RequestFormatEventArgs  args 
)


Member Data Documentation

event RequestFormatEventHandler wx.Calendar.OnRequestFormat

Called on requesting the format of a particular day.


Manual of the wx.NET   (c) 2003-2011 the wx.NET project at   Get wx.NET at SourceForge.net. Fast, secure and Free Open Source software downloads