FormDataObject.skip Method

Sets or returns a value that indicates whether the control is skipped when the user presses the TAB key to move to the control that is associated with the data source.

Syntax

public boolean skip([boolean value])

Run On

Client

Parameters

  • value
    Type: boolean
    The value to assign to the skip property of the data source that is associated with the control; optional.

Return Value

Type: boolean
true if the control is skipped when the user presses the TAB key to move to the control that is associated with the data source; otherwise, false.

Remarks

If the enabled property is true, the allowEdit property is false, and the skip property is true, the user cannot change the contents of the control but can still copy the contents of the control.

Controls are skipped if either the control's skip value is true or the data source's skip value is true.

Examples

The following shows how to retrieve and set the skip property of a data source for a control.

// Return the value of the skip property. 
info(strfmt("skip: %1", this.skip())); 
// Set the value of the skip property. 
this.skip(true);

See Also

FormDataObject Class

FormDataObject.enabled Method

FormDataObject.allowEdit Method