Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Excerpt |
---|
This class represents a field on the form. This can be either a field on the main form, or on a related list. |
Full description. Define the purpose of the class, as well as where to get an instance of this class (if applicable). If this class extends another class, make sure to mention it here.
Methods
onUpdate (without parameters)
Code Block |
---|
List<B25.FormEventHandler> onUpdate() |
Returns a reference to the list of handlers that have been defined to trigger when the field’s value is updated by the user. Because this method returns a reference to the actual list (and not a copy), any changes you make to this list will directly affect the defined handlers. This method is intended to be used in the customize method defined in your implementation of the B25.Form.Customizable interface. Using it anywhere else, such as inside one of your event handlers, will not have any effect.
Return value: List<B25.FormEventHandler>
onUpdate (with parameter)
Code Block |
---|
void onUpdate(B25.FormEventHandler handler) |
Adds the given handler to the list of handlers that have been defined to trigger when the field’s value is updated by the user. This method is a convenience method, and is identical to calling onUpdate().add(B25.FormEventHandler handler)
.
Parameters:
Name | Type | Description |
---|---|---|
handler | B25.FormEventHandler | The handler to trigger when the field is updated. |
update
Code Block |
---|
ReturnTypevoid methodTwoupdate(ParameterType param1, ParameterType param2) |
Description. Describe what the method does, what it expects, and what it outputs. Describe any cases in which the method might not work as expected. Describe any exceptions that this method is likely to throw.
Return value: ReturnType (link to relevant doc)Object newValue) |
Calling this method allows you to directly set the value of the field. Unlike the value being updated by the user on the form, this action will not trigger any event handlers. Use this method inside your own handlers.
Parameters:
Name | Type | Description | ||
---|---|---|---|---|
param1 | ParameterType (link to relevant doc) | The first parameter. | ||
param2 | ParameterType (link to relevant doc) | The second parameternewValue | Object | The value that you want to set the field to. |
On this page | |
---|---|
|