WinForms › Time Picker › ITimePickerHost

ITimePickerHost

interface.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WinForms.Controls.Selectors.TimeSelectors

The settings a time picker's drop-down reads from the control that hosts it: the step and repeat rate of the arrows, the fonts and colours of the columns, and the time itself.

public interface ITimePickerHost

Remarks

TimePickerDropDown implements it, and its documentation describes each setting and its default. The drop-down's columns are internal to this assembly, so the interface is not normally implemented elsewhere.

Members at a glance

Properties
`AnteMeridianValue`	Gets or sets the text the AM/PM column shows for the morning.
`ContentPadding`	Gets or sets the space between the edge of the drop-down and its columns.
`DropDownTimeSelectionButtonEndColor`	Gets or sets an end colour for the drop-down button. Not used by the drop-down.
`DropDownTimeSelectionButtonStartColor`	Gets or sets a start colour for the drop-down button. Not used by the drop-down.
`HourValueComponentBackColor`	Gets or sets the background colour of the hours value box.
`HourValueComponentBackgroundEndColor`	Gets or sets the colour the hours column's background gradient ends in.
`HourValueComponentBackgroundStartColor`	Gets or sets the colour the hours column's background gradient starts from.
`HourValueComponentDisplayForeColor`	Gets or sets the colour of the hours value in the drop-down.
`Interval`	Gets or sets how far one click of an arrow moves the hours, minutes or seconds.
`MaxValue`	Gets or sets an upper limit for the values. The drop-down columns keep their own fixed ranges.
`MinValue`	Gets or sets a lower limit for the values. The drop-down columns keep their own fixed ranges.
`MinuteValueComponentBackColor`	Gets or sets the background colour of the minutes value box.
`MinuteValueComponentBackgroundEndColor`	Gets or sets the colour the minutes column's background gradient ends in.
`MinuteValueComponentBackgroundStartColor`	Gets or sets the colour the minutes column's background gradient starts from.
`MinuteValueComponentDisplayForeColor`	Gets or sets the colour of the minutes value in the drop-down.
`MousePressedValueChangeTriggerSpeed`	Gets or sets how often a held-down arrow repeats, in milliseconds.
`PostMeridianValue`	Gets or sets the text the AM/PM column shows for the afternoon and evening.
`SecondValueComponentBackColor`	Gets or sets the background colour of the seconds value box.
`SecondValueComponentBackgroundEndColor`	Gets or sets the colour the seconds column's background gradient ends in.
`SecondValueComponentBackgroundStartColor`	Gets or sets the colour the seconds column's background gradient starts from.
`SecondValueComponentDisplayForeColor`	Gets or sets the colour of the seconds value in the drop-down.
`ShouldAutoScaleTimePickerComponentsFont`	Gets or sets whether `TimePickerComponentsFont` should be resized with the drop-down.
`ShouldCloseSelectorDropDownViewUponAcceptCancelChanges`	Gets or sets whether the drop-down closes as soon as the user changes a value in it.
`ShouldDrawSpinnerButtonsInFullSize`	Gets or sets whether the up and down arrows fill their buttons or are drawn half-size in the middle.
`SpinnerBackgroundBrushEndColor`	Gets or sets the colour the arrows' gradient ends in at rest.
`SpinnerBackgroundBrushStartColor`	Gets or sets the colour the arrows' gradient starts from at rest.
`SpinnerHoverBackgroundBrushEndColor`	Gets or sets the colour an arrow's gradient ends in under the pointer.
`SpinnerHoverBackgroundBrushStartColor`	Gets or sets the colour an arrow's gradient starts from under the pointer.
`SpinnerPressedBackgroundBrushEndColor`	Gets or sets the colour an arrow's gradient ends in while it is held down.
`SpinnerPressedBackgroundBrushStartColor`	Gets or sets the colour an arrow's gradient starts from while it is held down.
`TimeConvention`	Gets or sets whether times are shown and picked on the twelve-hour or the twenty-four-hour clock.
`TimeMeridianValueComponentBackColor`	Gets or sets the background colour of the AM/PM value box.
`TimeMeridianValueComponentBackgroundEndColor`	Gets or sets the colour the AM/PM column's background gradient ends in.
`TimeMeridianValueComponentBackgroundStartColor`	Gets or sets the colour the AM/PM column's background gradient starts from.
`TimeMeridianValueComponentDisplayForeColor`	Gets or sets the colour of the AM/PM value in the drop-down.
`TimePickerComponentsFont`	Gets or sets the font of the values in the drop-down, or `null` to size them to fit their boxes.
`TimePickerDropDownBackgroundEndColor`	Gets or sets the colour the drop-down's background gradient ends in.
`TimePickerDropDownBackgroundStartColor`	Gets or sets the colour the drop-down's background gradient starts from.
`TimeValue`	Gets or sets the time shown in the control.
`TwelveHoursTimeDisplayFormat`	Gets or sets the format the time is shown in on the twelve-hour clock.
`TwentyFourHoursTimeDisplayFormat`	Gets or sets the format the time is shown in on the twenty-four-hour clock.
`ValueComponentBackColor`	Gets or sets a background colour for the value boxes. The drop-down columns read the per-column colours instead.
`ValueComponentBorderColor`	Gets or sets the colour of the border round each value box in the drop-down.
`ValueComponentBorderThickness`	Gets or sets the width of the border round each value box in the drop-down.
`ValueDisplayTextFontOffSetFactor`	Gets or sets how much smaller than its value box the area is that the value's font is sized to fit.
`ValueStringFormat`	Gets or sets how each value is aligned in its box in the drop-down.
Methods
`PerformDropDown`	Opens the drop-down, or closes it if it is open.

