getSyntaxProperties()

Retrieves field syntax properties that were set in the browser (using the setSyntaxProperty or setSyntaxProperties functions).

Return=FieldObject.getSyntaxProperties()

Arguments

None

Return Value

Return—a JavaScript object with each attribute representing a syntax field property. For example, in JavaScript Object Notation (JSON), such an object is represented as: 

{
   "DIG"   : true,
   "LEN"   : { "min" : 3,  "max" : 5 }
}

Exceptions

The following exceptions may be thrown:

Description

The getSyntaxProperties function only returns properties that were set in the browser using JavaScript, not those that were set in the server before being sent to the browser. The get these properties, use getDeclarativeSyntax.

Syntax Properties Supported by the JavaScript API
Property JavaScript Data Type Values Description/Remarks
NED Unsupported. Use property html:readOnly instead — No edit allowed in this field.
DIM Unsupported. Use property html:disabled instead — Dim field. No edit and no prompt.
ENT string Uniface entry format string Syntax for data entry. For example, "&*" (zero or more [a-zA-Z]). For more information, see Field Syntax Codes.
LEN object { min:Number,max:Number } Length of field or subfield.
ASC boolean   ASCII, in Unicode range 00-7F
BRM boolean   Check that brackets match.
DIG boolean   Digits only (0-9)
DLS boolean   Delete leading spaces.
DLZ boolean   Delete leading zeros.
LOW boolean   All lowercase
MAN boolean   Mandatory field (minimum length of one).
NUM boolean   Numbers only (0-9, . + -)
RCS boolean   Replace contiguous spaces with one space.
UPC boolean   All uppercase

Related Topics