userFormat

userFormat(fmt: DateFormat): String;

The userFormat method of the Date primitive type returns a string containing the receiver in the supplied date format.

To define your date formats, use the Schema menu Format command from the Schema Browser.

When you use a format in a JADE method, prefix your user date format name with a dollar sign ($); for example, userFormat($MyDate).

You can use the defineLongDateFormat or defineShortDateFormat method of the DateFormat class if you want to create your own transient format objects and define a long or short date format that dynamically overrides the appropriate format for the locale at run time. (For details, see Chapter 1 of the JADE Encyclopaedia of Classes.)

If you do not define the EnhancedLocaleSupport parameter in the [JadeEnvironment] section of the JADE initialization file on the database node or you set it to false, inconsistent results could be returned to the application server when running in JADE thin client mode and there are locale overrides, as all overrides on the application server are suppressed if enhanced locale support is not enabled. Formatting of locale data is done on the application server, based on the locale of the corresponding presentation client.

In the Windows Environment, the userFormat method returns "*invalid*" for dates before 1601 or after 30827.