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

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

Writes the current date or a date from an EPT-field into to the supplied stream or the default response stream. The ShowDate class acts as the underlying engine for the Show Date and Insert Date Content Studio components. .
Inheritance Hierarchy

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

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 ShowDate : DateBase

The ShowDate type exposes the following members.

Constructors

  NameDescription
Public methodShowDate
Constructs a new instance of the Show date class that writes to the default response stream
Public methodShowDate(Stream)
Constructs a new instance of the Show date class that writes to the supplied stream
Public methodShowDate(MasterPageBase)
Constructs a new instance of the Show date class that writes to the supplied stream
Public methodShowDate(SiteBase)
Constructs a new instance of the Show date class that writes to the supplied stream
Public methodShowDate(UserControlBase)
Constructs a new instance of the Show date class that writes to the supplied stream
Public methodShowDate(Stream, SiteBase)
Constructs a new instance of the Show date class that writes to the supplied stream
Public methodShowDate(Stream, UserControlBase)
Constructs a new instance of the Show date class that writes to the supplied stream
Public methodShowDate(Stream, SiteBase, UserControlBase)
Constructs a new instance of the Show date class that writes to the supplied stream
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 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 propertyCustomFormat
Sets or gets a value that indicates a format string to use with the custom date format. For a more information on the different time format strings see the System.Globalization.DateTimeFormatInfo class documentation. The default value is G which displays a combination of the short date and long time patterns, separated by a space.
Public propertyDateFormat
Sets or gets a value that indicates the format to use. The default value is DateFormats.Format1
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 propertyEPTFieldName
Sets or gets a value that contains a field that contains a date/time value. The default value is an empty string which forces the component to use the current date/time. If this property is specified and the field does not exist or the field does not contain a value that can be interpreted as a DateTime, nothing is written.
Top
Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke
Invokes the component and writes its content into the specified stream
Public methodToString (Inherited from Object.)
Top
Remarks

To use this class, create an instance of this object, set up the properties and call the Invoke method with an appropriate set of parameters. This class can throw exceptions, thus your code should be wrapped within try/catch statements in order to avoid the entire page to crash. This class generates inline code, thus you must wrap it into a block element to make the page validate according to the HTML/XHTML regulations. The generated code is fully HTML/XHTML strict compatible.
See Also

Reference