RadTimeView
The RadTimeView control works only as a popup embedded in a RadTimePicker or RadDateTimePicker control. The main reason to add a RadTimeView control from the toolbox to the Web page is when using it as a shared popup control.
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[EmbeddedSkin("Calendar", typeof(RadTimeView))]
[EmbeddedSkin("Calendar", "Black", typeof(RadTimeView))]
[EmbeddedSkin("Calendar", "Default", typeof(RadTimeView))]
[EmbeddedSkin("Calendar", "Office2007", typeof(RadTimeView))]
[EmbeddedSkin("Calendar", "Outlook", typeof(RadTimeView))]
[EmbeddedSkin("Calendar", "Simple", typeof(RadTimeView))]
[EmbeddedSkin("Calendar", "Sunset", typeof(RadTimeView))]
[EmbeddedSkin("Calendar", "Telerik", typeof(RadTimeView))]
[EmbeddedSkin("Calendar", "Vista", typeof(RadTimeView))]
[EmbeddedSkin("Calendar", "Web20", typeof(RadTimeView))]
[EmbeddedSkin("Calendar", "WebBlue", typeof(RadTimeView))]
[EmbeddedSkin("Calendar", "Windows7", typeof(RadTimeView))]
[ToolboxBitmap(typeof(RadTimeView), "Toolbox.Icons.Calendar.png")]
[TelerikToolboxCategory("Date/Color Picker")]
[ClientScriptResource("Telerik.Web.UI.RadTimeView", "Telerik.Web.UI.Calendar.RadTimeViewScripts.js")]
public class RadTimeView : RadWebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, INamingContainer, ICustomTypeDescriptorInheritance: objectControlWebControlRadWebControlRadTimeView
Implements:
Inherited Members
Constructors
public RadTimeView()Properties
Gets or sets the access key.
public override string AccessKey { get; set; }The access key.
Overrides:
Gets the style properties for alternating time sells in the RadTimeView control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual TableItemStyle AlternatingTimeStyle { get; }Use the AlternatingTimeStyle property to provide a custom style for the alternating time cells in the RadTimeView control. Common style attributes that can be adjusted include foreground color, background color, font, and content alignment within the cell. Providing a different style enhances the appearance of the RadTimeView control.
If you specify a red font for the TimeStyle property, all other item style properties in the RadTimeView control will also have a red font. This allows you to provide a common appearance for the control by setting a single item style property. You can override the inherited style settings for an item style property that is higher in the hierarchy by setting its style properties. For example, you can specify a blue font for the AlternatingTimeStyle property, overriding the red font specified in the TimeStyle property.
To specify a custom style for the alternating items, place the <AlternatingTimeStyle> tags between the opening and closing tags of the RadTimeView control. You can then list the style attributes within the opening <AlternatingTimeStyle> tag.
Gets or sets the template for alternating time cells in the RadTimeView.
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public ITemplate AlternatingTimeTemplate { get; set; }Use the AlternatingTimeTemplate property to control the contents of alternating items in the RadTimeView control. The appearance of alternating time cells is controlled by the AlternatingTimeStyle property.
To specify a template for the alternating time cells, place the <AlternatingTimeTemplate> tags between the opening and closing tags of the RadTimeView control. You can then list the contents of the template between the opening and closing <AlternatingTimeTemplate> tags.
Gets or sets the background color of the RadTimeView control.
public override Color BackColor { get; set; }Overrides:
Use the BackColor property to specify the background color of the RadTimeView control. This property is set using a System.Drawing.Color object.
In general, only controls that render as a <table> tag can display a background color in HTML 3.2, whereas almost any control can in HTML 4.0.
For controls that render as a <span> tag (including Label, all validation controls, and list controls with their RepeatLayout property set to RepeatLayout.Flow), this property will work in Microsoft Internet Explorer version 5 or later, but not for Microsoft Internet Explorer version 4.
Gets or sets the border color of the RadTimeView control.
public override Color BorderColor { get; set; }A System.Drawing.Color that represents the border color of the control. The default is Color.Empty, which indicates that this property is not set.
Overrides:
Use the BorderColor property to specify the border color of the RadTimeView control. This property is set using a System.Drawing.Color object.
Gets or sets the border style of the RadTimeView control.
public override BorderStyle BorderStyle { get; set; }One of the BorderStyle enumeration values. The default is NotSet.
Overrides:
Use the BorderStyle property to specify the border style for the RadTimeView control. This property is set using one of the BorderStyle enumeration values. The following table lists the possible values.
Border Style Description NotSet The border style is not set. None No border Dotted A dotted line border. Dashed A dashed line border. Solid A solid line border. Double A solid double line border. Groove A grooved border for a sunken border appearance. Ridge A ridged border for a raised border appearance. Inset An inset border for a sunken control appearance. Note: This property will not render on some browsers.
Gets or sets the border width of the RadTimeView control.
public override Unit BorderWidth { get; set; }A Unit that represents the border width of a RadTimeView control. The default value is Unit.Empty, which indicates that this property is not set.
Overrides:
Use the BorderWidth property to specify a border width for a control.
This property is set with a Unit object. If the Value property of the Unit contains a negative number, an exception is thrown.
Gets or sets the caption for the table RadTimeView.
public virtual string Caption { get; set; }The default value is "RadTimeView".
Setting this property to empty string will force Telerik RadTimeView to not render caption tag.
Gets or sets the alignment of the associated caption.
[Bindable(true)]
public virtual TableCaptionAlign CaptionAlign { get; set; }Gets or sets the amount of space between the contents of the cell and the cell's border.
[Bindable(true)]
public virtual int CellPadding { get; set; }The distance (in pixels) between the contents of a cell and the cell's border. The default is -1, which indicates that this property is not set.
Use the CellPadding property to control the spacing between the contents of a cell and the cell's border. The padding amount specified is added to all four sides of a cell.
All cells in the same column of a data listing control share the same cell width. Therefore, if the content of one cell is longer than the content of other cells in the same column, the padding amount is applied to the widest cell. All other cells in the column are also set with this cell width.
Similarly, all cells in the same row share the same height. The padding amount is applied to the height of the tallest cell in the row. All other cells in the same row are set with this cell height. Individual cell sizes cannot be specified.
The value of this property is stored in view state.
Gets or sets the distance between time cells of the RadTimeView.
[Bindable(true)]
public virtual int CellSpacing { get; set; }The distance (in pixels) between table cells. The default is -1, which indicates that this property is not set.
Use the CellSpacing property to control the spacing between adjacent cells in a data listing control. This spacing is applied both vertically and horizontally. The cell spacing is uniform for the entire data list control. Individual cell spacing between each row or column cannot be specified.
The value of this property is stored in view state.
Gets or sets the number of columns to display in the RadTimeView control.
[Bindable(true)]
[ClientControlProperty]
public virtual int Columns { get; set; }Use this property to specify the number of columns that display items in the RadTimeView control. For example, if you set this property to 5, the RadTimeView control displays its items in five columns.
Gets or sets the cascading style sheet (CSS) class rendered by the RadTimeView on the client.
public override string CssClass { get; set; }The CSS class rendered by the RadTimeView control on the client. The default is String.Empty.
Overrides:
Use the CssClass property to specify the CSS class to render on the client for the RadTimeView control. This property will render on browsers for all controls. It will always be rendered as the class attribute, regardless of the browser.
For example, suppose you have the following RadTimeVeiw control declaration:
<asp:TextBox id="TextBox1" ForeColor="Red" CssClass="class1" />
The following HTML is rendered on the client for the previous RadTimeView control declaration:
Provides information about a specific culture. The information includes the names for the culture, the writing system, the calendar used, and formatting for the times.
[TypeConverter(typeof(CultureInfoConverter))]
public virtual CultureInfo Culture { get; set; }The CultureInfo class renders culture-specific information, such as the associated language, sublanguage, country/region, calendar, and cultural conventions. This class also provides access to culture-specific instances of DateTimeFormatInfo, NumberFormatInfo, CompareInfo, and TextInfo. These objects contain the information required for culture-specific operations, such as casing, formatting dates and numbers, and comparing strings.
Gets or sets the custom time values to be displayed in the time picker
[Browsable(false)]
public object CustomTimeValues { get; set; }Gets a data bound list control that displays items using templates.
[Browsable(false)]
public DataList DataList { get; }When set to true enables support for WAI-ARIA
public bool EnableAriaSupport { get; set; }Gets or sets a value indicating whether the Web server control is enabled.
public override bool Enabled { get; set; }true if control is enabled; otherwise, false. The default is true.
Overrides:
Gets or sets the enable client side navigation with keyboard.
public bool EnableKeyboardNavigation { get; set; }The enable client side navigation with keyboard.
Gets or sets a value indicating whether themes apply to this control.
public override bool EnableTheming { get; set; }true to use themes; otherwise, false. The default is true.
Exceptions: InvalidOperationExceptionThe Page_PreInit event has already occurred.- or -The control has already been added to the Controls collection.
Overrides:
Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
public override bool EnableViewState { get; set; }true if the server control maintains its view state; otherwise false. The default is true.
Overrides:
ite
[Bindable(true)]
[ClientControlProperty]
public virtual TimeSpan EndTime { get; set; }Gets the font properties associated with the RadTimeView control.
public override FontInfo Font { get; }A FontInfo that represents the font properties of the Web server control.
Overrides:
Use the Font property to specify the font properties of the RadTimeView control. This property includes subproperties that can be accessed declaratively in the form of Property-Subproperty (for example Font-Bold) or programmatically in the form of Property.Subproperty (for example Font.Bold).
Gets the style properties for the footer section of the RadTimeView control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual TableItemStyle FooterStyle { get; }Use this property to provide a custom style for the footer section of the radTimeView control. Common style attributes that can be adjusted include foreground color, background color, font, and content alignment within the cell. Providing a different style enhances the appearance of the RadTimeView control.
The FooterStyle property of the RadTimeView control inherits the style settings of the ControlStyle property. For example, if you specify a red font for the ControlStyle property, the FooterStyle property will also have a red font. This allows you to provide a common appearance for the control by setting a single style property. You can override the inherited style settings by setting the FooterStyle property. For example, you can specify a blue font for the FooterStyle property, overriding the red font specified in the ControlStyle property.
To specify a custom style for the footer section, place the <FooterStyle> tags between the opening and closing tags of the RadTimeView control. You can then list the style attributes within the opening <FooterStyle> tag.
Note: The ShowFooter property must be set to true for this property to be visible.
Gets or sets the template for the footer section of the RadTimeView control.
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public ITemplate FooterTemplate { get; set; }To specify a template for the footer section, place the <FooterTemplate> tags between the opening and closing tags of the RadTimeView control. You can then list the contents of the template between the opening and closing <FooterTemplate> tags.
The ShowFooter property must be set to true for this property to be visible.
Gets or sets the foreground color (typically the color of the text) of the RadTimeView control.
public override Color ForeColor { get; set; }A System.Drawing.Color that represents the foreground color of the control. The default is Color.Empty.
Overrides:
Use the ForeColor property to specify the foreground color of the RadTimeView control. The foreground color is usually the color of the text. This property will render on browsers earlier than Microsoft Internet Explorer version 4.
Note: On browsers that do not support styles, this property is rendered as a FONT element.
Gets or sets a value that specifies whether the border between the cells of the RadTimeView control is displayed.
[Bindable(true)]
public virtual GridLines GridLines { get; set; }One of the GridLines enumeration values. The default is Both.
Gets the style properties for the heading section of the RadTimeView control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual TableItemStyle HeaderStyle { get; }Use this property to provide a custom style for the heading of the RadTimeView control. Common style attributes that can be adjusted include foreground color, background color, font, and content alignment within the cell. Providing a different style enhances the appearance of the RadTimeView control.
To specify a custom style for the heading section, place the <HeaderStyle> tags between the opening and closing tags of the RadTimeView control. You can then list the style attributes within the opening <HeaderStyle> tag.
Note: The ShowHeader property must be set to true for this property to be visible.
Gets or sets the template for the heading section of the RadTimeView control.
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public ITemplate HeaderTemplate { get; set; }Use the HeaderTemplate property to control the contents of the heading section. The appearance of the header section is controlled by the HeaderStyle property.
To specify a template for the heading section, place the <HeadingTemplate> tags between the opening and closing tags of the RadTimeView control. You can then list the contents of the template between the opening and closing <HeadingTemplate> tags.
The ShowHeader property must be set to true for this property to be visible.
Gets or sets the header associated with the RadTimeView control.
[Bindable(true)]
public virtual string HeaderText { get; set; }Use HeaderText when UseAccessibleHeader is set to true
Gets or sets the height of the RadTimeView control.
public override Unit Height { get; set; }A Unit that represents the height of the RadTimeView control. The default is Empty.
Overrides:
Use the Height property to specify the height of the RadTimeView control.
Gets or sets the horizontal alignment of the RadTimeView control.
[Bindable(true)]
public virtual HorizontalAlign HorizontalAlign { get; set; }One of the HorizontalAlign enumeration values. The default is NotSet.
Use the HorizontalAlign property to specify the horizontal alignment of the data list control within its container. This property is set with one of the HorizontalAlign enumeration values.
Gets or sets the interval between StartTime and EndTime
[Bindable(true)]
[ClientControlProperty]
public virtual TimeSpan Interval { get; set; }Occurs on the client when an time sell in the RadTimeView control is selected.
[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("clientTimeSelected")]
public virtual string OnClientTimeSelected { get; set; }The default value is String.Empty
Occurs on the client when a time cell in RadTimeView is about to be selected
[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("clientTimeSelecting")]
public virtual string OnClientTimeSelecting { get; set; }The default value is String.Empty
Gets or sets DataList ReapeatDirection
[Browsable(true)]
public RepeatDirection RenderDirection { get; set; }Gets or sets a value indicating whether the footer section is displayed in the RadTimeView control.
[Bindable(true)]
[ClientControlProperty]
public virtual bool ShowFooter { get; set; }true if the footer section is displayed; otherwise, false. The default value is true, however this property is only examined when the FooterTemplate property is not a null reference (Nothing in Visual Basic).
Use the ShowFooter property to specify whether the footer section is displayed in the RadTimeView control.
You can control the appearance of the footer section by setting the FooterStyle property. The contents of the footer section are controlled by the FooterTemplate property.
Gets or sets a value indicating whether the header section is displayed in the RadTimeView control.
[Bindable(true)]
[ClientControlProperty]
public virtual bool ShowHeader { get; set; }true if the header is displayed; otherwise, false. The default value is true, however this property is only examined when the HeaderTemplate property is not a null reference (Nothing in Visual Basic).
Use the ShowHeader property to specify whether the header section is displayed in the RadTimeView control.
You can control appearance of the header section by setting the HeaderStyle property. The contents of the header section are controlled by the HeaderTemplate property.
Gets or sets the skin to apply to the control.
public override string SkinID { get; set; }The name of the skin to apply to the control. The default is Empty.
Exceptions: ArgumentExceptionThe skin specified in the SkinID property does not exist in the theme.
Overrides:
Gets or sets the start time of the control.
[Bindable(true)]
[ClientControlProperty]
public virtual TimeSpan StartTime { get; set; }Gets or sets the summary attribute for the RadTimeView.
public virtual string Summary { get; set; }The default value is "Table holding time picker for selecting time of day.".
Setting this property to empty string will force Telerik RadTimeView to not render summary attribute.
protected override bool SupportsRenderingMode { get; }Overrides:
Gets or sets the tab index of the Web server control.
public override short TabIndex { get; set; }The tab index of the Web server control. The default is 0, which indicates that this property is not set.
Exceptions: ArgumentOutOfRangeExceptionThe specified tab index is not between -32768 and 32767.
Overrides:
protected override HtmlTextWriterTag TagKey { get; }Overrides:
Gets or sets the format of the time.
[Bindable(true)]
public virtual string TimeFormat { get; set; }A custom Time format string consists of one or more custom Time format specifiers, and that format string defines the text representation of a DateTime object that is produced by a formatting operation.
Custom Time format specifiers.
h Represents the hour as a number from 1 through 12, that is, the hour as represented by a 12-hour clock that counts the whole hours since midnight or noon. Consequently, a particular hour after midnight is indistinguishable from the same hour after noon. The hour is not rounded, and a single-digit hour is formatted without a leading zero. For example, given a time of 5:43, this format specifier displays "5". For more information about using a single format specifier, see Using Single Custom Format Specifiers. hh, hh (plus any number of additional "h" specifiers) Represents the hour as a number from 01 through 12, that is, the hour as represented by a 12-hour clock that counts the whole hours since midnight or noon. Consequently, a particular hour after midnight is indistinguishable from the same hour after noon. The hour is not rounded, and a single-digit hour is formatted with a leading zero. H Represents the hour as a number from 0 through 23, that is, the hour as represented by a zero-based 24-hour clock that counts the hours since midnight. A single-digit hour is formatted without a leading zero. HH, HH (plus any number of additional "H" specifiers) Represents the hour as a number from 00 through 23, that is, the hour as represented by a zero-based 24-hour clock that counts the hours since midnight. A single-digit hour is formatted with a leading zero. m Represents the minute as a number from 0 through 59. The minute represents whole minutes passed since the last hour. A single-digit minute is formatted without a leading zero. mm, mm (plus any number of additional "m" specifiers) Represents the minute as a number from 00 through 59. The minute represents whole minutes passed since the last hour. A single-digit minute is formatted with a leading zero. s Represents the seconds as a number from 0 through 59. The second represents whole seconds passed since the last minute. A single-digit second is formatted without a leading zero. ss, ss (plus any number of additional "s" specifiers) Represents the seconds as a number from 00 through 59. The second represents whole seconds passed since the last minute. A single-digit second is formatted with a leading zero. t Represents the first character of the A.M./P.M. designator defined in the current System.Globalization.DateTimeFormatInfo.AMDesignator or System.Globalization.DateTimeFormatInfo.PMDesignator property. The A.M. designator is used if the hour in the time being formatted is less than 12; otherwise, the P.M. designator is used. tt, tt (plus any number of additional "t" specifiers) Represents the A.M./P.M. designator as defined in the current System.Globalization.DateTimeFormatInfo.AMDesignator or System.Globalization.DateTimeFormatInfo.PMDesignator property. The A.M. designator is used if the hour in the time being formatted is less than 12; otherwise, the P.M. designator is used.
Standard Time Format Specifiers
t ShortTimePattern - For example, the custom format string for the invariant culture is "HH:mm". T LongTimePattern - For example, the custom format string for the invariant culture is "HH:mm:ss".
Gets the style applied to items
[PersistenceMode(PersistenceMode.InnerProperty)]
public TableItemStyle TimeOverStyle { get; }The style applied to items.
Gets the style properties for the time cells in the RadTimeView control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual TableItemStyle TimeStyle { get; }Use this property to provide a custom style for the items of the RadTimeView control. Common style attributes that can be adjusted include foreground color, background color, font, and content alignment within the cell. Providing a different style enhances the appearance of the RadTimeView control.
If you specify a red font for the TimeStyle property, all other item style properties in the RadTimeView control will also have a red font. This allows you to provide a common appearance for the control by setting a single item style property. You can override the inherited style settings for an item style property that is higher in the hierarchy by setting its style properties. For example, you can specify a blue font for the AlternatingTimeStyle property, overriding the red font specified in the TimeStyle property.
To specify a custom style for the items of the RadTimeView control, place the <TimeStyle> tags between the opening and closing tags of the RadTimeView control. You can then list the style attributes within the opening <TimeStyle> tag.
You can also use the AlternatingTimeStyle property to provide a different appearance for the alternating items in the RadTimeView control.
Gets or sets the template for the heading section of the RadTimeView control.
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public ITemplate TimeTemplate { get; set; }Use the HeaderTemplate property to control the contents of the heading section. The appearance of the header section is controlled by the HeaderStyle property.
To specify a template for the heading section, place the <HeadingTemplate> tags between the opening and closing tags of the RadTimeView control. You can then list the contents of the template between the opening and closing <HeadingTemplate> tags.
The ShowHeader property must be set to true for this property to be visible.
Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
public override string ToolTip { get; set; }The text displayed when the mouse pointer hovers over the Web server control. The default is Empty.
Overrides:
Indicates that the control should use accessible header cells in its containing table control.
[Bindable(true)]
public virtual bool UseAccessibleHeader { get; set; }Gets or sets a value indicating whether the TimeView should use client time zone offset for the values bound to a custom collection.
protected virtual bool UseClientTimeOffset { get; set; }The default value is false.
Setting this property to true will make the timeview to convert its values from UTC to the current user time zone.
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
public override bool Visible { get; set; }true if the control is visible on the page; otherwise false.
Overrides:
Methods
protected virtual void CalculateTimeCollection()protected override void CreateChildControls()Overrides:
Binds a data source to the invoked server control and all its child controls.
public override void DataBind()Overrides:
protected override void DescribeClientEvents(IScriptDescriptor descriptor)Overrides:
protected override void DescribeClientProperties(IScriptDescriptor descriptor)Overrides:
protected override void DescribeComponent(IScriptDescriptor descriptor)Overrides:
protected virtual void DescribeProperties(IScriptDescriptor descriptor)Returns a collection of custom attributes for this instance of a component.
public AttributeCollection GetAttributes()An AttributeCollection containing the attributes for this object.
Implements:
Returns the class name of this instance of a component.
public string GetClassName()The class name of the object, or null if the class does not have a name.
Implements:
Returns the name of this instance of a component.
public string GetComponentName()The name of the object, or null if the object does not have a name.
Implements:
Returns a type converter for this instance of a component.
public TypeConverter GetConverter()A TypeConverter that is the converter for this object, or null if there is no TypeConverter for this object.
Implements:
Returns the default event for this instance of a component.
public EventDescriptor GetDefaultEvent()An EventDescriptor that represents the default event for this object, or null if this object does not have events.
Implements:
Returns the default property for this instance of a component.
public PropertyDescriptor GetDefaultProperty()A PropertyDescriptor that represents the default property for this object, or null if this object does not have properties.
Implements:
Returns an editor of the specified type for this instance of a component.
Returns the events for this instance of a component.
public EventDescriptorCollection GetEvents()An EventDescriptorCollection that represents the events for this component instance.
Implements:
Returns the events for this instance of a component using the specified attribute array as a filter.
public EventDescriptorCollection GetEvents(Attribute[] attributes)An array of type Attribute that is used as a filter.
Returns:An EventDescriptorCollection that represents the filtered events for this component instance.
Implements:
Returns the properties for this instance of a component.
public PropertyDescriptorCollection GetProperties()A PropertyDescriptorCollection that represents the properties for this component instance.
Implements:
Returns the properties for this instance of a component using the attribute array as a filter.
public PropertyDescriptorCollection GetProperties(Attribute[] attributes)An array of type Attribute that is used as a filter.
Returns:A PropertyDescriptorCollection that represents the filtered properties for this component instance.
Implements:
Returns an object that contains the property described by the specified property descriptor.
public object GetPropertyOwner(PropertyDescriptor pd)A PropertyDescriptor that represents the property whose owner is to be found.
Returns:An object that represents the owner of the specified property.
Implements:
Restores view-state information from a previous page request that was saved by the SaveViewState() method.
protected override void LoadViewState(object savedState)The saved view state.
Overrides:
protected void PopulateDateTimeValues()protected void PopulateStandard()protected void PopulateStringValues()protected void PopulateTimeSpanValues()Saves any server control view-state changes that have occurred since the time the page was posted back to the server.
protected virtual void SetStyleClasses()protected override void TrackViewState()Overrides: