BackPrevious Topic  Next TopicNext

DBField Properties

This topic describes the properties of a DBField object.

Designer provides some properties only when you use the object in certain report types. You can get details from the Available For column in the property table.

Property Name Available For Description
General
Column Query Page Report Shows the column name of the field in the raw database. This property is read only.
Data Type Query Page Report Shows the data type of the field. This property is read only.
DBField Name Page Report, Web Report, Library Component Shows the mapping name of the field in the catalog. This property is read only.
Field Type Query Page Report Shows what kind of field it is. This property is read only.
Instance Name Query Page Report Shows the instance name of the object. This property is read only.
Query Query Page Report Shows the name of the query containing the field. This property is read only.
Table Query Page Report Shows the table name of the field in the raw database. This property is read only.
Geometry (not available when the DBField is a crosstab column/row field or in a heat map)
Height Page Report, Web Report, Library Component Specifies the height of the object. Type a numeric value to change the height.

Data type: Float

Width Page Report, Web Report, Library Component Specifies the width of the object. Type a numeric value to change the width.

Data type: Float

X Page Report, Web Report, Library Component Specifies the horizontal coordinate of the top left corner of the object, relative to its parent container. Designer ignores this property if the object's Position is "static". Type a numeric value to change the position.

Data type: Float

Note icon This property is read only when the DBField is an aggregate field in a crosstab.
Y Page Report, Web Report, Library Component Specifies the vertical coordinate of the top left corner of the object, relative to its parent container. Designer ignores this property if the object's Position is "static". Type a numeric value to change the position.

Data type: Float

Note icon This property is read only when the DBField is an aggregate field in a crosstab.
Color
Background Page Report, Web Report, Library Component Specifies the background color of the object. Choose a color from the drop-down list or select Custom to customize a color in the Pick a Color dialog box, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For a page report, you can also use a formula or edit an expression to return a color.

Data type: String
Foreground Page Report, Web Report, Library Component Specifies the foreground color of the object. Choose a color from the drop-down list or select Custom to customize a color in the Pick a Color dialog box, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For a page report, you can also use a formula or edit an expression to return a color.

Data type: String
CSS
Class Page Report, Web Report, Library Component Specifies the name of the Class Selector to apply to the object, which you define in the CSS file of the style the report applies.

For example, if you define the CSS file as follows:

