Interface detailAttr

description of the detail attribute Extension contains attributes available only for detail not list

interface detailAttr {
    UIdataEl?: object;
    UIdataElType?: IntUIdataElType;
    _enabled?: boolean;
    _enumLimit?: string;
    _hint?: string;
    _readonly?: boolean;
    _tooltip?: string;
    _translation?: string;
    _visible: boolean;
    a?: string;
    alwaysSendServer?: boolean;
    block?: string;
    blockStyle?: object;
    box?: string;
    buttons?: string[];
    dataAttr: iDataAttribute;
    default?: string | false;
    editable?: string;
    enabled?: string | boolean;
    enum?: string;
    enumLimit?: string;
    enumType?: iattrDataType;
    eval?: string;
    hidden?: boolean;
    hitem?: HTMLElement;
    icon?: string;
    label?: string | boolean;
    name: string;
    newValue?: string;
    noSave?: boolean;
    oldValue?: string;
    onLeave?: string;
    oper?: string;
    order?: string;
    placeholder?: string;
    readonly?: string | boolean;
    required?: boolean;
    right?: string;
    short?: boolean;
    shortcut?: string;
    small?: boolean;
    source?: iobjAttrDataSource;
    strangeEval?: string;
    style?: object;
    type?: iattrDataViewType;
    view?: string;
    visible?: string | boolean;
    whenVisible?: "RO" | "WO" | "NO" | "always";
}

Hierarchy (view full)

Properties

UIdataEl? UIdataElType? _enabled? _enumLimit? _hint? _readonly? _tooltip? _translation? _visible a? alwaysSendServer? block? blockStyle? box? buttons? dataAttr default? editable? enabled? enum? enumLimit? enumType? eval? hidden? hitem? icon? label? name newValue? noSave? oldValue? onLeave? oper? order? placeholder? readonly? required? right? short? shortcut? small? source? strangeEval? style? type? view? visible? whenVisible?

Properties

Optional UIdataEl

UIdataEl?: object

Optional UIdataElType

UIdataElType?: IntUIdataElType

type of the element in the UIdateEl - internal, never loaded

Optional _enabled

_enabled?: boolean

internal represetnation of the disabled field

Optional _enumLimit

_enumLimit?: string

Optional _hint

_hint?: string

Optional _readonly

_readonly?: boolean

readonly status calculated from readonly (Note: not calculated for list views, only for detail)

Optional _tooltip

_tooltip?: string

Optional _translation

_translation?: string

_visible

_visible: boolean

visibility status calculated from visible - use ths value to hide or show columns

Optional a

a?: string

action that is started by click or self-defined view command

  • When used together with the field in the list, system creates a button that activates operation
  • When used in the detail with the item of the view type, it is used instead of view defition in view. Here can be used any a... command.
    • Link can freely defined and even evaluated by fval. When evaluated by fval, it allow total control over the attributes, but it does not get default attributes!
    • @example: object linked if the tskReminder
    • It can manage readonly settings and e.g. allow to have view item editable even when master object is readonly
    • @example: tskRelTaskUser linked in tskTask

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 block

block?: string

Optional name of the block. Use block to get more small items to single line User blockStyle to set the style of the block

Optional blockStyle

blockStyle?: object

Style applied to the block blockStyle is always applied only with the first attribute. When block is created the style from next placed block is never applied

Optional box

box?: string

string or number of box in which the attribute is placed DEPRECIATED: Do not use box but split attribute to the box definitinos

Optional buttons

buttons?: string[]

dataAttr

dataAttr: iDataAttribute

Optional default

default?: string | false

Default value for field when object is new. Equal with dataAttribute.default Use only in case that there is more views and default value is different for them User false value of fields to disable using default value

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

Optional enabled

enabled?: string | boolean

Optional attributes says that attributes should be totally ignored and view behaves as as attribute doesn't exists Use when extneding object should ignore some attributes from parent object WARNING: Curently implemented only for listView, detail does not yet supported it

Optional enum

enum?: string

Optional name of enum Uses id dataAttribute is not defined or view uses different enum

