| KaxCalendar Class |
KaxCalendar class
Inheritance Hierarchy
SystemObject
System.Web.UIControl
System.Web.UI.WebControlsWebControl
KaxWebControl
Kettic.AspNet.Controls.Calendar.PersistencePropertiesControl
Kettic.AspNet.ControlsKaxCalendar
System.Web.UIControl
System.Web.UI.WebControlsWebControl
KaxWebControl
Kettic.AspNet.Controls.Calendar.PersistencePropertiesControl
Kettic.AspNet.ControlsKaxCalendar
Namespace: Kettic.AspNet.Controls
Assembly: Kettic.AspNet.Controls (in Kettic.AspNet.Controls.dll) Version: 2014.4.1129.0 (2014.04.1129.0)
SyntaxThe KaxCalendar type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | KaxCalendar |
Methods| Name | Description | |
|---|---|---|
| FindControl |
When using templates, their content is instantiated and "lives" inside the
Controls
collection of KaxCalendar class. To access the controls instantiated from the
templates they must be found using this method (KaxCalendar implements
INamingContainer interface).
(Overrides ControlFindControl(String).) |
| RenderBeginTag | (Overrides KaxWebControl.RenderBeginTag(HtmlTextWriter).) |
| RenderEndTag | (Overrides KaxWebControl.RenderEndTag(HtmlTextWriter).) |
| ResetTemplates | This method supports the Kettic KaxCalendar infrastructure and is not intended to be used directly from your code. |
Properties| Name | Description | |
|---|---|---|
 | AutoPostBack |
