IBM BPM version 8570 cumulative fix 2017.06Text Reader control

This control creates a text box that you can expand or collapse to show or hide sections of text that are larger than a specified number of characters. The extra text is hidden until the user clicks Show More or a similar link that you can specify.

Data binding

Set or modify the data binding for the control in the General properties tab. The Text Reader control can be bound to a String variable.

Configuration properties

Set or modify configuration properties for the control, such as appearance and behavior properties, in the Configuration properties tab.
Screen size
A configuration property that has the Screen Sizes icon The Screen Sizes icon beside the property name can have different values for each screen size. If you do not set a value, the screen size inherits the value of the next larger screen size as its default value. If you are using the Process Designer desktop editor, you are setting the value for the large screen size. The other screen sizes inherit this value.
Theme definitions
Theme definitions specify the colors and styles for a control and determine the appearance of the control. You can preview the look and feel of controls in the theme editor. See Themes.

The appearance configuration properties for the Text Reader control are shown in the following table:

Table 1. Appearance configuration properties for the Text Reader control
Appearance configuration property Description Data type
Width The Screen Sizes icon Specifies the width of the control in pixels, percent, or em units. For example: 50px or 20% or 0.4em. If no unit type is specified, px is assumed. String
Height The Screen Sizes icon Specifies the height of the control in px (pixels) or em units. If no unit type is specified, px is assumed. String
Size The Screen Sizes icon Specifies the size of the label and text.
  • Default
  • Large
  • Small
String
Label placement The Screen Sizes icon Specifies the placement of the label in relation to the text.
  • Top
  • Left
Note: Labels on the left change the specified width of the control.
String
The behavior configuration properties for the Text Reader control are listed in the following table:
Table 2. Behavior configuration properties for the Text Reader control
Behavior configuration property Description Data type
Max text length Specifies the maximum number of characters that are displayed until the Read More hint is shown.

If no number is specified or the number is lesser than 1, the default value of 128 characters is used.

Integer
Read more hint The placeholder text that is displayed for the Read More hint. String
Read less hint The placeholder text that is displayed for the Read Less hint. String
Initially expanded Specifies whether the text section is expanded when the page is loaded. Boolean

Events

Set or modify the event handlers for the control in the Events tab. You can set events to be triggered programmatically or when a user interacts with the control. For information about how to define and code events, see User-defined events.
The Text Reader control has the following types of event handlers:
  • On load: Activated when the page loads. For example:
    if (${DeviceSensor}.getDeviceInfo().isIPhone) {me.setExpanded(false);} else {me.setExpanded(true);}
  • On click: Activated when the control is clicked. For example:
    me.toggleExpanded()
  • On expand: Activated when the user expands the text. For example:
    ${TextReader2}.setExpanded(false)
  • On collapse: Activated when the user collapses the text. For example:
    ${TextReader2}.setExpanded(true)

Methods

For detailed information on the available methods for the Text Reader control, see the JavaScript documentation.

Additional resources

For information about how to create a coach, see Building coaches.
For information about standard properties (General, Configuration, Positioning, Visibility, and HTML Attributes), see Coach view properties.