Eclipse BIRT Report Object Model (ROM)

AbstractScalarParameter Element

Element Overview

Details

Display Name:	Abstract ScalarParameter
Since:	2.5
XML Element:	`None`
Extends:	Parameter
Extendable:	No
Abstract:	Yes
Name Space:	Parameters
Name Requirement:	Optional
Allows User Properties:	Yes
Has Style:	No

Property Summary

dataSetName
dataType
defaultValue
isRequired
labelExpr
listLimit
selectionList
sortBy
sortByColumn
sortDirection
valueExpr
valueType

Inherited Properties

comments, customXml, displayName, displayNameID, eventHandlerClass, extends, helpText, helpTextID, hidden, name, newHandlerOnEachEvent, promptText, promptTextID, propertyMasks, userProperties, viewAction

Inherited Methods

Property Detail

dataSetName Property

Details

Type:	DataSet Reference
Since:	2.0
Required:	No
Display Name:	DataSet Name
JavaScript Type:
Default Value:	None
Inherited:	Yes
Runtime Settable:	No
Property Sheet Visibility:	Visible
Property Sheet Group:	Dynamic list

dataType Property

Details

Type:	choice (paramType)
Since:	1.0
Required:	No
Display Name:	Data type
JavaScript Type:
Default Value:	string
Inherited:	Yes
Runtime Settable:	No
Property Sheet Visibility:	Visible
Property Sheet Group:	Top

Choices

Name	Display Name	Value	Description
string	String	string
float	Float	float
decimal	Decimal	decimal
dateTime	Date Time	dateTime
boolean	Boolean	boolean
integer	Integer	integer
date	Date	date
time	Time	time

defaultValue Property

Details

Type:	list
Since:	1.0
Required:	No
Display Name:	Default value
JavaScript Type:
Default Value:	None
Inherited:	Yes
Runtime Settable:	No
Property Sheet Visibility:	Visible
Property Sheet Group:	Top

isRequired Property

Details

Type:	boolean
Since:	2.2
Required:	No
Display Name:	Is required
JavaScript Type:
Default Value:	true
Inherited:	Yes
Runtime Settable:	No
Property Sheet Visibility:	Visible
Property Sheet Group:	Top

labelExpr Property

Details

Type:	expression
Context:
Expression Type:	string
Since:	2.0
Required:	No
Display Name:	Label expression
JavaScript Type:
Default Value:	None
Inherited:	Yes
Runtime Settable:	No
Property Sheet Visibility:	Visible
Property Sheet Group:	Dynamic list

listLimit Property

Details

Type:	integer
Since:	2.0
Required:	No
Display Name:	List limit
JavaScript Type:
Default Value:	None
Inherited:	Yes
Runtime Settable:	No
Property Sheet Visibility:	Visible
Property Sheet Group:	Top

selectionList Property

Details

Type:	List of SelectionChoice Structures
Since:	1.0
Required:	No
Display Name:	Selection list
JavaScript Type:
Default Value:	None
Inherited:	Yes
Runtime Settable:	No
Property Sheet Visibility:	Hidden
Property Sheet Group:	Top

sortBy Property

Details

Type:	choice (paramSortValues)
Since:	2.2
Required:	No
Display Name:	Sort by
JavaScript Type:
Default Value:	None
Inherited:	Yes
Runtime Settable:	No
Property Sheet Visibility:	Visible
Property Sheet Group:	Top

Choices

Name	Display Name	Value	Description
value	Value	value
label	Display Text	label

sortByColumn Property

Details

Type:	expression
Context:
Expression Type:	None
Since:	2.3
Required:	No
Display Name:	Sort by column
JavaScript Type:
Default Value:	None
Inherited:	Yes
Runtime Settable:	No
Property Sheet Visibility:	Visible
Property Sheet Group:	Top

sortDirection Property

Details

Type:	choice (sortDirection)
Since:	2.2
Required:	No
Display Name:	Sort direction
JavaScript Type:
Default Value:	None
Inherited:	Yes
Runtime Settable:	No
Property Sheet Visibility:	Visible
Property Sheet Group:	Top

Choices

Name	Display Name	Value	Description
asc	Ascending	asc
desc	Descending	desc

valueExpr Property

Details

Type:	expression
Context:
Expression Type:	any
Since:	2.0
Required:	No
Display Name:	Value expression
JavaScript Type:
Default Value:	None
Inherited:	Yes
Runtime Settable:	No
Property Sheet Visibility:	Visible
Property Sheet Group:	Dynamic list

valueType Property

Details

Type:	choice (paramValueType)
Since:	2.0
Required:	No
Display Name:	Value type
JavaScript Type:
Default Value:	static
Inherited:	Yes
Runtime Settable:	No
Property Sheet Visibility:	Visible
Property Sheet Group:	Top

Choices

Name	Display Name	Value	Description
static	Static	static
dynamic	Dynamic	dynamic