@charset "GBK";
TextField {Background: #ff0000}
/*Style=LabelX*/
TextField[Style="LabelX"]{Background: #0000FF}
/*ID=W*/
TextField#W{Background: #FFFF00}
/*class=C*/
TextField.C{Background: #00FFFF}

To apply the Class Selector in the file to the object, type C in the value cell.

Data type: String
ID Page Report, Web Report, Library Component Specifies the name of the ID Selector to apply to the object, which you define in the CSS file of the style the report applies. For example, to apply the ID Selector in the above sample CSS file to the object, type W in the value cell.

Data type: String
Style Page Report, Web Report, Library Component Specifies the style you want to apply to the object. You can specify the style in two ways:
  • Type the style which should be an Attribute Selector whose attribute is "style" in the CSS file of the style the report applies. For example, to apply the style in the above sample CSS file to the object, type LabelX in the value cell.
  • Choose a style from the drop-down list if you have specified the Style Group property for the report tab or web report, and there are styles in the style group that are applicable to the object.

Data type: String
Excel (not available when the DBField is in a crosstab)
Column Index Page Report, Web Report Specifies the X coordinate of the object relative to its parent container in the Excel and CSV outputs of the report, measured in cells. This property takes effect only when the Columned property of the report tab or web report is "true" and Position of the object is not "static".

Data type: Integer
Row Index Page Report, Web Report Specifies the Y coordinate of the object relative to its parent container in the Excel and CSV outputs of the report, measured in cells. This property takes effect only when the Columned property of the report tab or web report is "true" and Position of the object is not "static".

Data type: Integer
Padding (not available when the DBField is in a crosstab or heat map)
Bottom Padding Page Report, Web Report, Library Component Specifies the space between the content in the object and the bottom border of the object. Type a numeric value to change the padding.

Data type: Float
Left Padding Page Report, Web Report, Library Component Specifies the space between the content in the object and the left border of the object. Type a numeric value to change the padding.

Data type: Float
Right Padding Page Report, Web Report, Library Component Specifies the space between the content in the object and the right border of the object. Type a numeric value to change the padding.

Data type: Float
Top Padding Page Report, Web Report, Library Component Specifies the space between the content in the object and the top border of the object. Type a numeric value to change the padding.

Data type: Float
Border (not available when the DBField is in a heat map)
Border Color Page Report, Web Report, Library Component Specifies the color for the border of the object. Choose a color from the drop-down list or select Custom to customize a color in the Pick a Color dialog box, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For a page report, you can also use a formula or edit an expression to return a color.

Data type: String
Border Thickness Page Report, Web Report, Library Component Specifies the width for the border of the object. Type a numeric value to change the thickness.

Data type: Float
Bottom Line Page Report, Web Report, Library Component Specifies the line style for the bottom border of the object. Choose an option from the drop-down list.

Data type: Enumeration
Left Line Page Report, Web Report, Library Component Specifies the line style for the left border of the object. Choose an option from the drop-down list.

Data type: Enumeration
Right Line Page Report, Web Report, Library Component Specifies the line style for the right border of the object. Choose an option from the drop-down list.

Data type: Enumeration
Shadow Page Report, Web Report, Library Component Specifies whether to add a drop shadow effect to the border.

Data type: Boolean
Shadow Color Page Report, Web Report, Library Component Specifies the color of the border shadow. Choose a color from the drop-down list or select Custom to customize a color in the Pick a Color dialog box, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For a page report, you can also use a formula or edit an expression to return a color.

Data type: String
Top Line Page Report, Web Report, Library Component Specifies the line style for the top border of the object. Choose an option from the drop-down list.

Data type: Enumeration
Pattern
Pattern Color Page Report, Web Report, Library Component Specifies the color in which to draw a pattern to fill the object. Choose a color from the drop-down list or select Custom to customize a color in the Pick a Color dialog box, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For a page report, you can also use a formula or edit an expression to return a color.

Data type: String
Pattern Style Page Report, Web Report, Library Component Specifies the style of the pattern. Choose an option from the drop-down list.
  • none - Select if you do not want to apply a pattern to the object.
  • 50% - Select to fill the object using 50%-transparency of the specified pattern color.
  • horizontal - Select to fill the object with horizontal lines using the specified pattern color.
  • vertical - Select to fill the object with vertical lines using the specified pattern color.
  • grid- Select to fill the object with grids using the specified pattern color.
  • diagonal- Select to fill the object with diagonal lines using the specified pattern color.

Data type: String
Text Format
Auto Fit Page Report, Web Report, Library Component Specifies whether to automatically adjust the width and height of the object according to its content.

Data type: Boolean

Note icon Designer does not provide this property when the DBField is in a heat map.
Auto Scale in Number Page Report, Web Report, Library Component Designer displays this property when the object is Number data type. You can use it to specify whether to automatically scale values of the object that fall into the two ranges:
  • When 1000 <= value < 10^15, Designer applies the following quantity unit symbols of the International System of Units to scale the values: K (10^3), M (10^6), G (10^9), and T (10^12).
  • When 0 < value < 0.001 or value >= 10^15, Designer uses scientific notation to scale the values.

The option "auto" means that the property setting follows that of the object's parent data component.

Data type: Boolean
Bold Page Report, Web Report, Library Component Specifies whether to apply bold style to the text in the object.

Data type: Boolean
Convert HTML Tag Query Page Report Specifies whether to parse the HTML tag elements that are included in the text of the object as the web browser translates them into HTML in the report result.

Data type: Boolean

Note icon

  • This property has higher priority than Ignore HTML Tag.
  • This property does not work when you view or export the report in the Page Report Result or Logi Report Result format.
  • This property takes effect only when the object's Position is "absolute".
  • Designer does not provide this property when the object is in a crosstab.
Font Face Page Report, Web Report, Library Component Specifies the font face of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration
Font Size Page Report, Web Report, Library Component Specifies the font size of the text in the object. Type an integer value to change the size.

Data type: Integer
Format Page Report, Web Report, Library Component Specifies the format in which you want to display values of the object in the report result. Choose an option from the drop-down list or type the format by yourself.

Data type: String

Note icon

  • If the object is BigDecimal data type, to avoid precision loss, you should specify a prefix JRD when setting the format.
  • If the object is Number data type and you set its Auto Scale in Number property to "true", Logi Report Engine applies the specified format to the integer part of the values after scaling them; however, if the specified format conflicts with the Auto Scale in Number property (for example, the values display in percentage), Logi Report Engine ignores the Auto Scale in Number property.
Horizontal Alignment Page Report, Web Report, Library Component Specifies the horizontal justification of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration

Note icon Designer does not provide this property when the DBField is in a heat map.
Ignore HTML Tag Page Report, Web Report, Library Component Specifies whether to ignore the HTML tag elements that are included in the text of the object at runtime and in the HTML output of the report, so they display exactly as what they are. When you set this property to "false", Logi Report Engine transfers the HTML tag elements to the web browser and they are translated into HTML by the web browser.

Data type: Boolean
Italic Page Report, Web Report, Library Component Specifies whether to italicize the text in the object.

Data type: Boolean
Maximum Width Page Report, Web Report, Library Component Specifies the maximum width of the text you want to display in the object. Type a numeric value to change the width.

This property often works together with Auto Fit. If Auto Fit is "true" and Maximum Width is not equal to 0, the text extends in the object until the width is this value.

Data type: Float

Strikethrough Page Report, Web Report, Library Component Specifies whether to draw a line through the text in the object.

Data type: Boolean
Underline Page Report, Web Report, Library Component Specifies whether to add a horizontal line under the text in the object.

Data type: Boolean
Vertical Alignment Page Report, Web Report, Library Component Specifies the vertical justification of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration

Note icon Designer does not provide this property when the DBField is in a heat map.
Word Wrap Page Report, Web Report, Library Component Specifies whether to wrap the text according to the width of the object.

Data type: Boolean

Note icon Designer does not provide this property when the DBField is in a heat map.
Others
Cache Value Query Page Report Specifies whether to cache the value of the field instead of obtaining it repeatedly.

Data type: Boolean
Column Name Query Page Report Specifies another field to substitute the current field. Choose the field from the drop-down list.

Data type: String

Note icon To make the property editable, you need to clear "Forbid changing column" in the Panel category of the Options dialog box.
Data Mapping File Page Report, Web Report, Library Component Specifies the data mapping file you want to apply to the object for NLS use.

For example, if the data mapping file name is "Category_de_DE.properties", set the value as "Category" (without the language and locale part).

Data type: String

Detail Report Query Page Report Specifies the detail report that you want to link the object to. Select the ellipsis Ellipsis button in the value cell to set the detail report. For more information, see Linking to a Detail Report.

Data type: String

Note icon Designer does not provide this property when the DBField is in a crosstab.
Detail Target Frame Query Page Report Designer displays this property when the object is in the group header/footer panel of a banded object and enables it after you set Go to Detail to "true". You can use it to specify the target window or frame in which to display the detail information. Choose an option from the drop-down list.
  • <Server Setting> - Select to load the detail information according to setting of the Pop up New Window for Links option in the Profile > Configure Profile > Page Report Studio > Properties > Default tab on Server.
  • New Window - Select to load the detail information into a new window. The window is not named.
  • Whole Window - Select to load the detail information into the full browser window.
  • Same Frame - Select to load the detail information into the same frame as the object.
  • Parent Frame - Select to load the detail information into the parent frame of the frame in which the object is.
  • Other Frame - Select to load the detail information into some other specified frame. Type the name of the frame you have defined in the value cell. If the frame name does not exist, Server loads the detail information into a new window.

Data type: String
Display Null Page Report， Web Report, Library Component Specifies the string you want to display when the field value is null.

Data type: String
Enable Hyperlink in Excel Page Report, Web Report, Library Component Specifies whether to enable the link that you have added on the object in the Excel output of the report.

Data type: Boolean

Note icon Designer does not provide this property when the DBField is in a crosstab in a web report or library component.

Enable Hyperlink in HTML Page Report, Web Report, Library Component Specifies whether to enable the link that you have added on the object in the HTML output of the report.

Data type: Boolean

Note icon Designer does not provide this property when the DBField is in a crosstab in a web report or library component.

Enable Hyperlink in PDF Page Report, Web Report, Library Component Specifies whether to enable the link that you have added on the object in the PDF output of the report.

Data type: Boolean

Note icon Designer does not provide this property when the DBField is in a crosstab in a web report or library component.

Expand Data Page Report Designer displays this property when you use the DBField as a column/row field in a crosstab. You can use it to specify whether to allow Page Report Studio users to expand and collapse the details of the column/row group generated by the field in the crosstab. This property takes effect only when the Expand Data property of the crosstab is "true".

Data type: Boolean

Expand Detail Data Page Report Designer displays this property when you use the DBField as a column/row field in a crosstab. You can use it to specify whether to expand the details of the column/row group generated by the field in the crosstab by default in Page Report Studio. It is meaningful to enable the property after you have set the field's Expand Data property to "true".

Data type: Boolean
Export to CSV Page Report, Web Report, Library Component Specifies whether to include the object in the CSV output of the report.

Data type: Boolean

Note icon

  • Designer does not provide this property when the DBField displays as a rank, image, or image button outside of a crosstab in a page report.
  • When you set this property of a DBField in a page report to "true", if the DBField displays as a barcode or text field, Logi Report Engine only includes the string value in the output; if the DBField displays as a checkbox, radio button, or button, only the text.
Export to Excel Page Report, Web Report, Library Component Specifies whether to include the object in the Excel output of the report.

Data type: Boolean

Note icon When you set this property of a DBField in a page report to "true", if the DBField displays as a text field, Logi Report Engine only includes the string value in the output.
Export to HTML Page Report, Web Report, Library Component Specifies whether to include the object in the HTML output of the report.

Data type: Boolean
Export to PDF Page Report, Web Report, Library Component Specifies whether to include the object in the PDF output of the report.

Data type: Boolean

Note icon When you set this property of a DBField in a page report to "true", if the DBField displays as a text field, Logi Report Engine only includes the string value in the output.
Export to PostScript Page Report, Web Report, Library Component Specifies whether to include the object in the PostScript output of the report.

Data type: Boolean

Note icon When you set this property of a DBField in a page report to "true", if the DBField displays as a text field, Logi Report Engine only includes the string value in the output.
Export to Report Result Page Report, Web Report, Library Component Specifies whether to include the object when you preview the report in Page Report Result for a page report or Web Report Result for a web report in Designer, and when users run the report or use the library component at runtime.

Data type: Boolean
Export to RTF Page Report, Web Report, Library Component Specifies whether to include the object in the RTF output of the report.

Data type: Boolean

Note icon When you set this property of a DBField in a page report to "true", if the DBField displays as a text field, Logi Report Engine only includes the string value in the output; if the DBField displays as a radio button or button, only the text.

Export to Text Page Report, Web Report, Library Component Specifies whether to include the object in the Text output of the report.

Data type: Boolean

Note icon When you set this property of a DBField in a page report to "true", if the DBField displays as a barcode or text field, Logi Report Engine only includes the string value in the output; if the DBField displays as a checkbox, radio button, or button, only the text.

Export to XML Page Report, Web Report, Library Component Specifies whether to include the object in the XML output of the report.

Data type: Boolean

Note icon When you set this property of a DBField in a page report to "true", if the DBField displays as a barcode or text field, Logi Report Engine only includes the string value in the output; if the DBField displays as a checkbox, radio button, or button, only the text.

Filter Options Query Page Report Specifies the filter commands that you want to display on the object's shortcut menu in Page Report Studio. Select the ellipsis Ellipsis button in the value cell to set the options.

Data type: Integer
Go to Detail Query Page Report Designer displays this property when the object is in the group header/footer panel of a banded object. You can use it to specify whether to show the detail information about the group when users select the object in Page Report Studio. For more information, see Obtaining the Group Details in a Banded Object.

Data type: Boolean

Invisible Page Report, Web Report, Library Component Specifies whether to hide the object in the design area and in the report result. Logi Report Engine performs all the calculations that involve the object regardless of whether the object is visible or not.

Data type: Boolean

Note icon Designer does not provide this property when the DBField is in a crosstab.
Link Page Report, Web Report, Library Component Specifies the target that you want to link the object to, which can be another report, a website, an email address, or a Blob data type field. Select the ellipsis Ellipsis button in the value cell to set the link target. For more information, see Adding Links in Reports.

Data type: String
Logic Column Page Report, Web Report, Library Component Designer displays this property when the object is in a table. You can use it to specify whether to show the object in the next visible table cell in the same row when the column which holds the object is hidden. Choose an option from the drop-down list.

Data type: Enumeration 

Note icon

  • The next visible table cell should be completely empty, that is, the cell should not hold any content including blank space.
  • When you set this property for several objects in the same row to "next visible column", and the columns holding these objects are all hidden, only the object in the rightmost column shows in the next visible cell.
Order By Query Page Report Designer displays this property when you use the DBField as a column/row field in a crosstab. You can use it to specify the field by which to sort the data.

Data type: String

Position Page Report, Web Report, Library Component Specifies the position of the object. Choose an option from the drop-down list.

Data type: Enumeration

Note icon Designer does not provide this property when the DBField is in a crosstab or heat map.

Record Location Page Report, Web Report, Library Component Specifies the calculation point for the properties of the object that are controlled by formulas. This property takes effect only when the object is in a banded object. Choose an option from the drop-down list.
  • default - Select to calculate the values of the properties in the default location where the object is placed.
  • page header - Select to calculate the values of the properties in the banded page header panel.
  • page footer - Select to calculate the values of the properties in the banded page footer panel.

For more information, see Example 2: Showing a Label on Every Page Except the Last.

Data type: Enumeration

Suppress Query Page Report Specifies whether to suppress the DBField in the design area and in the report result. If you suppress a DBField, Logi Report Engine skips all formulas and calculations that involve the DBField.

Data type: Boolean

Note icon

  • When you set both the Invisible and Suppress properties of a DBField to "true", Suppress has the higher priority.
  • When the DBField is a column/row field in a crosstab, setting Suppress to "true" only hides the column or row header, meaning, it does not affect the calculation and the other part of the crosstab remains the same in the report result.
Suppress When No Records Query Page Report Specifies whether to exclude the object in the report result when no record is returned to its parent data component.

Data type: Boolean
Suppress When Null Query Page Report Specifies whether to suppress the field in the report result when its value is null.

Data type: Boolean
Transfer Style Page Report, Web Report, Library Component Specifies whether to apply the style group of the primary report to the linked report, when the object is linked to another report.

Data type: Boolean
Value Delimiter Page Report, Web Report, Library Component Specifies the separator for DBArray data. By default, Logi Report Engine displays the elements in a horizontal line and separates them by a space. Type the delimiter in the value cell.

Data type: String
TOC (available when the DBField is in a banded object)
Anchor Display Value Page Report Specifies the string you want to display as the object's entry in the TOC of the report, which takes effect when the object's TOC Anchor property is "true".

Data type: String
TOC Anchor Page Report Specifies whether to include the object in the TOC of the report.

Data type: Boolean
Accessibility
Abbr Page Report, Web Report, Library Component This property is mapped to the HTML attribute abbr, as specified by w3.org.

Data type: String

Note icon Designer provides this property only when the DBField is in a crosstab.

Axis Page Report, Web Report, Library Component This property is mapped to the HTML attribute axis, as specified by w3.org.

Data type: String

Note icon Designer provides this property only when the DBField is in a crosstab.

External AccessKey Query Page Report This property is mapped to the HTML attribute accesskey, as specified by w3.org.

Data type: String
External CSS Class Selector Query Page Report Specifies the name of the Class Selector for the object in the HTML output of the report.

Data type: String
External Dir Query Page Report This property is mapped to the HTML attribute dir, as specified by w3.org.

Data type: String
External ID Query Page Report This property is mapped to the HTML attribute id, as specified by w3.org.

Data type: String
External Style Query Page Report This property is mapped to the HTML attribute style, as specified by w3.org.

Data type: String
External TabIndex Query Page Report This property is mapped to the HTML attribute tabindex, as specified by w3.org.

Data type: Integer
External Title Query Page Report This property is mapped to the HTML attribute title, as specified by w3.org.

Data type: String
Headers Page Report, Web Report, Library Component This property is mapped to the HTML attribute headers, as specified by w3.org.

Data type: String

Note icon Designer provides this property only when the DBField is in a crosstab.

HrefLang Query Page Report This property is mapped to the HTML attribute hreflang, as specified by w3.org. You can use it to specify the base language of the resource designated by a link on the object, such as the target you define via the Link property.

Data type: String
Language Query Page Report This property is mapped to the HTML attribute lang, as specified by w3.org.

Data type: String
LongDesc Query Page Report This property is mapped to the HTML attribute longdesc, as specified by w3.org.

Data type: String
Scope Page Report, Web Report, Library Component This property is mapped to the HTML attribute scope, as specified by w3.org. Choose an option from the drop-down list to specify the set of data cells for which the current header cell provides header information in the accessible HTML output of the report.
  • none - Select it if you do not want to generate this attribute in the output.
  • Column - Select it if you want the current header cell to provide header information for the rest of the column that contains it.
  • Row - Select it if you want the current header cell to provide header information for the rest of the row that contains it.

Data type: Enumeration

Note icon Designer provides this property only when the DBField is in a crosstab.

Tag Name Page Report, Web Report, Library Component Specifies the header tag name of the object for labeling its heading order in the accessible PDF output of the report. Choose an option from the drop-down list.

When setting this property, you should nest the headers properly based on the following rules so that the heading tag sequence can be accepted by Adobe.

  • H1 should always be the first heading tag.
  • The descending sequence of the headers should follow the downward order of the objects in the Report Inspector.
  • The descending sequence of the headers should proceed in strict numerical order and should not skip an intervening heading level. H1 H2 H3 is permissible, while H1 H3 is not.

Data type: Enumeration

Note icon Designer does not provide this property when the DBField is in a chart or map.

Note icon At runtime, Web Report Studio and JDashboard can only render these DBField properties:

  • Data Mapping File
  • Link
  • Properties available to the DBField object in the Inspector panel of Web Report Studio.

Back to top

BackPrevious Topic  Next TopicNext