Interface iDataAttribute

Description of the object field

WARNING: not a view field but object field!

interface iDataAttribute {
    _enumLimit?: string;
    _hint?: string;
    _tooltip?: string;
    _translation?: string;
    alwaysSendServer?: boolean;
    check?: string;
    checkWarn?: string;
    default?: string;
    editable?: string;
    enum?: string;
    enumLimit?: string;
    hint?: string;
    icon?: string;
    indexed?: boolean;
    label?: string | boolean;
    length?: number;
    name: string;
    options?: string[];
    order?: string;
    rEdit?: string;
    rVisible?: string;
    readonly?: string | boolean;
    remote?: string;
    required?: boolean;
    shortcut?: string;
    source?: iobjAttrDataSource;
    style?: string | object;
    table?: string;
    type: iattrDataType;
    unit?: string;
    unitField?: string;
    visible?: string | boolean;
    where?: string;
    whereForNew?: string;
}

Hierarchy (view full)

Properties

_enumLimit? _hint? _tooltip? _translation? alwaysSendServer? check? checkWarn? default? editable? enum? enumLimit? hint? icon? indexed? label? length? name options? order? rEdit? rVisible? readonly? remote? required? shortcut? source? style? table? type unit? unitField? visible? where? whereForNew?

Properties

Optional _enumLimit

_enumLimit?: string

optional evaluated enum limit should contain name of the field used in the enums. Field in the enum can be of the type bool or string, When string it is expected to be condition to evaluate when contains condition "=" at start, then it is evaluated before using as a condition when containt '='=conditiion'" first condition is evaluated to get the second one. Second is used as a condition evaluated for each enum attribute in this case enum fields are attributes in the evaluation (see crmAbstractSubject for example)

Optional _hint

_hint?: string

Optional _tooltip

_tooltip?: string

Optional _translation

_translation?: string

Optional alwaysSendServer

alwaysSendServer?: boolean

Optional mark requesting to send value of the field always to the serer When value s marked true, update always send value to the server - in the group field if modified and in the group attrParam when not modified Use when value is necessary for preUpdate/postUpdate function

Optional check

check?: string

Optional checkWarn

checkWarn?: string

Optional default

default?: string

item could have default value - string or some of the value patterns - calculated if value is null, makes senese with =, e.g. '@selfUserID', '=global.today + 1', evaluation has not any available object, has access to the object of the detail / list from which field was open

Optional editable

editable?: string

command evaluated in order to check if user can edit field. Negation of the readonly. Has lower priority and is disregarded in case that readonly is defined. Do not use both of them Not evaluated for new objects. User visible to hide elements not editable in the new object aka marks

Optional enum

enum?: string

Optional enumLimit

enumLimit?: string

Optional name of the field defined in the enum definition that is used to select which fields can be used and which cannot String is only name or condition; if condition it is evaluated and should return the name

Warning: evaluation not yet implemented

Optional hint

hint?: string

Optional icon

icon?: string

Optional indexed

indexed?: boolean

mark that table has index for this field - UNUSED

Optional label

label?: string | boolean

Optinonal commands about label false - no label is printed string - string to translate (used instead of fieldname) true - does not affects functionality (useless) evaluaated - (=obj.enumVal('x')) --- should return translated value, result is not translated. Remember that obj is empty (nevertheless defined) for new object

Optional length

length?: number

name

name: string

Optional options

options?: string[]

List of options that attribute might have. Extensible and objects with special implementation can extend list with its own options Options supported by framework:

  • parentLink - attribute is link to the parent in the hierarchical structure

Optional order

order?: string

optional element order

Optional rEdit

rEdit?: string

Optional rVisible

rVisible?: string

Optional readonly

readonly?: string | boolean

could limit, if the field is user-editable, when false, it can stil be updated by server functions but never directly by user; condition allowed; default false not evaluated / considered for new objects; use visible field to hide new objects fields

Optional remote

remote?: string

Optional required

required?: boolean

Optional shortcut

shortcut?: string

Optional shortcut

Optional source

source?: iobjAttrDataSource

Optional style

style?: string | object

className (in case thet style is string) or list of styles using htmlelements.style JS attributes

Example

style='box--dataImportant'  box--dataImportant should be defined class in the css styles

Example

syle={"maxWidth":"20em"}    set up the maxWidth style attribute for the box

Example

styl={"border":"=obj.status=='AC'?'solid':'none' "}

Optional table

table?: string

type

type: iattrDataType

Optional unit

unit?: string

optional unit value (like time etc.) unit value could be theoretically evaluated (kb, MB) but it is never recalculated during editing

Optional unitField

unitField?: string

Name of the object field with unit value

Optional visible

visible?: string | boolean

Optional where

where?: string

for links (remote ids) only - condition to select item

Optional whereForNew

whereForNew?: string

for links (remote ids) only - condition to select item used only in case that object is newly created

Settings

Member Visibility

Theme

On This Page

_enumLimit_hint_tooltip_translationalwaysSendServercheckcheckWarndefaulteditableenumenumLimithinticonindexedlabellengthnameoptionsorderrEditrVisiblereadonlyremoterequiredshortcutsourcestyletabletypeunitunitFieldvisiblewherewhereForNew