Optional enumLimit

enumLimit?: string

Optional name of the condition use to select part of the filter if contains = it is expected to be condition usef to evaluate - see enumLimit description at data attribute

Optional enumType

enumType?: iattrDataType

Optional enum type used in case that field is not from object (no dataAttr)

Optional eval

eval?: string

Iptional evaluation string - field can be evaluated before it is placed to the field; Should contain string evaluated with fields from row; supported by list and detail - for detail it make sense with readonly:true or some other type of content ocntrol

Optional hidden

hidden?: boolean

user settings to hide the column - used only for list view - user can change this value and value is stored in the browser memory

Optional hitem

hitem?: HTMLElement

Optional icon

icon?: string

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

name

name: string

Optional newValue

newValue?: string

Optional noSave

noSave?: boolean

Optinal attributes mark fields that are not from database and could not be saved. Use that for fields that are modified on the client application but shall not be saved because they are not from object table and save is made in som other way

  • Let's note that it is only rarely necessary, because strange items are mostly not updated and so never goes to the save
  • Field is not evaluated! use true for strange field that makes trouble during saving

Optional oldValue

oldValue?: string

Optional onLeave

onLeave?: string

Name of the object operation started when user leaves the item

  • use enabled attributes of the operation to check if operaion should be started or not. evaluation of the enabled string gets actual state of the object Enabled field is evalauted everytime when user leaves the item

Optional oper

oper?: string

Name of the operation linked with the attribute; used in the list (or lately also detail view attributes) Not supported in detail. User buttons:[] in detail Allowed content is:

  • name of the operation defined in object (e.g. tunEtwas), (for detail not yet implemented)
  • openSelfDetail, openSelfClip, openSelfModalDetail - only list
  • form.object.viewtype....., other operation except form are not allowed - only list

Optional order

order?: string

Optional order string used to order attributes

Optional placeholder

placeholder?: string

optional placeholder text in the field Always translated, not evaluated

Optional readonly

readonly?: string | boolean

Visible but not editable - used in the json defition file and converted to the _readonly according to the data. Do not use it with the data processing in the view

Optional required

required?: boolean

When true, field is considered to be required reqardless on the data attribute settings

Optional right

right?: string

The same as visible

Optional short

short?: boolean

When true it says the input is for short - up to 5 digits and field could be also short Makes sense only for text-like fields like string and number and listbox

Optional shortcut

shortcut?: string

Optional shortcut

Optional small

small?: boolean

Optional source

source?: iobjAttrDataSource

Optional attribute source

Optional strangeEval

strangeEval?: string

Optional eval values used for strange object; eval is never used for strange Used only in list table

Optional style

style?: object

optional style for element See style option for boxElements for more details about the field

__Warning: supported currently only for view, image and some text fields;

  • Explicitly not supported for any object/file picker and event not for markdown editor

Optional type

type?: iattrDataViewType

Optional view type that describes, how to present value

Optional view

view?: string

optional atribute that allows specify clip to open. @example: oper:"form.sysUser" view:"sysUser.clip." @example: "view":"form.tskDefUserTask.detail.default(readonly:viewDef=true,location=modalSecond)"

Optional visible

visible?: string | boolean

system setting, that the row is necessary but not visible to allow e.g. keys for detail open - user cannot change this value; do not use the value, but use _visible instead of that

Optional whenVisible

whenVisible?: "RO" | "WO" | "NO" | "always"

Optional field allows limits when field is visible. Don't set the value in default state when field shall be visible both in read and write mode

Settings

Member Visibility

Theme

On This Page

UIdataElUIdataElType_enabled_enumLimit_hint_readonly_tooltip_translation_visibleaalwaysSendServerblockblockStyleboxbuttonsdataAttrdefaulteditableenabledenumenumLimitenumTypeevalhiddenhitemiconlabelnamenewValuenoSaveoldValueonLeaveoperorderplaceholderreadonlyrequiredrightshortshortcutsmallsourcestrangeEvalstyletypeviewvisiblewhenVisible