Enabled Property

Version: Available or changed with runtime version 1.0.

Sets a value that indicates whether a field or key is enabled or disabled, or whether a control can respond to user-generated events.

Applies to

  • Table Field
  • Table Key
  • Page Label
  • Page Field
  • Page Group
  • Page Part
  • Page System Part
  • Page Chart Part
  • Page Action
  • Page Action Group
  • Page Custom Action
  • Page System Action
  • Page File Upload Action
  • Profile

Note

For information about the Enabled property for Profiles, see Enabled (Profile) Property.

Property Value

True on pages if the field, key, or control is enabled; otherwise, false on pages. The default is true on pages and profiles.

Syntax

Enabled = false;

Remarks

For keys, this property determines whether any index (normal or SIFT) defined in the key is created in the database. If you are not using the key or if you rarely use the key, you may want to mark it as disabled for performance reasons. When you want to use the key you can change this setting.

For fields, this property determines whether you can store data in the field. If the field is unused, disable it to conserve database space. In an XMLPort, a disabled field is read from the external file on import, but it is not inserted in the database.

For controls, the Enabled setting for the container that contains this control overrides what is entered here.

On pages, you use the Enabled property for group, part, field, and action controls. You can enable or disable the control either statically by setting the property to true or false, or dynamically by using a Boolean variable or a Boolean field on the page. The Boolean field on the page can be either a true/false Boolean or a Boolean expression, such as “Credit Limit > Sales YTD”.

Note

You can also use as property value a Boolean variable that evaluates to true or false. To use a variable for the Enabled property, it must be set as a global page variable.

See Also

Table Properties
Properties