Properties

AnteMeridianValue

string AnteMeridianValue

Gets or sets the text the AM/PM column shows for the morning.

ContentPadding

Padding ContentPadding

Gets or sets the space between the edge of the drop-down and its columns.

DropDownTimeSelectionButtonEndColor

Color DropDownTimeSelectionButtonEndColor

Gets or sets an end colour for the drop-down button. Not used by the drop-down.

DropDownTimeSelectionButtonStartColor

Color DropDownTimeSelectionButtonStartColor

Gets or sets a start colour for the drop-down button. Not used by the drop-down.

HourValueComponentBackColor

Color HourValueComponentBackColor

Gets or sets the background colour of the hours value box.

HourValueComponentBackgroundEndColor

Color HourValueComponentBackgroundEndColor

Gets or sets the colour the hours column's background gradient ends in.

HourValueComponentBackgroundStartColor

Color HourValueComponentBackgroundStartColor

Gets or sets the colour the hours column's background gradient starts from.

HourValueComponentDisplayForeColor

Color HourValueComponentDisplayForeColor

Gets or sets the colour of the hours value in the drop-down.

Interval

decimal Interval

Gets or sets how far one click of an arrow moves the hours, minutes or seconds.

MaxValue

int MaxValue

Gets or sets an upper limit for the values. The drop-down columns keep their own fixed ranges.

MinValue

int MinValue

Gets or sets a lower limit for the values. The drop-down columns keep their own fixed ranges.

MinuteValueComponentBackColor

Color MinuteValueComponentBackColor

Gets or sets the background colour of the minutes value box.

MinuteValueComponentBackgroundEndColor

Color MinuteValueComponentBackgroundEndColor

Gets or sets the colour the minutes column's background gradient ends in.

MinuteValueComponentBackgroundStartColor

Color MinuteValueComponentBackgroundStartColor

Gets or sets the colour the minutes column's background gradient starts from.

MinuteValueComponentDisplayForeColor

Color MinuteValueComponentDisplayForeColor

Gets or sets the colour of the minutes value in the drop-down.

MousePressedValueChangeTriggerSpeed

int MousePressedValueChangeTriggerSpeed

Gets or sets how often a held-down arrow repeats, in milliseconds.

PostMeridianValue

string PostMeridianValue

Gets or sets the text the AM/PM column shows for the afternoon and evening.

SecondValueComponentBackColor

Color SecondValueComponentBackColor

Gets or sets the background colour of the seconds value box.

SecondValueComponentBackgroundEndColor

Color SecondValueComponentBackgroundEndColor

Gets or sets the colour the seconds column's background gradient ends in.

SecondValueComponentBackgroundStartColor

Color SecondValueComponentBackgroundStartColor

Gets or sets the colour the seconds column's background gradient starts from.

SecondValueComponentDisplayForeColor

