WinForms › Tree List View › BinaryTreeListViewDatePickerColumn

BinaryTreeListViewDatePickerColumn

class.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WinForms.Controls.TreeControls

A specialised column type that uses Binarymission's BinaryDatePicker control as its cell editor.

public class BinaryTreeListViewDatePickerColumn : DataGridViewColumn

Inherits from / implements: DataGridViewColumn

Members at a glance

`BinaryTreeListViewDatePickerColumn`	Constructs a new instance of the `BinaryTreeListViewDatePickerColumn` class.
`BinaryCultureInfo`	Gets or sets the CultureInfo to be used for the current instance of the control.
`BorderColor`	Gets or sets the border color for the control's date displaying control's borders.
`CalendarForeColor`	Gets or sets the color for the calendar's text forecolor (example - text forecolor for dates, days, etc.).
`CalendarInactiveDateForeColor`	Gets or sets the color for the Inactive date(s) in the calendar for a given month/year.
`CalendarLegendDisplay`	Gets or sets the legend display value, indicating whether or not the control should display in the calendar, a legend for various date markers.
`CalendarMonthAndYearTrackerColor`	Gets or sets the color for painting the Month/Year tracker control in the control's calendar.
`CalendarMonthBackColor`	Gets or sets the background color for the calendar.
`CalendarMonthTitleForeColor`	Gets or sets the color for the Month/Year title string in the Calendar.
`CloseButtonBackColor`	Gets or sets the BackColor property for the control's drop-down calendar's "Close" button.
`CloseButtonFlatStyle`	Gets or sets the `FlatStyle` property for the control's drop-down calendar's "Close" button.
`CloseButtonForeColor`	Gets or sets the ForeColor property for the control's drop-down calendar's "Close" button.
`CloseButtonText`	Gets or sets the text to be associated with the drop-down calendar's command button, that is used to close the calendar window.
`CustomDropDownImage`	Gets or sets the custom image that will be drawn in the control's drop-down button portion.
`CustomFormat`	Gets or sets the custom date format for displaying a date string in the control's text box, when the control's `Format` property is set to "Custom" (refer to `BinaryDatePickerFormat` for various available format values).
`DotBorderDepth`	Gets or sets the painting depth (length/width) of the dotted border for the control's date displaying control.
`DotBorderGap`	Gets or sets the painting gaps between the dots while drawing the dotted border for the control's date displaying control.
`DrawBorderAs`	Gets or sets the border state of the control when drawing the control's date displaying control's border.
`DrawStyleIsFlat`	Gets or sets whether a cell that is not being edited draws its drop-down button flat - a chevron, inside a hairline box when `ShowBorderAlways` is on - or as the classic themed push button.
`EditControlStyleIsExtended`	Gets or sets the control's text box border style.
`Format`	Gets or sets the display format for the control.
`MarkSelectedDate`	Gets or sets the value indicating whether a selected date (including today's date) can be marked, in the calendar, with a filled circle.
`SelectionDateEllipseColor`	Gets or sets the circle fill color for a given selected date in the calendar.
`SelectionDateForeColor`	Gets or sets the foreground color for a given selected date in the calendar.
`ShowBorderAlways`	Gets or sets whether the control will always have its border displayed, even when the control is not currently in focus.
`TodayButtonBackColor`	Gets or sets the BackColor property for the control's drop-down calendar's "Today" button.
`TodayButtonFlatStyle`	Gets or sets the `FlatStyle` property for the control's drop-down calendar's "Today" button.
`TodayButtonForeColor`	Gets or sets the ForeColor property for the control's drop-down calendar's "Today" button.
`TodayButtonText`	Gets or sets the text to be associated with the Calendar's command button, that is used to set the date to Today's date.
`TodayCloseButtonsAreVisible`	Gets or sets whether the "Today" and "Close" buttons are visible when the control's drop-down calendar is displayed.
`TodayEllipseColor`	Gets or sets the circle fill color for "Today's" date, if it appears in the calendar.
`TodayForeColor`	Gets or sets the foreground color for the "today's" date, if it appears in the calendar.
`UseDropDownImageStyle`	Gets or sets the style to use, to draw the image in the control's drop-down button portion.
`Clone`	Creates a copy of this BinaryTreeListViewDatePickerColumn, carrying across every setting this type adds to the base implementation.

Constructors

BinaryTreeListViewDatePickerColumn

public BinaryTreeListViewDatePickerColumn() : base(new BinaryTreeListViewDatePickerCell())

Constructs a new instance of the BinaryTreeListViewDatePickerColumn class.

Properties

BinaryCultureInfo

public CultureInfo BinaryCultureInfo

Gets or sets the CultureInfo to be used for the current instance of the control.

By default, the control uses the default culture (of the currently running thread) CurrentCulture to display date/time and its drop-down calendar. If for any reason, you want to specifically set the control's culture to use a different CultureInfo value (say you want to use "fr-FR" CultureInfo in a system with default CultureInfo pointing to "en-GB"), then you can set this property with that specific value, to let the control use that specific culture for its current instance.

BorderColor

public Color BorderColor

Gets or sets the border color for the control's date displaying control's borders.

Use this property to set the Control's border color. By default, this property is set to ControlDarkDark color value.
Note: This property is applicable only when the control is in the ExtendedStyle mode (Refer EditControlStyleIsExtended).

CalendarForeColor

public Color CalendarForeColor

Gets or sets the color for the calendar's text forecolor (example - text forecolor for dates, days, etc.).

Set this property to set the forecolor for the dates and day names, as they appear in the dropdown calendar.

CalendarInactiveDateForeColor

public Color CalendarInactiveDateForeColor

Gets or sets the color for the Inactive date(s) in the calendar for a given month/year.

Value. A Color value.

Inactive dates are those dates in a month calendar, that are displayed, but they do not belong to that month. These dates are shown just as a continuation, of the previous and/or next month's dates, in a given month's calendar. To differentiate these inactive dates form the current month's dates, you can set this property. By default, this property is set to ControlDark color value.

CalendarLegendDisplay

public bool CalendarLegendDisplay

Gets or sets the legend display value, indicating whether or not the control should display in the calendar, a legend for various date markers.

Value. A bool value indicating whether legend display facility is on or off.

The calendar has the facility to show a circle around a "selected date" and "today's date", with different fill colors (which is again configurable). To explain the user what these filled circles mean, a simple legend is displayed at the bottom of the calendar. To switch off this legend display, set this property to false. By default, the property is assigned a true value.

CalendarMonthAndYearTrackerColor

public Color CalendarMonthAndYearTrackerColor

Gets or sets the color for painting the Month/Year tracker control in the control's calendar.

Value. A Color value.

BinaryDatePicker's calendar control has a title which displays a given month name and year, as currently displayed in the calendar. The title area also carries two tracking controls (displayed as small tilted triangles) to the extreme left and right ends of the title. A user can click these controls to navigate between various month(s) and year(s). BinaryDatePicker control allows you to customise these tracking control's forecolors, by allowing you to set the CalendarMonthAndYearTrackerColor property.

CalendarMonthBackColor

public Color CalendarMonthBackColor

Gets or sets the background color for the calendar.

CalendarMonthTitleForeColor

public Color CalendarMonthTitleForeColor

Gets or sets the color for the Month/Year title string in the Calendar.

CloseButtonBackColor

public Color CloseButtonBackColor

Gets or sets the BackColor property for the control's drop-down calendar's "Close" button.

CloseButtonFlatStyle

public FlatStyle CloseButtonFlatStyle

Gets or sets the FlatStyle property for the control's drop-down calendar's "Close" button.

CloseButtonForeColor

public Color CloseButtonForeColor

Gets or sets the ForeColor property for the control's drop-down calendar's "Close" button.

CloseButtonText

public string CloseButtonText

Gets or sets the text to be associated with the drop-down calendar's command button, that is used to close the calendar window.

The control's drop-down calendar displays a command button to let the user conveniently close the calendar window.
By default, this command button has the text "Close" in English language.
If you want to change this text to display "Close" in another language convenient to your user, then you can set this property with a string pointing to another language equivalent of the english word "Close".
Note: The command button size is a fixed size of Size(47,20).
Hence ensure the new text you will be assigning to this property is within this size range, to display the text properly.

CustomDropDownImage

public Bitmap CustomDropDownImage

Gets or sets the custom image that will be drawn in the control's drop-down button portion.

BinaryDatePicker control lets you set a custom image to be used to draw the control's drop-down button portion. When you want to use your own custom image, first set the property UseDropDownImageStyle to DropDownImageStyle.CustomImage and then set this property to an image of size 11 x 13 (width 11, height 13).
Note: If your specified image is not of size 11 x 13, then the built-in calendar image will be used to draw instead.

CustomFormat

public string CustomFormat

Gets or sets the custom date format for displaying a date string in the control's text box, when the control's Format property is set to "Custom" (refer to BinaryDatePickerFormat for various available format values).

Value. A string that represents the custom date-time format.

Refer to DateTimeFormatInfo type to specify a valid "custom" date pattern string to set this property. For example, to display the date as "March 27 2001 at 12 AM", set the CustomFormat property to "MMMM dd yyyy 'at' hh tt". By default, this property is set to the "Long" date/time format as per the culture of the current thread.

DotBorderDepth

public int DotBorderDepth

Gets or sets the painting depth (length/width) of the dotted border for the control's date displaying control.

When you set the DrawBorderAs property to "Dotted" (refer BorderState), the control is drawn with a dotted border.
You can set the depth of each of the dotted border part, by setting this property. This property determines the length/width of each of the dot, while drawing the border.
By default, this property is set to integer (int) value of 4.

DotBorderGap

public int DotBorderGap

Gets or sets the painting gaps between the dots while drawing the dotted border for the control's date displaying control.

When you set the DrawBorderAs property to "Dotted" (refer BorderState), the control is drawn with a dotted border.
You can set the gap between each of the dotted border part by setting this property. This property determines the length of gap between each dot, while drawing the border.
By default, this property is set to integer (int) value of 5.

DrawBorderAs

public BorderState DrawBorderAs

Gets or sets the border state of the control when drawing the control's date displaying control's border.

This property is available only when the control is in EditControlStyleIsExtended mode.
Basically, there are two different states available for drawing the control's border, while in EditControlStyleIsExtended.

Normal border - This is a BorderState when the control's border is drawn using a continuous line.
Dotted border - This is a BorderState when the control's border is drawn as a dotted border.

If you want the control's border to be drawn as a dotted border, you should set this property to the appropriate value, viz., "BinaryDatePicker.BorderState.Dotted".
If you want the control's border to be drawn as a regular un-dotted line, set this property to "BinaryDatePicker.BorderState.Normal".

DrawStyleIsFlat

public bool DrawStyleIsFlat

Gets or sets whether a cell that is not being edited draws its drop-down button flat - a chevron, inside a hairline box when ShowBorderAlways is on - or as the classic themed push button.

Applies while the grid's SpecialColumnCellsToDisplayEditingControlOnCellsAlways is on, which is when a cell shows its editor's chrome at all. The default is true, the same as DrawStyleIsFlat, so the three special columns match (HANDOVER 3av).

EditControlStyleIsExtended

public bool EditControlStyleIsExtended

Gets or sets the control's text box border style.

BinaryDatePicker control supports two styles for its date displaying text box control.
One is the standard Windows text box style and the other is a text box with the Windows© XP© style text box borders.
Also, when you set the property to true, the control additionally supports a hovering mechanism for the text box, i.e., when the mouse pointer is brought into the text box area, the borders change to the XP style borders, and when the text box loses input focus, the borders change to a different state indicating that the control has lost focus.
This is similar to the behaviour that you can see in the MSDN© edit/combo controls.

Format

public BinaryDatePickerFormat Format

Gets or sets the display format for the control.

Value. A BinaryDatePickerFormat enum.

Refer to BinaryDatePickerFormat enum to specify a valid date/time display format. For example, if you set this property to "Long", the date will displayed using the Long date format as specified in your computer's Operating system.

MarkSelectedDate

public bool MarkSelectedDate

Gets or sets the value indicating whether a selected date (including today's date) can be marked, in the calendar, with a filled circle.

The default value is true, meaning, that any selected date in the calendar (including Today's date) will be marked with a filled circle.
Note: When this value to set to false, the control's another property CalendarLegendDisplay is also set to false automatically.
Remember this when setting this property to false.

SelectionDateEllipseColor

public Color SelectionDateEllipseColor

Gets or sets the circle fill color for a given selected date in the calendar.

When a user selects a date from the dropdown calendar, a special circle/ellipse is drawn around that date (with a default color "Blue") to mark the selected date. You can change this and set a special color to that circle that is drawn around the date. To achieve this, set this property to a Color value. By default, this property is set to Blue.

SelectionDateForeColor

public Color SelectionDateForeColor

Gets or sets the foreground color for a given selected date in the calendar.

When a user selects a date from the dropdown calendar, a special color can be used as the forecolor for that date, so as to mark the user's selection. To achieve this, set this property to a Color value. By default, this property is set to Yellow.

ShowBorderAlways

public bool ShowBorderAlways

Gets or sets whether the control will always have its border displayed, even when the control is not currently in focus.

If set to true, the control will always display its border even when the input focus is not on the control. By default, this property is set to false.
Note: This property has effect only when the control is in extended mode (refer EditControlStyleIsExtended).

TodayButtonBackColor

public Color TodayButtonBackColor

Gets or sets the BackColor property for the control's drop-down calendar's "Today" button.

TodayButtonFlatStyle

public FlatStyle TodayButtonFlatStyle

Gets or sets the FlatStyle property for the control's drop-down calendar's "Today" button.

TodayButtonForeColor

public Color TodayButtonForeColor

Gets or sets the ForeColor property for the control's drop-down calendar's "Today" button.

TodayButtonText

public string TodayButtonText

Gets or sets the text to be associated with the Calendar's command button, that is used to set the date to Today's date.

The control's drop-down calendar displays a command button to let the user conveniently set the control's date to DateTime.Today (or DateTime.Now).
By default, this command button has the text "Today" in English language.
If you want to change this text to display "Today" in another language convenient to your user, then you can set this property with a string pointing to another language equivalent of the english word "Today".
Note: The command button size is a fixed size of Size(47,20).
Hence ensure the new text you will be assigning to this property is within this size range, to display the text properly.

TodayCloseButtonsAreVisible

public bool TodayCloseButtonsAreVisible

Gets or sets whether the "Today" and "Close" buttons are visible when the control's drop-down calendar is displayed.

TodayEllipseColor

public Color TodayEllipseColor

Gets or sets the circle fill color for "Today's" date, if it appears in the calendar.

When a user selects "Today's" date from the dropdown calendar, a special circle/ellipse is drawn around that date (with a default color Green) to mark the selected date. You can change this and set a special color to that circle that is drawn around the date. To achieve this, set this property to a Color value.

TodayForeColor

public Color TodayForeColor

Gets or sets the foreground color for the "today's" date, if it appears in the calendar.

When a user selects "Today's" date from the dropdown calendar, a special color can be used as the forecolor for that date, so as to mark the user's selection. To achieve this, set this property to a Color value. By default, this property is set to Yellow.

UseDropDownImageStyle

public DropDownImageStyle UseDropDownImageStyle

Gets or sets the style to use, to draw the image in the control's drop-down button portion.

Please refer to the property CustomDropDownImage for more details.

Methods

Clone

public override object Clone()

Creates a copy of this BinaryTreeListViewDatePickerColumn, carrying across every setting this type adds to the base implementation.