Adds the key-value pair to the AltIds of this object. This will overwrite any existing value for the key on any object that has the same classId without warning you, so use this with caution.
An object of alternate ids for this object, with values as [[AltId]]
An array of alternate ids for this object.
Same as calling optAncestor(var).orElse(null)
If this object is a Collection it returns it as an array. The majority of objects in the system are Collections. For most objects, this is the same as calling [[children]].
Get the children of the object. This retrieval goes one level deep.
OptionalclassType: string | numberThe "created at" timestamp of this object.
The creator of this object.
Returns fields data type.
The deleted children of this object. Only looks one level deep. E.g. a form's deleted children could include fields and form entries. A folder's deleted children could include folders, forms, and formulas, but not any of those forms' entries.
The default display name of this object. For the most part, this is the same as calling toString(), which is the same as inserting the object into a string.
Sets the Display Name.
Get the [[Field]] associated with the [[FieldMetaData]], given a particular [[BaseRecord]].
A [[BaseRecord]] that the [[Field]]'s [[Form]] is attached to.
Optionalwritable: booleanDefaults to false.
Returns the field control field key of a field. The possible values are a list of the [[BooleanField]]s, [[SingleSelectField]]s, and [[SignatureField]]s. Only accessible when [[fieldControlType]]is custom.
Returns the field control field value of a field. The possible values are a list of the possible values of the selected [[fieldControlFieldKey]]. Only accessible when [[fieldControlType]] is custom.
Returns the field control type of a field.
''): Editing and viewing of the field based strictly on permissionshiddenDefault): Always hidden on the generic layoutreadonlyDefault): Always view-only on the generic layoutsmartHide): Generic layout displays view-only when the field has a value or hidden when it is emptyreadonlyWhenCompleted): The field displays as normal until it is completed, then it becomes view-onlycustom): See [[fieldControlView]]// check that a date field is view-only when the form has been signed
const controlType = fields.date.metaData().fieldControlType(); // 'custom'
const customView = fields.date.metaData().fieldControlView(); // 'readonly'
const customViewKey = fields.date.metaData().fieldControlFieldKey(); // 'signature'
const customViewVal = fields.date.metaData().fieldControlFieldValue(); // 'signed'
Returns the field control view of a field. Only accessible when [[fieldControlType]] is custom.
readonly): Becomes view-only when conditions are methidden): Becomes hidden when conditions are metReturns the format type of the field.
none, memo, phone, email, measurement, url, state, taxId, zip, selection, medName, medProductID, ICD9Dx, ICD10CM, ICD10Next, DSM5, medBillingRevCode, drugAllergy, drugAllergyRxNorm, bp, cptCode, labCodes, creditCard, medispanBehaviorsnone, emailList, htmldate, time, dateTimeinteger, float, moneycheckbox, radioselect, list, lookup, radiolist, lookup, checkboxGroupsimple, securename, thumbnailsignaturepad, biometricfull, smallThe [[FormMetaData]] object associated with this field.
Gets an array of all the object's ancestors.
The [[Id]] of this object bounded to T.
Returns the Local Cache object for this Thread/Base Object.
Same as calling optLock().orElse(null)
The [[User]] that last modified this object.
A [[Java.Optional]] of the ancestor with the specific class.
A [[Java.Optional]] of the current object's parent object.
OptionalclassType: string | numberSame as calling optParent(var).orElse(null)
OptionalclassType: string | numberReturns the placeholder of the field.
Removes the AltId with the specified key from this object, if it has one. There is no error if the key does not exist.
Add the field so the inspector can find it.
When true, mark in the inspector that the field is writable
Reset the current object so that it is cleared from the cache and looked up from the database.
The [[Id]] or [[AltId]] that the system deems most relevant.
Makes changes to the database for this object
The versions of this object.
The versions of this object.
Returns a view URL for this object, if it has one. This value is always a relative URL, meaning it does not contain the protocol prefix or domain name such as http://xyz.bluestep.net.
The litany of metadata associated with a field.
Most of the metadata examples use the following accessor as a base:
Example: ```javascript B.queries.byFID['allUsers'].require(); const user = allUsers.byId[userId]; user.forms.byFID['profile'].require(); const fields = user.profile.fields(); ```
But don't think that there are no other ways to get to a field.