The edit method modifier is used to indicate that a method’s return value is to be displayed on a form, and users can edit that value. If you don’t want users to edit the value, use a display method.
Use the edit method modifier on the following:
- Table methods
- Form methods
- Form data source methods
Write your edit methods on a table. You can use the same code in several forms.
edit methods are called each time the form is redrawn. They should not contain complex and time-consuming calculations.
edit methods can result in unintended information disclosure. For more information, see Security on Display and Edit Methods.
edit methods are not activated if they are on a hidden tabbed page.
Create an edit method on a form or table.
- Place the edit keyword immediately in front of the method’s return type.
- Create a Boolean parameter called Set. It is used to determine whether the user has entered anything into the control.
- Create a second parameter to hold the values that the user has entered into the control.
- If the edit method is on a form data source, create a third parameter for the data source. Place this parameter after the Set parameter.
Following is an example of an edit method on a table.
edit FreeTxt txtDefault(boolean Set, FreeTxt Txt)
Following is an example of an edit method on a form data source.
edit Amount settle(boolean set, CustTrans _CustTrans, Amount U)
edit methods must have a return type. The return value is typically a calculated value (for example, a sum). For an example, see How to: Add a Control to a Form.
To use an edit method on a form, the control and the return type of the method must have identical types. For example, if you have a RealEdit control on your form, the edit method you are using must return a value of type real.
Add the edit method to a form control.
- Set the DataSource property for the control to the data source that contains the method.If you do not set the DataSource property, the system assumes that the method has been defined on the form.
- Set the DataMethod property to the name of the method.
You might also want to set the ExtendedDataType or ArrayIndex properties:
- If the ExtendedDataType property is set, formatting, Help text, and so on are inherited from the type specified here.
- If the edit method returns an array, set ArrayIndex to 0 to indicate that all array elements are to be shown in the control. If, for example, you set it to 2, only array element number two is shown.