multilineFieldSchema: Create a multi-line or narrative form field schema object

View source: R/formField.R

multilineFieldSchemaR Documentation

Create a multi-line or narrative form field schema object

Description

Multi-Line Text fields can be used to collect long answers to open-ended questions. They could be used for example to collect Comments about a specific Form or an Extended Narrative. It cannot be a key field.

Usage

multilineFieldSchema(
  label,
  description = NULL,
  code = NULL,
  id = cuid(),
  required = FALSE,
  hideFromEntry = FALSE,
  hideInTable = FALSE,
  relevanceRule = "",
  validationRule = "",
  reviewerOnly = FALSE
)

Arguments

label

The label of the form field

description

The description of the form field

code

The code name of the form field

id

The id of the form Field; default is to generate a new cuid

required

Whether the form field is required; default is FALSE

hideFromEntry

Whether the form field is hidden during data entry; default is FALSE

hideInTable

Whether the form field is hidden during data display; default is FALSE

relevanceRule

Relevance rules for the form field given as a single character string; default is ""

validationRule

Validation rules for the form field given as a single character string; default is ""

reviewerOnly

Whether the form field is for reviewers only; default is FALSE

See Also

Other field schemas: attachmentFieldSchema(), barcodeFieldSchema(), calculatedFieldSchema(), dateFieldSchema(), formFieldSchema(), geopointFieldSchema(), monthFieldSchema(), multipleSelectFieldSchema(), quantityFieldSchema(), referenceFieldSchema(), sectionFieldSchema(), serialNumberFieldSchema(), singleSelectFieldSchema(), subformFieldSchema(), userFieldSchema(), weekFieldSchema()


bedatadriven/activityinfo-R documentation built on Dec. 21, 2024, 8:23 a.m.