Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UIField

An object that represents a UI field

Hierarchy

  • UIField

Accessors

Methods

Accessors

accessory

  • get accessory(): string
  • set accessory(value: string): void

  • The field's accessory

    example

    For Currency Type this will return the configured currency sign (eg. $)

    Returns string

  • The field's accessory

    Parameters

    • value: string

    Returns void

backgroundColor

  • get backgroundColor(): string
  • set backgroundColor(value: string): void

  • the field background color

    Returns string

  • the field background color

    Parameters

    • value: string

    Returns void

decimalDigits

  • get decimalDigits(): number
  • set decimalDigits(value: number): void

  • The amount of digits for a decimal field

    Returns number

  • The amount of digits for a decimal field

    Parameters

    • value: number

    Returns void

events

  • get events(): object
  • set events(value: object): void

  • the field events

    example

    For a TSA Button this will return

    {
     "OnClick": {
         "Key": "TSAButton",
         "Data": {
             "DataObject": {
                 "UUID": "",
                 "Resource": {
                     "Type": "activities",
                     "Name": "new activity"
                 },
                 "FieldID": "TSASomeButton"
             }
         }
     }
}

    Returns object

    • [key: string]: object
      • Data: any
      • Key: string

  • the field events

    Parameters

    • value: object
      • [key: string]: object
        • Data: any
        • Key: string

    Returns void

fieldID

  • get fieldID(): string

  • The field's ID aka APIName

    Returns string

formattedValue

  • get formattedValue(): string
  • set formattedValue(value: string): void

  • The field's formatted value

    This is the value used when the field is not editable

    Returns string

  • The field's formatted value

    This is the value used when the field is not editable

    Parameters

    • value: string

    Returns void

highlighted

  • get highlighted(): boolean
  • set highlighted(value: boolean): void

  • true if the field is highlighted

    Returns boolean

  • true if the field is highlighted

    Parameters

    • value: boolean

    Returns void

mandatory

  • get mandatory(): boolean
  • set mandatory(value: boolean): void

  • true if the field should be mandatory

    Returns boolean

  • true if the field should be mandatory

    Parameters

    • value: boolean

    Returns void

optionalValues

  • get optionalValues(): object[]
  • set optionalValues(value: object[]): void

  • The field's optional values

    usage

    Used in drop downs

    Returns object[]

  • The field's optional values

    Parameters

    • value: object[]

    Returns void

readonly

  • get readonly(): boolean
  • set readonly(value: boolean): void

  • true if the field is readonly

    Returns boolean

  • true if the field is readonly

    Parameters

    • value: boolean

    Returns void

textColor

  • get textColor(): string
  • set textColor(value: string): void

  • the field text color

    Returns string

  • the field text color

    Parameters

    • value: string

    Returns void

title

  • get title(): string
  • set title(value: string): void

  • The field's title

    Returns string

  • The field's title

    Parameters

    • value: string

    Returns void

