Configurable UI

Version 12

• button
  • cssClass
  • cssStyle (object)
  • clickEventType (string): mousedown, click
  • disabled (boolean)
  • hidden (boolean)
  • id
  • image
  • label
  • state (boolean)
  • tooltip_template
• date
  • disabled (boolean)
  • id
  • size: width string
  • tooltip_template
  • value: the default value
• dropdownButton
  • id
  • options
    • label
    • value
  • text
• image
  • cssClass
  • image
• separator (no options)
• select
  • disabled (boolean)
  • id
  • label
  • options
    • label
    • value
  • selectedIndex
  • tooltip_template
• singular
  • disabled (boolean)
  • id
  • value
• text
  • cssClass
  • id
  • label
  • tooltip_template
• textbox
  • cssClass
  • disabled (boolean)
  • id
  • image
  • invalid (boolean)
  • label
  • size: number (in rem)
  • tooltip_template
  • value: the value

Arguments

• control (HtmlElement): (e.g. <aras-toolbar>...</aras-toolbar>)
• target (Object):
  • @id: string (item id)
  • @type: string
  • @typeId: string
  • additional_data: object
  • id: string (name)
  • item_classification: string
  • itemtype: string
  • label: string
  • name: string
  • on_click_handler: string (id)
  • on_click_handler@keyed_name: string
  • on_click_handler@type: string
  • on_init_handler: string (id)
  • on_init_handler@keyed_name: string
  • on_init_handler@type: string
  • section: string (id)
  • section@keyed_name: string
  • sort_order: string
  • type: string
• options
  • control (see control above)
  • currentTarget (see target above)
  • itemId: string (id)
  • itemTypeId: string (id)
  • itemTypeName: string
  • item_classification: string
  • target (see target above)
  • rowId: string (id)
  • selectedRowsIds: array[string (id)]

Version 11

Index

• buttonsize (string): example 26,25
• buttonstyle (string): example windows
• color_value (string): HTML color value
• cui_base_class
• cui_checked (boolean)
• cui_class (string): CSS class name
• cui_disabled (string): true or false
• cui_icon_class
• cui_invisible (boolean)
• cui_placeholder (string)
• cui_resource_key
• cui_resource_solution
• cui_style (string): CSS style string
• cui_type
• default_color_value (string): example true
• default_size_value (string): example true
• font (string): example Arial-8
• label_position (string): example right
• on_click (string)
• on_load (string)
• preventBlur (boolean)
• preventDefault (boolean)
• right
• size_value (string): example small, medium, large
• size (string): Integer
• state
• stopPropagation (boolean)
• text (string)
• textbox_type (string): example number, zoom
• tp_buttonsize (string): example 26,25
• tp_buttonstyle (string): example windows
• tp_handler (string): example tp_link_dialog
• tp_list (string): GUID, used for the tech doc toolbar
• tp_use_separator (string): 0 or 1, used for the tech doc toolbar
• useCapture (boolean)

CommandBarButton

• color_value (string): HTML color value
• cui_class (string): CSS class name
• cui_disabled (string): true or false
• cui_invisible (boolean)
• cui_style (string): CSS style string
• default_color_value (string): example true
• default_size_value (string): example true
• size_value (string): example small, medium, large
• tp_use_separator (string): 0 or 1, used for the tech doc toolbar

CommandBarDropDown

• tp_list (string): GUID, used for the tech doc toolbar

CommandBarEdit

• cui_placeholder (string)
• label_position (string): example right
• size (string): Integer
• text (string)
• textbox_type (string): example number, zoom

CommandBarMenuButton

• cui_disabled (boolean)

CommandBarMenuCheckbox

• cui_checked (boolean)

CommandBarSection

• buttonstyle (string): example windows
• buttonsize (string): example 26,25
• tp_buttonsize (string): example 26,25
• tp_buttonstyle (string): example windows
• tp_handler (string): example tp_link_dialog
• on_load (string)
• on_click (string)
• font (string): example Arial-8

CommandBarShortcut

• useCapture (boolean)
• preventBlur (boolean)
• preventDefault (boolean)
• stopPropagation (boolean)

Arguments

inArgs: {
  control : {
    name, // string
    additionalData // JSON string
  },
  itemTypeId, // string
  itemId, // string
  isReinit, // boolean
  eventType, // string [ "SelectInToc", "SelectInGrid", "UpdateTearOffWindowState" ]
  eventState: {
    InBasketEventState,
    isPurge,
    canBeLocked,
    isEdit,
    isDiscoverOnly,
    isUnlock,
    isCanAdd,
    isLocked,
    isTemp,
    isSave,
    isCopy,
    isUndo,
    isView,
    isLock,
    isPromote,
    isRevision,
    isDiscussion
  }
}