Attributes

Plugin

Attribute Description
name Plugin name
author Author name
description Plugin description.

Runtime

Attribute Description
packageName Name of the generated JAR file
pluginClassName Class path of the plugin. Case-sensitive and must match the class name
enabled Whether the plugin is enabled. True means enabled, False means disabled

TaskBar

Attribute Description
id Unique identifier. TaskBars from different config files with same ID will be merged
index Index controlling loading order

Ribbon

Attribute Description
id Unique identifier. Ribbons from different config files with same ID will be merged
index Index controlling loading order
label The visible text
visible Whether the control is visible. True means visible, False means hidden
formClass Ribbon-bound window. The associated Ribbon will display when opening corresponding window. Hidden by default

Group

Attribute Description
id Unique identifier. Groups from different config files with same ID will be merged
index Index controlling loading order
label The visible text
visible Whether the control is visible. True means visible, False means hidden
image Displayed image information

Gallery

Attribute Description
id Unique identifier. Galleries from different config files with same ID will be merged
index Index controlling loading order
label The visible text
popupColumn Maximum number of controls displayed per row. Excess controls will wrap to new line

GalleryGroup

Attribute Description
id Unique identifier. GalleryGroups from different config files with same ID will be merged
index Index controlling loading order
label The visible text
maxLength Maximum display text length. Longer texts will be truncated

FlowGroup

Attribute Description
id Unique identifier. FlowGroups from different config files with same ID will be merged
index Index controlling loading order
label The visible text
visible Whether the control is visible. True means visible, False means hidden
image Displayed image information
rowCount Number of rows for layout (range: 1-3)

StartMenuPanel

Attribute Description
id Unique identifier
index Index controlling loading order
Label The visible text
component Class path of the implemented StartMenuPanel
visible Whether the control is visible. True means visible, False means hidden

StartMenu

Attribute Description
id Unique identifier
index Index controlling loading order
Label The visible text
onAction CtrlAction name
visible Whether the control is visible. True means visible, False means hidden

SecondMenu

Attribute Description
index Index controlling loading order
Label The visible text

ProcessGroup

Attribute Description
id Unique identifier. ProcessGroups from different config files with same ID will be merged
index Index controlling loading order
title The visible text
Platform Supported OS platforms: Windows, Linux, All. Windows represents Windows-only support, Linux for Linux-only, All for all platforms. Default is All
ScreenTip Detailed description information

Process

Attribute Description
ClassName Class path
index Index controlling loading order
title The visible text
key Unique process identifier (must be unique)
ScreenTip Process text description
Platform Supported OS platforms: Windows, Linux, All. Windows represents Windows-only support, Linux for Linux-only, All for all platforms. Default is All

Button

Attribute Description
checkState Whether the control is checked. True means checked, False means unchecked
customProperty User-definable attributes
image Displayed image information
index Index controlling loading order
label The visible text
onAction CtrlAction name
screenTip Text description
screenTipImage Image description
shortcutKey Shortcut key for function response
visible Whether the control is visible. True means visible, False means hidden
id Unique identifier. Buttons from different config files with same ID will be merged
style Control size: big (image above text), medium (image and text inline), small (image only)
Platform Supported OS platforms: Windows, Linux, All. Windows represents Windows-only support, Linux for Linux-only, All for all platforms. Default is All

ButtonDropDown

Attribute Description
id Unique identifier. ButtonDropDowns from different config files with same ID will be merged
image Displayed image information
index Index controlling loading order
label The visible text
visible Whether the control is visible. True means visible, False means hidden

ColorButton

Attribute Description
checkState Whether the control is checked. True means checked, False means unchecked
customProperty User-definable attributes
image Displayed image information
index Index controlling loading order
label The visible text
onAction CtrlAction name
screenTip Text description
screenTipImage Image description
shortcutKey Shortcut key for function response
visible Whether the control is visible. True means visible, False means hidden
style Control size: big (image above text), medium (image and text inline), small (image only)

