Editable Property

Version: Available or changed with runtime version 1.0.

Sets a value that indicates whether a field, page, or control can be edited through the UI.

Applies to

  • Table Field
  • Page
  • Request Page
  • Page Label
  • Page Field
  • Page Group
  • Page System Part
  • Page Chart Part
  • Page Part

Property Value

True on pages if the field, page, or control can be edited; otherwise, false on pages. The default value is true.

Syntax

Editable = true;

Remarks

For fields, use this property to make a field for display only.

For controls, if the Editable property for the container that contains this control is set to false, then that setting overrides what you enter here.

If a page has Editable set to false, then the controls on the page aren't editable, even if the individual Editable properties are set to true.

The property setting is checked during validation. Validation occurs only if the field or control value is updated through the UI. For example, when a value is updated on a page or when a field is updated in a table. If a field is updated through application code, then the Editable property isn't validated.

Note

When using CurrPage.Editable, the Editable property also reflects the page mode that the page was opened in. This applies to Edit, Create, and Delete modes, but not to View mode. If the page not is editable, then CurrPage.Editable will return false.

On pages, you use the Editable property for group, part, field, and action controls. You can make them editable or non-editable 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 either be a Boolean value true/false or a Boolean expression. For a page showing the Customer table, an example could be:

Editable = "Balance Due (LCY)" > "Credit Limit (LCY)"

Caution

Do not use CurrPage.Editable to prevent users from deleting entries. We recommend that you use permissions to control which users can delete data.

Note

You can also use as property value a Boolean variable that evaluates to true or false. To use a variable for the Editable property, it must be set as a global page variable and the InDataSet Attribute must be defined on the variable. Also, note that the dynamic Boolean variables and the Booleans set by the InDataSet attribute aren't supported in tables.

See Also

Properties
Page Properties
InDataSet Property