type

  • get type(): "None" | "TextBox" | "LimitedLengthTextBox" | "TextArea" | "TextHeader" | "Date" | "DateAndTime" | "NumberInteger" | "NumberReal" | "Currency" | "Boolean" | "ComboBox" | "MultiTickBox" | "Separator" | "Address" | "Percentage" | "EmptyComboBox" | "InternalLink" | "Email" | "LimitedDate" | "Image" | "MultiTickBoxToComboBox" | "EmptyMultiTickBox" | "Totals" | "Attachment" | "Signature" | "Link" | "ImageURL" | "NumberIntegerQuantitySelector" | "NumberRealQuantitySelector" | "NumberIntegerForMatrix" | "NumberRealForMatrix" | "Images" | "Indicators" | "CalculatedReal" | "CalculatedInt" | "CalculatedString" | "CalculatedDate" | "CalculatedBool" | "MapDataDropDown" | "MapDataReal" | "MapDataString" | "MapDataInt" | "Sum" | "Phone" | "UrlForApi" | "ManyToManyUrlForApi" | "ReferenceType" | "GuidReferenceType" | "Button" | "UIControlFieldType_InternalPage" | "Duration" | "ListOfObjects" | "Package" | "RelatedObjectsCards" | "BooleanText" | "RichTextHTML"
  • set type(inType: "None" | "TextBox" | "LimitedLengthTextBox" | "TextArea" | "TextHeader" | "Date" | "DateAndTime" | "NumberInteger" | "NumberReal" | "Currency" | "Boolean" | "ComboBox" | "MultiTickBox" | "Separator" | "Address" | "Percentage" | "EmptyComboBox" | "InternalLink" | "Email" | "LimitedDate" | "Image" | "MultiTickBoxToComboBox" | "EmptyMultiTickBox" | "Totals" | "Attachment" | "Signature" | "Link" | "ImageURL" | "NumberIntegerQuantitySelector" | "NumberRealQuantitySelector" | "NumberIntegerForMatrix" | "NumberRealForMatrix" | "Images" | "Indicators" | "CalculatedReal" | "CalculatedInt" | "CalculatedString" | "CalculatedDate" | "CalculatedBool" | "MapDataDropDown" | "MapDataReal" | "MapDataString" | "MapDataInt" | "Sum" | "Phone" | "UrlForApi" | "ManyToManyUrlForApi" | "ReferenceType" | "GuidReferenceType" | "Button" | "UIControlFieldType_InternalPage" | "Duration" | "ListOfObjects" | "Package" | "RelatedObjectsCards" | "BooleanText" | "RichTextHTML"): void

  • The field's Type

    Returns "None" | "TextBox" | "LimitedLengthTextBox" | "TextArea" | "TextHeader" | "Date" | "DateAndTime" | "NumberInteger" | "NumberReal" | "Currency" | "Boolean" | "ComboBox" | "MultiTickBox" | "Separator" | "Address" | "Percentage" | "EmptyComboBox" | "InternalLink" | "Email" | "LimitedDate" | "Image" | "MultiTickBoxToComboBox" | "EmptyMultiTickBox" | "Totals" | "Attachment" | "Signature" | "Link" | "ImageURL" | "NumberIntegerQuantitySelector" | "NumberRealQuantitySelector" | "NumberIntegerForMatrix" | "NumberRealForMatrix" | "Images" | "Indicators" | "CalculatedReal" | "CalculatedInt" | "CalculatedString" | "CalculatedDate" | "CalculatedBool" | "MapDataDropDown" | "MapDataReal" | "MapDataString" | "MapDataInt" | "Sum" | "Phone" | "UrlForApi" | "ManyToManyUrlForApi" | "ReferenceType" | "GuidReferenceType" | "Button" | "UIControlFieldType_InternalPage" | "Duration" | "ListOfObjects" | "Package" | "RelatedObjectsCards" | "BooleanText" | "RichTextHTML"

  • As of today's views implentation, type changes are only allowed from 'NumberIntegerQuantitySelector' type to 'NumberRealQuantitySelector' type and vice verca. Trying to change type to/from something else will result in exception.

    Parameters

    • inType: "None" | "TextBox" | "LimitedLengthTextBox" | "TextArea" | "TextHeader" | "Date" | "DateAndTime" | "NumberInteger" | "NumberReal" | "Currency" | "Boolean" | "ComboBox" | "MultiTickBox" | "Separator" | "Address" | "Percentage" | "EmptyComboBox" | "InternalLink" | "Email" | "LimitedDate" | "Image" | "MultiTickBoxToComboBox" | "EmptyMultiTickBox" | "Totals" | "Attachment" | "Signature" | "Link" | "ImageURL" | "NumberIntegerQuantitySelector" | "NumberRealQuantitySelector" | "NumberIntegerForMatrix" | "NumberRealForMatrix" | "Images" | "Indicators" | "CalculatedReal" | "CalculatedInt" | "CalculatedString" | "CalculatedDate" | "CalculatedBool" | "MapDataDropDown" | "MapDataReal" | "MapDataString" | "MapDataInt" | "Sum" | "Phone" | "UrlForApi" | "ManyToManyUrlForApi" | "ReferenceType" | "GuidReferenceType" | "Button" | "UIControlFieldType_InternalPage" | "Duration" | "ListOfObjects" | "Package" | "RelatedObjectsCards" | "BooleanText" | "RichTextHTML"

    Returns void

value

  • get value(): string
  • set value(value: string): void

  • The field's value

    usage

    This is the value used when the field is editable

    warning

    Changing it will not change the field value on the DataObject

    Returns string

  • The field's value

    Parameters

    • value: string

    Returns void

visible

  • get visible(): boolean
  • set visible(value: boolean): void

  • true if the field should be visible

    Returns boolean

  • true if the field should be visible

    Parameters

    • value: boolean

    Returns void

Methods

toJSON

  • toJSON(): object

  • Returns object

    • Accessory: string
    • BackgroundColor: string
    • DecimalDigits: number
    • Events: object
      • [key: string]: object
        • Data: any
        • Key: string
    • FieldID: string
    • FormattedValue: string
    • Highlighted: boolean
    • Mandatory: boolean
    • OptionalValues: object[]
    • Readonly: boolean
    • TextColor: string
    • Title: string
    • Value: string
    • Visible: boolean

Generated using TypeDoc