Color SecondValueComponentDisplayForeColor

Gets or sets the colour of the seconds value in the drop-down.

ShouldAutoScaleTimePickerComponentsFont

bool ShouldAutoScaleTimePickerComponentsFont

Gets or sets whether TimePickerComponentsFont should be resized with the drop-down.

ShouldCloseSelectorDropDownViewUponAcceptCancelChanges

bool ShouldCloseSelectorDropDownViewUponAcceptCancelChanges

Gets or sets whether the drop-down closes as soon as the user changes a value in it.

ShouldDrawSpinnerButtonsInFullSize

bool ShouldDrawSpinnerButtonsInFullSize

Gets or sets whether the up and down arrows fill their buttons or are drawn half-size in the middle.

SpinnerBackgroundBrushEndColor

Color SpinnerBackgroundBrushEndColor

Gets or sets the colour the arrows' gradient ends in at rest.

SpinnerBackgroundBrushStartColor

Color SpinnerBackgroundBrushStartColor

Gets or sets the colour the arrows' gradient starts from at rest.

SpinnerHoverBackgroundBrushEndColor

Color SpinnerHoverBackgroundBrushEndColor

Gets or sets the colour an arrow's gradient ends in under the pointer.

SpinnerHoverBackgroundBrushStartColor

Color SpinnerHoverBackgroundBrushStartColor

Gets or sets the colour an arrow's gradient starts from under the pointer.

SpinnerPressedBackgroundBrushEndColor

Color SpinnerPressedBackgroundBrushEndColor

Gets or sets the colour an arrow's gradient ends in while it is held down.

SpinnerPressedBackgroundBrushStartColor

Color SpinnerPressedBackgroundBrushStartColor

Gets or sets the colour an arrow's gradient starts from while it is held down.

TimeConvention

TimeConvention TimeConvention

Gets or sets whether times are shown and picked on the twelve-hour or the twenty-four-hour clock.

TimeMeridianValueComponentBackColor

Color TimeMeridianValueComponentBackColor

Gets or sets the background colour of the AM/PM value box.

TimeMeridianValueComponentBackgroundEndColor

Color TimeMeridianValueComponentBackgroundEndColor

Gets or sets the colour the AM/PM column's background gradient ends in.

TimeMeridianValueComponentBackgroundStartColor

Color TimeMeridianValueComponentBackgroundStartColor

Gets or sets the colour the AM/PM column's background gradient starts from.

TimeMeridianValueComponentDisplayForeColor

Color TimeMeridianValueComponentDisplayForeColor

Gets or sets the colour of the AM/PM value in the drop-down.

TimePickerComponentsFont

Font TimePickerComponentsFont

Gets or sets the font of the values in the drop-down, or null to size them to fit their boxes.

TimePickerDropDownBackgroundEndColor

Color TimePickerDropDownBackgroundEndColor

Gets or sets the colour the drop-down's background gradient ends in.

TimePickerDropDownBackgroundStartColor

Color TimePickerDropDownBackgroundStartColor

Gets or sets the colour the drop-down's background gradient starts from.

TimeValue

DateTime TimeValue

Gets or sets the time shown in the control.

TwelveHoursTimeDisplayFormat

string TwelveHoursTimeDisplayFormat

Gets or sets the format the time is shown in on the twelve-hour clock.

TwentyFourHoursTimeDisplayFormat

string TwentyFourHoursTimeDisplayFormat

Gets or sets the format the time is shown in on the twenty-four-hour clock.

ValueComponentBackColor

Color ValueComponentBackColor

Gets or sets a background colour for the value boxes. The drop-down columns read the per-column colours instead.

ValueComponentBorderColor

Color ValueComponentBorderColor

Gets or sets the colour of the border round each value box in the drop-down.

ValueComponentBorderThickness

int ValueComponentBorderThickness

Gets or sets the width of the border round each value box in the drop-down.

ValueDisplayTextFontOffSetFactor

int ValueDisplayTextFontOffSetFactor

Gets or sets how much smaller than its value box the area is that the value's font is sized to fit.

ValueStringFormat

StringFormat ValueStringFormat

Gets or sets how each value is aligned in its box in the drop-down.

Methods

PerformDropDown

void PerformDropDown()

Opens the drop-down, or closes it if it is open.