Skip to main content

Legacy form elements: QBL v0.5

Important

QBL version 0.5 is only supported for these APIs:

It is not supported when updating solutions, or listing solution changes.

This article contains information about a QBL (Quickbase language) object. QBL objects are the supported Quickbase schema elements you see textually represented in the YAML file generated by Quickbase when you export a solution. Each object has associated properties. Supported schema may differ by QBL version.

The following table lists information about the properties of this object. 

In this article

Form

Property Name Required Default Allowed Values
Name True None Any string
ShowBuiltInFields False True true or false
HorizontalRuleBetweenSections False True true or false
WrapFieldLabels False False true or false
ShowSaveAndCancelButtons False True true or false
ShowSaveAndKeepWorking False False true or false
WaitForEmbeddedReports False UseAppBehavior One of: UseAppBehavior, DisplayFormThenLoad, LoadFormThenDisplay
NewFieldAction False DoNotAdd One of: DoNotAdd, Prompt, Add

Form element: Address field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::Address
HideMap False False true or false

Form element: Checkbox field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::Checkbox

Form element: Currency field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::Currency

Form element: Date field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::Date

Form element: Date time field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::DateTime or QB::Field::DateCreated or QB::Field::DateModified

Form element: Duration field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::Duration

Form element: Email field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::Email

Form element: Field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field

Form element: File attachment field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::FileAttachment

Form element: Formula field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Field True None

Reference to {"logical_type":"Field","except":
["QB::Field::Address","QB::Field::AddressCity","QB::Field::AddressCountry",

"QB::Field::AddressPostalCode","QB::Field::AddressState","QB::Field::AddressStreet1",

"QB::Field::AddressStreet2","QB::Field::Checkbox","QB::Field::Currency","QB::Field::Date",

"QB::Field::DateTime","QB::Field::Duration","QB::Field::Email","QB::Field::FileAttachment",

"QB::Field::ListUser","QB::Field::Lookup","QB::Field::MultiselectText","QB::Field::Number",

"QB::Field::Percent","QB::Field::PhoneNumber","QB::Field::Predecessor","QB::Field::Rating",

"QB::Field::Reference","QB::Field::ReferenceProxy","QB::Field::ReportLink","QB::Field::RichText",

"QB::Field::Summary","QB::Field::Text","QB::Field::TextMultiline","QB::Field::TextMultipleChoice",

"QB::Field::TimeOfDay","QB::Field::URL","QB::Field::User","QB::Field::WorkDate",

"QB::Field::DateCreated","QB::Field::DateModified","QB::Field::LastModifiedBy",

"QB::Field::RecordID","QB::Field::RecordOwner","QB::Field::Unsupported"]}

Form element: List user field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::ListUser

Form element: Lookup field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Field True None Reference to QB::Field::Lookup or QB::Field::Unsupported
HideMap False False true or false

Form element: Multi-select text field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::MultiselectText

Form element: Number field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::Number or QB::Field::RecordID

Form element: Percent field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::Percent

Form element: Phone number field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::PhoneNumber

Form element: Predecessor field

Property Name Required Default Allowed Values
EmbeddedView False Default One of: Default
    Editable False None None
    MaxHeightInPixels False None None
    RowsToDisplay False None None
    TargetReport False None None
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::Predecessor

Form element: Rating field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
    Edit False True true or false
    Add False True true or false
    View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::Rating

Form element: Reference field

Property Name Description Required Default Allowed Values
BaseRecordPickerOn Select the field or query to base the record picker on False Default One of: Default, Unsupported
Reference to Report or Report or Chart or Chart or Field or Field
EmbeddedView   False Default One of: Default
    Editable   False None  
    MaxHeightInPixels   False None  
    RowsToDisplay   False None  
    TargetReport   False None  
Label   False "" Any string
DisplayOn   False None See nested properties
    Edit   False True true or false
    Add   False True true or false
    View   False True true or false