GalleryButton

Attribute Description
checkState Whether the control is checked. True means checked, False means unchecked
customProperty User-definable attributes
image Image information displayed on control
index Index controlling loading order
label The visible text
onAction CtrlAction name
screenTip Text description
screenTipImage Image description
shortcutKey Shortcut key for function response
visible Whether the control is visible. True means visible, False means hidden
size Control size: large, normal, small

DropDownPanelButton

Attribute Description
checkState Whether the control is checked. True means checked, False means unchecked  
customProperty User-definable attributes  
image Image information displayed on control
index Index controlling loading order
label The visible text
onAction CtrlAction name
screenTip Text description
screenTipImage Image description
shortcutKey Shortcut key for function response
visible Whether the control is visible. True means visible, False means hidden
style Control size: big (image above text), medium (image and text inline), small (image only)

RibbonPopupMenuItem

Attribute Description
checkState Whether the control is checked. True means checked, False means unchecked
customProperty User-definable attributes
image Image information displayed on control
index Index controlling loading order
label The visible text
onAction CtrlAction name
screenTip Text description
screenTipImage Image description
shortcutKey Shortcut key for function response
visible Whether the control is visible. True means visible, False means hidden

Separator

Attribute Description
index Index controlling loading order

RibbonPopupMenuSeparator

Attribute Description
index Index controlling loading order
label The visible text
customProperty User-definable attributes

ComboBox/ ComboBoxFont

Attribute Description
customProperty User-definable attributes
index Index controlling loading order
label The visible text
width Control width
onAction CtrlAction name
editable Whether the control is editable. True means editable, False means read-only
screenTipImage Image description
shortcutKey Shortcut key for function response
visible Whether the control is visible. True means visible, False means hidden

RibbonPopupMenuComboBox

Attribute Description
checkState Whether the control is checked. True means checked, False means unchecked
customProperty User-definable attributes
image Displayed image information
index Index controlling loading order
label The visible text
onAction CtrlAction name
screenTip Text description
screenTipImage Image description
shortcutKey Shortcut key for function response
visible Whether the control is visible. True means visible, False means hidden
style Control size: big (image above text), medium (image and text inline), small (image only)

Item

Attribute Description
index Index controlling loading order
label The visible text
data Stored value
image Displayed image information
customProperty User-definable attributes

Label

Attribute Description
customProperty User-definable attributes
index Index controlling loading order
label The visible text
width Control width
screenTip Text description
screenTipImage Image description
visible Whether the control is visible. True means visible, False means hidden

Spinner

Attribute Description
customProperty User-definable attributes
index Index controlling loading order
label The visible text
width Control width
onAction CtrlAction name
minValue Minimum allowed value
maxValue Maximum allowed value
increment Step value for increase/decrease
editable Whether the control is editable. True means editable, False means read-only
screenTipImage Image description
shortcutKey Shortcut key for function response
visible Whether the control is visible. True means visible, False means hidden

DockBar

Attribute Description
component DockBar class path  

dockDirection DockBar position options: left, bottom, right. Determines display position on desktop id Unique identifier title DockBar title visible Whether the control is visible. True means visible, False means hidden

ContenMenu

Attribute Description
id Unique identifier (must be unique)
label Context menu

StatusBar

Attribute Description
id Unique identifier. StatusBars from different config files with same ID will be merged
visible Whether the control is visible. True means visible, False means hidden
formClass StatusBar-bound window. The associated StatusBar will display at window bottom when opening corresponding window. Hidden by default

Textbox

Attribute Description
customProperty User-definable attributes
index Index controlling loading order
label The visible text
text Text content displayed in Textbox
width Control width
visible Whether the control is visible. True means visible, False means hidden
onAction CtrlAction name

Related Topics

Environment Deployment

Project Template

Plugin Configuration Overview

Interface Configuration

Ribbon Configuration

Configure Start Menu

Configure Status Bar

Configure Context Menu

Configure Dock Bars