Eclipse BIRT Report Object Model (ROM)

StringFormatValue Structure

Structure Overview

Used to format a string value.

Details

Display Name: String Format Value
Since: 1.0

Property Summary

category
Provides a list of pre-defined string formatter, upper, lower, zipCode, etc.
locale
pattern
Pattern of the formatter.

Description

Provides a set of pre-defined string formatter, or user can define a customized formatter given a pattern.

Property Detail

category Property

Provides a list of pre-defined string formatter, upper, lower, zipCode, etc.

Details

Type: choice (stringFormat)
Since: 1.0
Required: No
Display Name: Category
JavaScript Type:
Default Value: None
Runtime Settable: Yes

Choices

NameDisplay Name ValueDescription
Unformatted Unformatted Unformatted
> Uppercase >
< Lowercase <
Zip Code Zip Code Zip Code
Zip Code + 4 Zip Code + 4 Zip Code + 4
Phone Number Phone Number Phone Number
Social Security Number Social Security Number Social Security Number
Custom Custom Custom

Description

Allow user to choose from a list of pre-defined string formatter. Use a certain formatter to convert a "string" typed value using the given formatter.


locale Property

Details

Type: locale
Since: 2.5
Required: No
Display Name: Locale
JavaScript Type:
Default Value: None
Runtime Settable: Yes

pattern Property

Pattern of the formatter.

Details

Type: string
Since: 1.0
Required: No
Display Name: Pattern
JavaScript Type:
Default Value: None
Runtime Settable: Yes

Description

Pattern of the string time formatter.