Required   False False true or false
ReadOnly   False False true or false
Field   True None Reference to QB::Field::Reference or QB::Field::Unsupported

Form element: Reference proxy field

Property Name Description Required Default Allowed Values
BaseRecordPickerOn Select the field or query to base the record picker on False Default One of: Default, Unsupported
Reference to Report or Report or Chart or Chart or Field or Field
Label   False "" Any string
DisplayOn   False None See nested properties
    Edit   False True true or false
    Add   False True true or false
    View   False True true or false
Required   False False true or false
ReadOnly   False False true or false
Field   True None

Reference to {"logical_type":"Field","except":

["QB::Field::Address","QB::Field::AddressCity","QB::Field::AddressCountry",

"QB::Field::AddressPostalCode","QB::Field::AddressState","QB::Field::AddressStreet1",

"QB::Field::AddressStreet2","QB::Field::Checkbox","QB::Field::Currency",

"QB::Field::Date", "QB::Field::DateTime","QB::Field::Duration","QB::Field::Email",

"QB::Field::FileAttachment", "QB::Field::ListUser","QB::Field::MultiselectText",

"QB::Field::Number", "QB::Field::Percent","QB::Field::PhoneNumber",

"QB::Field::Predecessor","QB::Field::Rating", "QB::Field::Reference",

"QB::Field::ReferenceProxy","QB::Field::ReportLink", "QB::Field::RichText",

"QB::Field::Summary","QB::Field::Text","QB::Field::TextMultiline",

"QB::Field::TextMultipleChoice","QB::Field::TimeOfDay","QB::Field::URL","QB::Field::User",

"QB::Field::WorkDate","QB::Field::DateCreated","QB::Field::DateModified",

"QB::Field::LastModifiedBy","QB::Field::RecordID","QB::Field::RecordOwner"]}

Form element: Report link field

Property Name Required Default Allowed Values
EmbeddedView False Default One of: Default
   Editable False    
   MaxHeightInPixels False    
   RowsToDisplay False    
   TargetReport False    
Label False "" Any string
DisplayOn False None See nested properties
   Edit False True true or false
   Add False True true or false
   View False True true or false
Field True   Reference to QB::Field::ReportLink

Form element: Rich text field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
   Edit False True true or false
   Add False True true or false
   View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::RichText

Form element: Section

Property Name Required Default Allowed Values
Heading False "" Any string
Collapse False False true or false
DisplayOn False None See nested properties
   Edit False True true or false
   Add False True true or false
   View False True true or false
LabelPosition False AboveField One of: AboveField, LeftOfField

Form element: Summary field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
   Edit False True true or false
   Add False True true or false
   View False True true or false
Field True None Reference to QB::Field::Summary or QB::Field::Unsupported

Form element: Tab

Property Name Required Default Allowed Values
Label False "" Any string
Color False "" Any string

Form element: Text

Property Name Required Default Allowed Values
Text False "" Any string
IsHTML False False true or false
DisplayOn False None See nested properties
Edit False True true or false
Add False True true or false
View False True true or false

Form element: Text field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
Edit False True true or false
Add False True true or false
View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::Text

Form element: Text multi-line field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
Edit False True true or false
Add False True true or false
View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::TextMultiline

Form element: Text multiple choice field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
Edit False True true or false
Add False True true or false
View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::TextMultipleChoice
DisplayChoicesAsRadioButtons False False true or false

Form element: Time of day field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
Edit False True true or false
Add False True true or false
View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::TimeOfDay

Form element: URL field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
Edit False True true or false
Add False True true or false
View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::URL

Form element: User field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
Edit False True true or false
Add False True true or false
View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::User or QB::Field::LastModifiedBy or QB::Field::RecordOwner

Form element: Work date field

Property Name Required Default Allowed Values
Label False "" Any string
DisplayOn False None See nested properties
Edit False True true or false
Add False True true or false
View False True true or false
Required False False true or false
ReadOnly False False true or false
Field True None Reference to QB::Field::WorkDate

Related articles

Top