Control Common Properties

 

Documentation home

 

The following properties are common to all controls:

 

Property

Name1

Description

Type1

Get1

Set1

Control name

ctrl

The control name. All names within a form/component must be unique.

Character

Yes

No

Display only

displayOnly

Makes the control and all of its children display only i.e. data cannot be entered. A control is considered to be display only if the control or any of its parents have been set as display only.

Boolean

Yes

Yes

Hidden

hidden

Hides the control and all of its children. A control is considered to be hidden if the control or any of its parents have been set as hidden.

Boolean

Yes

Yes

Message options

 

Provides options to control where messages are displayed and their appearance. See message options for details.

 

 

 

Modifiers

modifiers

Modifiers should be entered as a comma delimited list of individual modifiers e.g.

Audit, Supervisor, Mod2

Level1

Modifiers provide a way of flagging one or more controls so they can be found programatically, e.g. a group of Field Controls might be changed from enterable to display only. Any number of modifiers can be assigned - Modifiers are accessed by using method Page.getControlsByModifier().

Javascript example:

 var page = pages.PAGE_1;
 for each (var ctrl in page.getControlsByModifier("Audit"))
 {
   if (!system.securityManager.hasRole("FINANCE_CONTROLLER"))
   {
      ctrl.hide();
   }
 }

Character

Yes

Yes

New Line

newLine

When inside a container with Field Grid layout, indicates that the control should be placed on a new line. This property is only shown for controls that support the new line option. See Field Grid Layout for more information.

Boolean

Yes

Yes

Html Element Properties

 

Provides support for the creation of rich client applications, allows the creation of: locators, event handlers and custom attributes. Click here for more details.

 

 

 

Events

 

Allows all events for the control to be configured. Displays the events dialog.

 

No

No

 

1 See accessing control properties from scripts

 

Style tab

 

Control Style

Click on the … button to display the Styling Assistant for the control. Details of the properties available with each styling assistant are shown in the documentation for each control – see Controls.

 

Class

This property is shown for all controls that support a single class property (property cssClass). Enter one or more classes in the text box or click the … button to select from available classes. Please see the documentation for each control for details of how the cssClass property is applied to that control. This class property can also be edited by clicking the … button for the Control Style property, then clicking the Advanced Properties button.