Control Property Descriptions

Control properties are the named attributes of a control. They define control characteristics (such as size, color, and screen location) or behaviors (whether a control is enabled, for example). For information about form properties, see Setting Form Properties.

Most control properties are common to all controls. Some properties are specific to certain controls, or shared by only a few. The table below includes all properties, but you can see just the properties available to a specific control by looking up the individual Control Description page in the Index, or in the Reference section of the Table of Contents.

Some of these properties will not be recognized when publishing applications as HTML. For a full description of the limitations, see Java Renderer and HTML Considerations.

Control Properties

Property Applies To Description
Algorithm Group Box How the control value of the group box is determined. For a set of radio buttons, choose Radio Button Algorithm; to concatenate the values of the controls in the control list for this group box, choose Concatenate Algorithm.
Background All The background color displayed in the control.

The opaque property must be set to True for this to take effect.

Border All Describes the appearance of the edge surrounding a control.
Caption Button, Check Box, Group Box, Label, Radio Button, WebLink The content that is displayed in the control.
Column Header Table The name displayed at the top of a column in a table control.
Column Name Table The name of the column (read-only). This name is automatically generated when the table control is created.
Note This name cannot be changed, as it must be accessed by the rules. For further details, see Table Rules Syntax.
Column Width Table The width of the column, in pixels.

Columns Table The names of the columns that have been defined for this table control.
Note You cannot edit this property directly. Double-click the column name to open the Table Column editor, from which you can edit the table control column.
Control List Group Box The controls associated with this group box.

The controls do not need to be visually contained by the box on the UI.

Data Combo Box The items that will appear in the list and the data associated with each item.

When the end user selects an item or types a value, the data for that item or the typed value will be the data associated with this control. For example, let's say you added three items to a combo box, and then mapped that combo box to a host field. When the end user chooses (or types) an item, the data associated with that item is sent to that host field when the form is processed.

Data Radio Button If the radio button is selected by an end user, the value of the control.
Data Alignment Table Select Left, Right, or Center to control where the data is displayed.

Default Value Column Table In a table with output binding, the column from which data will be sent to the host. If you choose <NONE>, data from the selected cell will be sent to the host.
Editable Combo Box, Text Area, Text Field If set to False, the control will not be interactive.
Enable In Focus Color Text Field Enables the In Focus Color property.
Enabled All If set to False, the control will be unavailable (appear dimmed), and will not be interactive.
Field Type Text Field Constrains what can be entered in the control by end users.

The Numeric Signed and the Numeric Shift types are for 5250 hosts only.

Font All The font used to display text and numbers in the control.

When viewed in the Presentation Renderer, WebLinks display in bold text when an end user mouses over them (unless you format the text as bold using the font property).

Foreground All The foreground color for any text displayed in the control.
Header Background Table The background color of the column header. This can be set for each cell, or for the header row.

Header Font Table The font used to display the column header.

Header Foreground Table The color of the text in the column header. This can be set for each cell, or for the header row.

Hidden Control Group Box If set to True, prevents users from seeing the control.
Hidden Text Text Field If set to True, a user entering text into this control will see asterisks instead of the text he or she is typing.

This is commonly used for password-related fields.

Horizontal Alignment Button, Check Box, Label, Radio Button, Text Field The horizontal alignment of the caption within the space defined by the width and height properties of the control.
Horizontal Text Position Check Box, Radio Button If you have both text and a graphic displayed in a control, this property sets the position of the text relative to the graphic.
Image File Image The path to the local image file that will be displayed by this control.

This image will be published to MCS along with your application.

In Focus Color Text Field The background color of the control when it has focus.
Input Length Text Field If the control is bound to a host field, this value is determined by the input length of the bound host field.
Line Wrap Error Report If set to True, long error messages will wrap to display in the width provided by the control, and no horizontal scroll bar will be created.
Mask Text Field This property is used to create a pre-formatted text field to enforce certain rules at the character level.

For details, see the Masking Text Field Controls topic.

Name All The name used to refer to the control in mapping editors elsewhere in Presentation Designer.

For controls converted from host fields during the recording process, the name is generated using data that describes the host field location in terms of row and column position on the original host screen.

On Click Button An event which will occur when an end user clicks the button.

For details, see the Adding Events to Controls topic.

On Double Click List and Table An event which will occur when an end user double-clicks the control.

