Interface iViewBox

Description of a single box in the object detail

interface iViewBox {
    _hint?: string;
    _readonly?: boolean;
    _right?: boolean;
    _tooltip?: string;
    _translation?: string;
    attributes?: iAttributes;
    buttons?: string[];
    collapse?: boolean;
    editable?: string;
    help?: string;
    icon?: string;
    infoText?: string;
    label?: string | boolean;
    name: string;
    no?: string;
    order?: string;
    readonly?: string;
    right?: string;
    shortcut?: string;
    showTitle?: boolean;
    singleItem?: boolean;
    style?: string | object;
    tab?: string;
    type?: "userAttributes";
    uright?: string;
    view?: string | detailAttr;
    visible?: string;
    where?: string;
}

Hierarchy (view full)

Properties

_hint? _readonly? _right? _tooltip? _translation? attributes? buttons? collapse? editable? help? icon? infoText? label? name no? order? readonly? right? shortcut? showTitle? singleItem? style? tab? type? uright? view? visible? where?

Properties

Optional _hint

_hint?: string

Optional _readonly

_readonly?: boolean

Optional _right

_right?: boolean

Optional _tooltip

_tooltip?: string

Optional _translation

_translation?: string

Optional attributes

attributes?: iAttributes

Optional attributes placed to the box Attributes described in the box does not have box fiels!

Optional buttons

buttons?: string[]

Optional collapse

collapse?: boolean

Sign if box is collapsible:

  • parameter not defined: box has no collapse option
  • false box has collapse option and is open
  • true box has collapse option and is collapsed when detail is open

Notes:

  • collapse button should have name. if name is not allowed, collapse is ignored

Optional editable

editable?: string

Optional help

help?: string

Optional help file for box. Only name of the file withouth md extension is accepted. (neither bool value nor the complete path.)

Optional icon

icon?: string

Optional infoText

infoText?: string

Optional text visible in the title of the collapsed box - Always evaluated command Use the info text to show basic information if something inportant in is in th collapsed box

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 no

no?: string

Optional order

order?: string

optional element order

Optional readonly

readonly?: string

Optional right

right?: string

Right to see the content - evaluated only for existing objects not for new! When both visible and right is defined, visible is evaluated at first and then also right and both should return true

Optional shortcut

shortcut?: string

Optional shortcut

Optional showTitle

showTitle?: boolean

Optional singleItem

singleItem?: boolean

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 tab

tab?: string

Optional type

type?: "userAttributes"

optional type allow definition of spectial box types. By default boxes have not type

Optional uright

uright?: string

Optional view

view?: string | detailAttr

boxes where is only a single view can contain view attributes description as a part of the view

WARNING: Currently does not support any attributes that should be processed by server - data attributes!

Optional visible

visible?: string

Condition, when visible and when not; evaluated both for new object and existing objects

Optional where

where?: string

Optional where conditions for view - works of list views and later may be also cliplists

Settings

Member Visibility

Theme

On This Page

_hint_readonly_right_tooltip_translationattributesbuttonscollapseeditablehelpiconinfoTextlabelnamenoorderreadonlyrightshortcutshowTitlesingleItemstyletabtypeurightviewvisiblewhere