[]
        
(Showing Draft Content)

C1.Win.Ribbon.RibbonTimePicker

RibbonTimePicker Class

Represents a time-picker element in C1Ribbon and C1StatusBar controls.

Implements
ISupportUiaContainer
Namespace: C1.Win.Ribbon
Assembly: C1.Win.Ribbon.4.8.dll
Syntax
public class RibbonTimePicker : RibbonIconItem, IComponent, IDisposable, ISupportUiaContainer

Constructors

Name Description
RibbonTimePicker()

Creates a new instance of RibbonTimePicker.

Properties

Name Description
CanBeAddedToQat

Gets or sets whether the user can add this RibbonItem to the Quick Access Toolbar at runtime.

ContextMenuStrip

Gets or sets the context menu strip associated with the time-picker.

CueBanner

Gets or sets the textual cue, or tip, that is displayed by RibbonTimePicker to prompt the user for information.

Format

Gets or sets the custom time format string.

GapBeforeTextArea

Gets or sets the gap between the label and text area when this RibbonTimePicker appears on a RibbonGroup.

KeyTip

Gets or sets the KeyTip providing keyboard access to a RibbonTimePicker.

Label

Gets or sets the label used to identify this RibbonTimePicker.

LabelWidth

Gets or sets the width of the text label. Set to -1 to let the label calculate width automatically.

ReadOnly

Gets or sets a value indicating whether the contents of the component can be changed.

SpinButtonPressDelay

Gets or sets the interval before the spin buttons start firing click events, in milliseconds.

SpinButtonPressInterval

Gets or sets the interval between clicks when the spin buttons are kept pressed, in milliseconds.

StandardFormat

Sets the standard time format.

Text

Gets or sets the text associated with the component.

TextAlign

Gets or sets how text is aligned in the RibbonTimePicker.

TextAreaWidth

Gets or sets the width of RibbonTimePicker's text area.

TextBox

Gets the TextBox control contained in this RibbonTimePicker.

TimeFormat

Gets the DateTimeFormatInfo that is used for data formatting.

Value

Gets or sets the time value assigned to the component.

ValueIsNull

Gets or sets whether the selected time is null.

Methods

Name Description
DownButton()

Simulates a click of the down button.

OnChangeCanceled(EventArgs)

Raises the ChangeCanceled event.

OnChangeCommitted(EventArgs)

Raises the ChangeCommitted event.

OnFormatChanged(EventArgs)

Raises the FormatChanged event.

OnGotFocus(EventArgs)

Raises the GotFocus event.

OnKeyDown(KeyEventArgs)

Raises the KeyDown event.

OnKeyPress(KeyPressEventArgs)

Raises the KeyPress event.

OnKeyUp(KeyEventArgs)

Raises the KeyUp event.

OnLostFocus(EventArgs)

Raises the LostFocus event.

OnPrepareTimeFormat(PrepareDateTimeFormatEventArgs)

Raises the PrepareTimeFormat event.

OnSpinButtonClick(SpinButtonClickEventArgs)

Raises the SpinButtonClick event.

OnTextChanged(EventArgs)

Raises the TextChanged event.

OnValueChanged(EventArgs)

Raises the ValueChanged event.

ResetValue()
ShouldSerializeStandardFormat()
ShouldSerializeValue()
UpButton()

Simulates a click of the up button.

Events

Name Description
ChangeCanceled

Occurs when the user cancels changes to the RibbonTimePicker.

ChangeCommitted

Occurs when the user commits changes to the RibbonTimePicker.

FormatChanged

Fires when the Format property changes.

GotFocus

Occurs when the RibbonTimePicker receives focus.

KeyDown

Occurs when a key is first pressed.

KeyPress

Occurs when the user presses and releases a key.

KeyUp

Occurs when a key is released.

LostFocus

Occurs when the RibbonTimePicker loses focus.

PrepareTimeFormat

Fires when the TimeFormat property is recreated.

SpinButtonClick

Fires when the up/down buttons are clicked, before their built-in processing.

TextChanged

Event raised when the text is changed.

ValueChanged

Fires when the Value property changes.