Skip to main content
Kinetic Community

Field Model

The field object represents the Field that is being accessed. Many of the properties and methods are accessible within the bundle.

Properties

dataType

Indicates the type of data this field exists. Examples:

  • date
  • decimal
  • file
  • integer
  • json
  • string
  • submission
${field.dataType}

defaultValue

The default value to use for a new submission.

${field.defaultValue}

defaultResourceName

The name of the bridged resource the field will use to set the default value for a new submission.

${field.defaultResourceName}

fieldConstraints

A list of Field Constraint objects attached to the field. Field constraints indicate rules that the value must abide by, such as: required, pattern match, or possibly a custom rule.

${field.fieldConstraints}

form

The Form the field belongs to.

${field.form}

key

The field key. Each field must have a unique key on a form.

${field.key}

label

The field label. This is the value that rendered to the user when the form / submission is displayed in a web browser.

${field.label}

name

The field name.

${field.name}

page

The Page the field exists on.

${field.page}

Methods

isComplexDataType()

Returns a true | false value indicating if the field is one of the complex data types:

  • file
  • json
  • submission
${field.isComplexDataType()}

Related