[]
        
(Showing Draft Content)

C1.Win.Calendar.CalendarSettings

CalendarSettings Class

Represents the settings of drop down calendar.

Inheritance
CalendarSettings
Implements
Namespace: C1.Win.Calendar
Assembly: C1.Win.Calendar.4.8.dll
Syntax
[TypeConverter(typeof(ExpandableObjectConverter))]
public class CalendarSettings : IDisposable

Properties

Name Description
AnnuallyBoldedDates

Gets or sets the array of System.DateTime objects that determines which annual days are displayed in bold.

ArrowColor

Gets or sets the color of the arrows.

BackColor

Gets or sets the background color of the control.

BoldedDates

Gets or sets the array of System.DateTime objects that determines which nonrecurring dates are displayed in bold.

CalendarDimensions

Gets or sets the number of columns and rows of months displayed.

CalendarWeekRule

Gets or sets a value that specifies which rule is used to determine the first calendar week of the year.

CaptionFormat

Gets or sets the format to use for the calendar caption.

ClearText

Gets or sets the text of the "Clear" button.

CurrentMonthDisplayOffset

Gets or sets the current month display offset.

DateIsNull

Gets or sets the value indicating that no date is currently selected in the calendar.

DayNameLength

Gets or sets the maximum length of day names.

DayNamesColor

Gets or sets the day names' text color.

DayNamesFont

Gets or sets the day names font.

DisabledDates

Gets or sets the array of System.DateTime objects that determines which dates are disabled.

FirstDayOfWeek

Gets or sets the first day of the week as displayed in the month calendar.

FirstMonth

Gets the first day of the first fully shown month.

Font

Gets or sets the font of the text displayed by the dropdown calendar.

ForeColor

Gets or sets the foreground color of the control.

LastMonth

Gets the last day of the last fully shown month.

LineColor

Gets or sets the line color.

MaxDate

Gets or sets the maximum allowable date.

MinDate

Gets or sets the minimum allowable date. The default value is DateTime.MinValue (01/01/0001).

RightToLeft

Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.

RightToLeftLayout

Gets or sets a value indicating whether the control is laid out from right to left.

SelectedDate

Gets or sets the selected date.

SelectionBackColor

Gets or sets the selection background color.

SelectionForeColor

Gets or sets the selection foreground color.

ShowClearButton

Determines if the Clear button of the dropdown calendar is visible.

ShowToday

Gets or sets a value indicating whether the date represented by the TodayDate property is displayed at the bottom of the control.

ShowTodayButton

Determines if the Today button of the dropdown calendar is visible.

ShowTodayCircle

Gets or sets a value indicating whether today's date is circled.

ShowToolTips

Gets or sets whether the C1DateEdit should display tooltips.

ShowWeekNumbers

Gets or sets a value indicating whether the month calendar control displays week numbers (1-52) to the left of each row of days.

SyncValueWithSelection

Updates the Value each time the selection is changed.

TitleBackColor

Gets or sets a value indicating the background color of the title area of the calendar.

TitleFont

Gets or sets the title font.

TitleForeColor

Gets or sets a value indicating the foreground color of the title area of the calendar.

TitleHeight

Gets or sets the title height.

TitleNavigation

Gets or sets a value indicating whether current month and year can be changed by clicking on the title of the calendar.

TodayBorderColor

Gets or sets the color of the border around the current date.

TodayText

Gets or sets the text of the "Today" button.

TrailingForeColor

Gets or sets a value indicating the color of days in months that are not fully displayed in the control.

VisualStyle

Gets or sets VisualStyle.

WeekNumbersFont

Gets or sets the font of week numbers.

Methods

Name Description
AddAnnuallyBoldedDate(DateTime)

Adds a day that is displayed in bold on an annual basis in the month calendar.

AddBoldedDate(DateTime)

Adds a day to be displayed in bold in the month calendar.

AddDisabledDate(DateTime)

Adds a day to be disabled in the month calendar.

AddMonthlyBoldedDate(DateTime)

Adds a day that is displayed in bold on a monthly basis in the month calendar.

OnBeforeDayTooltipShow(BeforeDayTooltipShowEventArgs)

Rises the BeforeDayTooltipShow event.

OnClearButtonClick(EventArgs)

Raises the ClearButtonClick event.

OnClearButtonVisibilityChanged(EventArgs)

Raises the ClearButtonVisibilityChanged event.

OnDateValueChanged(NullableDateTimeEventArgs)

Raises the DateValueChanged event.

OnDateValueSelected(NullableDateTimeEventArgs)

Raises the DateValueSelected event.

OnDayFormatting(DayFormattingEventArgs)

Rises the DayFormatting event.

OnDisplayRangeChanged(DateRangeEventArgs)

Rises the DisplayRangeChanged event.

OnMonthChanged(EventArgs)

Raises the MonthChanged event.

OnRightToLeftLayoutChanged(EventArgs)

Raises the RightToLeftLayoutChanged event.

