TimePicker Class Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Displays a dropdown control that allows the user to select a time.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingDateBase
        ContentStudio.Site.ActiveScripting.DateTimePicker

Namespace: ContentStudio.Site.ActiveScripting.Date
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public sealed class TimePicker : DateBase

The TimePicker type exposes the following members.

Constructors

  NameDescription
Public methodTimePicker
Constructs a new Time picker with a specified unique identifier
Top
Properties

  NameDescription
Public propertyBackwardsComponentCompatibilityMode
Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.)
Public propertyBlankStartText
Sets or gets the text to be displayed in the non time alternative in the generated dropdown. This value is ignored if UseBlankStart is false. The default value is an empty string.
Public propertyComponentName
Gets the name of the component.
(Overrides ActiveScriptingBaseComponentName.)
Public propertyConformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
Public propertyElementType
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.)
Public propertyEncoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Public propertyInterval
Sets or gets the interval in minutes between each selectable time value. This value can be between 1 and 1440. The default value is 10.
Public propertyRoundMode
Determines how the component determines the inital select value in relation to the init time. The default value is TimeRoundMode.AlwaysUp.
Public propertySelectedHour
Specifies the hour part of the specified time in the 24 hours format. This value can be between 0 and 23. The default value is the hour of the current time.
Public propertySelectedMinute
Specifies the minute part of the specific time. This value can be between 0 and 59. The default value is the minute of the current time.
Public propertyTimeFormat
Sets or gets A string to use to format the time value displayed in the drop down. However the actual submitted value is always in the international 24 hour format. For a more information on the different time format strings see the System.Globalization.DateTimeFormatInfo class documentation. The default value is t which specifies the short time format of the system;
Public propertyUseBlankStart
Sets or gets a value that forces the component to insert a non time alternative. This enables the user to select a blank time value. The default value is false.
Public propertyUseSpecificTime
Initialize the component with a specific time rather than the current time The default value is false.
Top
Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke
Invokes the time picker and returns a dropdown control.
Public methodToString (Inherited from Object.)
Top
Remarks

If you are using more that one time Picker on one page you must ensure that each one are given a unique name or an error will occur.
See Also

Reference