Gets or sets a value indicating whether a postback to the server automatically occurs when the user interacts with the control.
|
| Calendar |
Gets the default System.Globalization.Calendar instance as
specified by the default culture.
|
| CalendarDayTemplates |
Gets or sets a collection of type
CalendarDayTemplateCollection which stores the created templates to use with
KaxCalendar. All of the
items are represented by
DayTemplate
instances.
|
| CalendarSummary |
Gets or sets a value for KaxCalendar summary.
|
| CalendarTableStyle |
Gets the style properties for the Calendar table container.
|
| CalendarView | Exposes the top instance of CalendarView or its derived types. Every CalendarView class handles the real calculation and rendering of KaxCalendar's calendric information. The CalendarView has the ChildViews collection which contains all the sub views in case of multi view setup. |
| CellAlign | Gets or sets the horizontal alignment of the date cells content inside the calendar area. The HorizontalAlign enumeration is defined in System.Web.UI.WebControls |
| CellDayFormat |
Gets or sets the format string that will be applied to the dates presented in the
calendar area.
|
| CellVAlign | Gets or sets the vertical alignment of the date cells content inside the calendar area. The VerticalAlign enumeration is defined in System.Web.UI.WebControls |
| ClientEvents |
Gets the instance of
CalendarClientEvents class which defines the JavaScript functions (client-side
event handlers) that are invoked when specific client-side events are raised.
|
| ColumnHeaderImage |
Gets or sets the image displayed for the column header element.
|
| ColumnHeaderText |
Gets or sets the text displayed for the column header element.
|
| CssClass |
Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server
control on the client.
(Overrides KaxWebControl.CssClass.) |
| CssFile |
Gets or sets the name of the file containing the CSS definition used by KaxCalendar. Use "~/" (tilde) as a substitution of the web-application root directory.
|
| CultureInfo | Gets or sets the CultureInfo instance that represents information about the culture of this KaxCalendar object. A CultureInfo class describes information about the culture of this KaxCalendar instance including the names of the culture, the writing system, and the calendar used, as well as access to culture-specific objects that provide methods for common operations, such as formatting dates and sorting strings. |
| CustomDays |
A collection of custom days in the calendar to which may be applied specific formatting.
|
| DateRangeSeparator |
Gets or sets the separator string that will be put between start and end months in a multi view title.
|
| DateTimeFormat |
Gets or sets a DateTimeFormatInfo instance that defines the
culturally appropriate format of displaying dates and times as specified by the default
culture.
|
| DayCellToolTipFormat | Gets or sets the format string that is applied to the days cells tooltip. |
| DayNameFormat |
Specifies the display formats for the days of the week used as selectors by
KaxCalendar.
|
| DayOverStyle |
Gets the style properties applied when hovering over the Calendar days.
|
| DayStyle |
Gets the style properties for the days in the displayed month.
|
| DefaultCellPadding |
Gets or sets the cell padding of the table where are rendered the calendar days.
|
| DefaultCellSpacing |
Gets or sets the cell spacing of the table where are rendered the calendar days.
|
| DisabledDayStyle |
Gets the style properties for the disabled dates.
|
| EnableKeyboardNavigation |
Gets or sets the enable client side navigation with arrow keys.
|
| EnableMonthYearFastNavigation |
Gets or sets whether the month/year fast navigation controls in the title section will be
enabled.
|
| EnableMultiSelect |
Allows the selection of multiple dates. If not set, only a single date is selected, and if any dates
are all ready selected, they are cleared.
|
| EnableNavigation |
Gets or sets whether the navigation controls in the title section will be
displayed.
|
| EnableNavigationAnimation |
Enables the animation shown when the calendar navigates to a different view.
|
| EnableRepeatableDaysOnClient |
Gets or sets whether the repeatable days logic should be supported on the client
(effective for client calendar - with set property
AutoPostBack="false").
|
| EnableViewSelector |
Gets or sets whether a selector for the entire CalendarView (
MonthView ) will appear on the calendar.
|
| FastNavigationNextImage |
Gets or sets the name of the image that is displayed for the next month fast
navigation control.
|
| FastNavigationNextText |
Gets or sets the text displayed for the fast navigation next month control. Will be
applied if there is no image set (see
FastNavigationNextImage).
|
| FastNavigationNextToolTip |
Gets or sets the text displayed as a tooltip for the fast navigation next month
control.
|
| FastNavigationPrevImage |
Gets or sets the name of the image that is displayed for the previous month fast
navigation control.
|
| FastNavigationPrevText |
Gets or sets the text displayed for the fast navigation previous month control.
Will be applied if there is no image set (see
FastNavigationPrevImage).
|
| FastNavigationPrevToolTip |
Gets or sets the text displayed as a tooltip for the fast navigation previous
month control.
|
| FastNavigationSettings |
Gets or sets the
MonthYearFastNavigationSettings
object whose inner properties can be used to modify the fast Month/Year client
navigation settings.
|
| FastNavigationStep |
Gets or sets an integer value representing the number of
CalendarView
views that will be scrolled when the user clicks on a fast navigation link.
|
| FastNavigationStyle | Gets the style properties for the Month/Year fast navigation. |
| FirstDayOfWeek | Specifies the day to display as the first day of the week on the KaxCalendar control. The FirstDayOfWeek enumeration can be found in System.Web.UI.WebControls Namespace. |
| FocusedDate |
Gets or sets the value that is used by
KaxCalendar to determine
the viewable area displayed .
|
| FocusedDateColumn | Obsolete.
Gets or sets the column index where the
FocusedDate
(and the month view it belongs to) will be positioned inside a multi view area.
|
| FocusedDateRow | Obsolete.
Gets or sets the row index where the
FocusedDate
(and the month view it belongs to) will be positioned inside a multi view area.
|
| FooterTemplate |
Gets or sets the System.Web.UI.ITemplate that defines how the
footer section of the KaxCalendar control is displayed.
|
| HeaderStyle |
Gets the style properties for the row and column headers.
|
| HeaderTemplate |
Gets or sets the System.Web.UI.ITemplate that defines how the
header section of the KaxCalendar control is displayed.
|
| ImagesPath | Gets or sets default path for the grid images when EnableEmbeddedSkins is set to false. |
| MonthLayout | Gets or sets the predefined pairs of rows and columns, so that the product of the two values is exactly 42, which guarantees valid calendar layout. It is applied on a single view level to every MonthView instance in the calendar. |
| MultiViewColumns |
Gets or sets the the count of columns to be displayed by a multi month
CalendarView.
|
| MultiViewRows |
Gets or sets the the count of rows to be displayed by a multi month
CalendarView.
|
| NavigationCellPadding |
Gets or sets the cell padding that is applied to the title table.
|
| NavigationCellSpacing |
Gets or sets the cell spacing that is applied to the title table.
|
| NavigationNextImage |
Gets or sets the name of the image that is displayed for the next month navigation control.
|
| NavigationNextText |
Gets or sets the text displayed for the next month navigation control. Will be
applied if there is no image set (see
NavigationNextImage).
|
| NavigationNextToolTip |
Gets or sets the text displayed as a tooltip for the next month navigation control.
|
| NavigationPrevImage |
Gets or sets name of the image that is displayed for the previous month navigation control.
|
| NavigationPrevText |
Gets or sets the text displayed for the previous month navigation control. Will be
applied only if there is no image set (see
NavigationPrevImage).
|
| NavigationPrevToolTip |
Gets or sets the text displayed as a tooltip for the previous month navigation control.
|
| NavigationSummary |
Gets or sets a value for navigation controls summary.
|
| Orientation |
Gets or sets the orientation (rendering direction) of the calendar component.
Default value is RenderInRows.
|
| OtherMonthDayStyle |
Gets the style properties for the days on the Calendar control that are not in the displayed month.
|
| OutOfRangeDayStyle |
Gets the style properties for the days on the Calendar control that are out of the valid range for selection.
|
| PresentationType |
Gets or sets the default type used by KaxCalendar to handle its
layout, and how will react to user interaction.
|
| RangeMaxDate |
Gets or sets the maximum date valid for selection by
Kettic KaxCalendar. Must be interpreted as the Higher bound of the valid
dates range available for selection. Kettic KaxCalendar will not allow
navigation or selection past this date.
|
| RangeMinDate |
Gets or sets the minimal date valid for selection by
Kettic KaxCalendar. Must be interpreted as the Lower bound of the valid
dates range available for selection. Kettic KaxCalendar will not allow
navigation or selection prior to this date.
|
| RangeSelectionEndDate |
Gets or sets the end date when calendar range selection is enabled.
|
| RangeSelectionMode |
Gets or sets the PerCalendar range selection mode.
Default value is None.
|
| RangeSelectionStartDate |
Gets or sets the start date when calendar range selection is enabled.
|
| RowHeaderImage |
Gets or sets the image displayed for the row header element.
|
| RowHeaderText |
Gets or sets the text displayed for the row header element.
|
| SelectedDate |
Sets or returns the currently selected date. The default value is the value of
System.DateTime.MinValue.
|
| SelectedDates |
Gets a collection of
KaxDate objects (that
encapsulate values of type System.DateTime) that represent the
selected dates on the KaxCalendar control.
|
| SelectedDayStyle |
Gets the style properties for the selected dates.
|
| ShowColumnHeaders | Gets or sets whether the column headers will appear on the calendar. |
| ShowDayCellToolTips |
Gets or sets a value indicating whether a tooltips for day cells should be rendered.
|
| ShowOtherMonthsDays |
Gets or sets whether the month matrix, when rendered will show days from other (previous or next)
months or will render only blank cells.
|
| ShowRowHeaders | Gets or sets whether the row headers will appear on the calendar. |
| SingleViewColumns |
Gets or sets the the count of columns to be displayed by a single
CalendarView.
|
| SingleViewHeight |
Gets or sets the Height applied to a single
CalendarView.
|
| SingleViewRows |
Gets or sets the the count of rows to be displayed by a single
CalendarView.
|
| SingleViewWidth |
Gets or sets the Width applied to a single
CalendarView.
|
| Skin |
Gets or sets the name of the skin used. All skins reside in the location set by
the SkinsPath
Property.
(Overrides KaxWebControl.Skin.) |
| TitleAlign | Gets or sets the horizontal alignment of the calendar title. The HorizontalAlign enumeration is defined in System.Web.UI.WebControls |
| TitleFormat | Gets or sets the format string that is applied to the calendar title. |
| TitleStyle |
Gets the style properties of the title heading for the Calendar control.
|
| ToolTip | (Overrides KaxWebControl.ToolTip.) |
| UseColumnHeadersAsSelectors |
When the
ShowColumnHeaders
and/or
ShowRowHeaders
properties are set to true, the UseColumnHeadersAsSelectors property specifies
whether to use the days of the week, which overrides the used text/image header if
any.
|
| UseRowHeadersAsSelectors |
When the
ShowColumnHeaders
and/or
ShowRowHeaders
properties are set to true, the UseRowHeadersAsSelectors property
specifies whether to use the number of the week, which overrides the used text/image
selector if any.
|
| ViewSelectorImage | Gets or sets the image displayed for the complete CalendarView selection element in the view selector cell. |
| ViewSelectorStyle |
Gets the style properties for the view selector cell.
|
| ViewSelectorText | Gets or sets the text displayed for the complete CalendarView selection element in the view selector cell. |
| Visible | (Overrides KaxWebControl.Visible.) |
| WeekendDayStyle |
Gets the style properties for the weekend dates on the Calendar control.
|
Events| Name | Description | |
|---|---|---|
 | DayRender | DayRender event is fired after the generation of every calendar cell
object and just before it gets rendered to the client. It is the last place where
changes to the already constructed calendar cells can be made.
|
| DefaultViewChanged | DefaultViewChanged event is fired a a navigation to a different date
range occurred. Generally this is done by using the normal navigation buttons or the
fast date navigation popup that allows "jumping" to a specified date.
|
| HeaderCellRender | HeadeCellRender event is fired after the generation of every calendar header cell
object and just before it gets rendered to the client. It is the preferred place where
changes to the constructed calendar header cells can be made.
|
| SelectionChanged | SelectionChanged event is fired when a new date is added or removed from
the
SelectedDates
collection.
|
See Also