OnTodayButtonClick(EventArgs)

Raises the TodayButtonClick event.

OnTodayButtonVisibilityChanged(EventArgs)

Raises the TodayButtonVisibilityChanged event.

OnVisualStyleChanged(EventArgs)

Raises the VisualStyleChanged event.

RemoveAllAnnuallyBoldedDates()

Removes all the annually bold dates.

RemoveAllBoldedDates()

Removes all the nonrecurring bold dates.

RemoveAllDisabledDates()

Removes the all disabled dates.

RemoveAllMonthlyBoldedDates()

Removes all the monthly bold dates.

RemoveAnnuallyBoldedDate(DateTime)

Removes the specified date from the list of annually bold dates.

RemoveBoldedDate(DateTime)

Removes the specified date from the list of nonrecurring bold dates.

RemoveDisabledDate(DateTime)

Removes the specified date from the list of disabled dates.

RemoveMonthlyBoldedDate(DateTime)

Removes the specified date from the list of monthly bolded dates.

ResetAnnuallyBoldedDates()

Clears AnnuallyBoldedDates.

ResetArrowColor()
ResetBackColor()
ResetBoldedDates()

Clears BoldedDates.

ResetCalendarDimensions()

Sets the CalendarDimensions property to its default value.

ResetDayNameLength()
ResetDayNamesColor()
ResetDayNamesFont()
ResetDisabledDates()

Clears ResetDisabledDates().

ResetFont()
ResetForeColor()
ResetLineColor()
ResetMaxDate()

Sets the MaxDate property to its default value.

ResetMinDate()

Sets the MinDate property to its default value.

ResetMonthlyBoldedDates()

Clears C1.Win.Calendar.CalendarSettings.MonthlyBoldedDates.

ResetSelectedDate()

Sets the SelectedDate property to its default value.

ResetSelectionBackColor()
ResetSelectionForeColor()
ResetTitleBackColor()
ResetTitleFont()
ResetTitleForeColor()
ResetTitleHeight()
ResetTodayBorderColor()
ResetTrailingForeColor()
ResetVisualStyle()

Resets VisualStyle to the default value.

ResetWeekNumbersFont()
SetCalendarDimensions(int, int)

Sets the number of columns and rows of months to display.

SetDate(DateTime)

Sets a date as the currently selected date.

SetSelectionRange(DateTime, DateTime)

Sets the selected dates in a month calendar control to the specified date range.

ShouldSerializeAnnuallyBoldedDates()

Indicates whether the AnnuallyBoldedDates property should be persisted.

ShouldSerializeArrowColor()
ShouldSerializeBackColor()
ShouldSerializeBoldedDates()

Indicates whether the BoldedDates property should be persisted.

ShouldSerializeCalendarDimensions()

Indicates whether the CalendarDimensions property should be persisted.

ShouldSerializeDayNameLength()
ShouldSerializeDayNamesColor()
ShouldSerializeDayNamesFont()
ShouldSerializeDisabledDates()

Indicates whether the DisabledDates property should be persisted.

ShouldSerializeFont()
ShouldSerializeForeColor()
ShouldSerializeLineColor()
ShouldSerializeMaxDate()

Indicates whether the MaxDate property should be persisted.

ShouldSerializeMinDate()

Indicates whether the MinDate property should be persisted.

ShouldSerializeMonthlyBoldedDates()

Indicates whether the C1.Win.Calendar.CalendarSettings.MonthlyBoldedDates property should be persisted.

ShouldSerializeSelectedDate()

Indicates whether the SelectedDate property should be persisted.

ShouldSerializeSelectionBackColor()
ShouldSerializeSelectionForeColor()
ShouldSerializeTitleBackColor()
ShouldSerializeTitleFont()
ShouldSerializeTitleForeColor()
ShouldSerializeTitleHeight()
ShouldSerializeTodayBorderColor()
ShouldSerializeTrailingForeColor()
ShouldSerializeVisualStyle()

Tests whether VisualStyle should be serialized.

ShouldSerializeWeekNumbersFont()

Events

Name Description
BeforeDayTooltipShow

Occurs before the day tooltip is shown.

ClearButtonClick

Occurs when Clear button is clicked.

ClearButtonVisibilityChanged

Occurs when Clear button visibility is changed.

DateValueChanged

Occurs when the value of the Date property is changed.

DateValueSelected

Occurs when the user selects a value for the Date property.

DayFormatting

Occurs before applying styles to a day.

DisplayRangeChanged

Occurs when display range changed.

MonthChanged

Handles the month change in the Dropdown calendar in C1DateEdit. Occurs when the value of the FirstMonth or LastMonth property changes.

RightToLeftLayoutChanged

Occurs when the value of the RightToLeftLayout property changes.

TodayButtonClick

Occurs when Today button is clicked.

TodayButtonVisibilityChanged

Occurs when Today button visibility is changed.

VisualStyleChanged

Occurs when the VisualStyle property has changed.