For details, see the Adding Events to Controls topic.

Opaque All If set to True, the control will cover any content that is behind it, preventing users from seeing that content.
Prefix Check Box, Combo Box, List, Radio Button, Text Area, Text Field The control will send this data, followed by any value given to it by other means. For example, if the prefix is user, and the value assigned is 23, this control will send the value user23.
Resizable Image If set to True, you will be able to set the dimensions for the image when you are customizing your form. This allows you to change the size and shape, which may distort the image. If set to False, the image will display at its actual size.

In either case, the end user will not be allowed to resize the image.

Return Index List If set to True, instead of returning the assigned selection value, the control will instead send the numeric index value.

The first item counts as 0, so if the third item in the list is selected, regardless of its selection value, the control will send a value of 2.

Setting this property to True disables the Prefix and Suffix properties.

Screen Binding All except Button, Error Report, Image, Radio Button, and WebLink The relationship between the control and the host field to which it is bound, described in terms of row and column position of the host field on the original host screen.

For controls converted from host fields during the recording process, the screen binding is generated automatically.

Screen Name Screen-based Form The name of the host screen recorded in the NavMap (read-only).
Selected Check Box and
Radio Button
If set to True, the control will be selected by default.
Selected Data Check Box If the check box is selected by an end user, this is the value of the control.
Selected Index Combo Box and List The number of the item that will appear as the default.

A setting of -1 means there will be no default. The first item counts as 0, so if you want the third item in the list to be the default, type 2 for this property.

Selection Rule Table An expression that is used to determine which records are displayed. The expression is compared to each record. When a record matches the expression, that record is displayed. If the Selection Rule is left blank, every record in the table is displayed. (Default value: True.)
Short Cut Button, Check Box, and
Radio Button
A letter in the caption that will be underlined. Pressing the ALT key and typing this letter will activate the button On Click event, or select the Check Box or Radio Button.
Suffix Check Box, Combo Box, List, Radio Button, Text Area, Text Field The control will append this data to any value given to it by other means. For example, if the suffix is user, and the value assigned is 23, this control will send the value 23user.
Tab Index Button, Check Box, Combo Box, List, Radio Button, Table, Text Field Sets the Tab key navigation. The tab sequence is in ascending order from the lowest to the highest number. If you want to bypass a control as part of the tab order, set its tab index to -1. Additional controls placed on the form are added to the end of the tab order.
Tab Size Error Report The number of spaces for the Tab key within the text area.
Termination Rule Table An expression that is used to specify the end of the displayed table data. The expression is compared to each record. When a record matches the expression, that record and any following records are not displayed. If no record matches the Termination Rule expression, or if the Termination Rule is left blank, every record in the table is displayed. (Default value: True.)
Text Text Field and
Text Area
Default text that will display in the control until a user changes it.
Text (URL) Text Area A URL for a Web document which will display in the control.
ToolTip All The content that is displayed in a pop-up window when the mouse is over the control.

ToolTips appear within the Interact pane but not the Preview pane.

Underline WebLink If set to True, the caption for this control will be underlined.

When viewed in the Presentation Renderer, WebLink controls display in bold text when an end user mouses over them, unless you previously formatted the text as bold using the font property.

Unselected Data Check Box If the check box is not selected by an end user, this is the value of the control.
URL Image Makes the image a link to this URL.

Clicking the image will open a new browser window.

URL WebLink The URL of the Web site that will be opened when this control is clicked.

When an end user clicks a WebLink control in your application, a new browser window will open to display the specified Web site.

Use Scroll Pane Text Area, List, and
Error Report
If set to False, large content which would typically enable scroll bars will be inaccessible.
Vertical Alignment Button, Check Box, Label, Radio Button The vertical alignment of the caption within the space defined by the width and height properties of the control.
Vertical Text Position Check Box, Radio Button If you have both text and a graphic displayed in a control, this property sets the position of the text relative to the graphic.
Visible Table Select True to display this column, or False to hide it.

Width and Height All The dimensions of the control expressed in pixels.
X and Y All Coordinates that describe the location of the control on the form.

The location 0,0 indicates the upper left corner of the form.

Related Topics
Bullet Control Descriptions
Bullet Adding Controls
Bullet Setting Form Properties
Bullet Java Renderer and HTML Considerations
  Attachmate