![]() ![]() |
The Text element displays a multi-line block of text defined within the report. This element can contain embedded formatting and value expressions.
The Text item allows the report developer to provide the text as part of the report design. Text can be in HTML or plain text format and can be localized. HTML text can contain placeholders for data and expressions, much like the mail merge feature of a word processing program.
The Text item provides the ability to do the following things:
DesignElement->ReportElement->ReportItem
bookmark, comments, customXml, dataSet, extends, height, name, paramBindings, style, userProperties
backgroundColor, backgroundImage, borderBottomColor, borderBottomStyle, borderBottomWidth, borderLeftColor, borderLeftStyle, borderLeftWidth, borderRightColor, borderRightStyle, borderRightWidth, borderTopColor, borderTopStyle, borderTopWidth, canShrink, color, dateTimeFormat, display, fontFamily, fontSize, fontStyle, fontVariant, fontWeight, highlightRules, highlightTestExpr, letterSpacing, lineHeight, mapRules, mapTestExpr, marginBottom, marginLeft, marginRight, marginTop, masterPage, numberAlign, numberFormat, orphans, paddingBottom, paddingLeft, paddingRight, paddingTop, pageBreakAfter, pageBreakBefore, pageBreakInside, showIfBlank, stringFormat, textAlign, textIndent, textLineThrough, textOverline, textTransform, textUnderline, verticalAlign, whiteSpace, widows, wordSpacing
None
None
The following sections describe the properties of the Text element.
The text for the item. The text can be externalized
A resource ID for this value, used for externalizing the value of this string.
The formatting within the text. You can explicitly identify the format of the text using the ContentType property. If this property is set to auto or omitted, BIRT infers the format from the text.
BIRT determines the text format by examining the first few characters of the string. If the beginning of the string is <HTML>, the string is assumed to be HTML. Otherwise, the text is plain text.
The following table itemizes the choices for this property.
Name
|
Display Name
|
Value
|
Description
|
---|---|---|---|
auto
|
Auto
|
auto
|
BIRT infers the format
|
plain
|
Plain
|
plain
|
Plain text with no formatting
|
html
|
HTML
|
html
|
Formatting using a subset of HTML tags
|
The following sections describe the methods of the Text element.
The method that BIRT executes to handle the onCreate event for this element. The onCreate method executes every time the element is generated. Use the onCreate method to perform tasks that are data dependent.
The method that BIRT executes to handle the onPrepare event for this element. the onPrepare method executes once prior to the generation of the report. Use onPrepare method to perform tasks that affect the appearance of the element for every occurrence in the report.
The method that BIRT executes to handle the onRender event for this element. The onRender method executes at run time and not at generation time. Use the onRender method to perform tasks that are dependent on the run time details. Examples of run time factors that might require special handling include the run time environment, the user requesting the report, the parameter values in effect when the report is run, and whether the report is produced in HTML or PDF format.
![]() ![]() |