Difference between revisions of "Checklistview Gadget Attributes"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
Line 128: | Line 128: | ||
|- | |- | ||
|valign="top"|[[Data Attributes#Data source|Data source]]||The table and column that this CheckListView is bound to. If this checklist allows multiple selections, this should be a character column which will be updated with a comma separated list of selected items. | |valign="top"|[[Data Attributes#Data source|Data source]]||The table and column that this CheckListView is bound to. If this checklist allows multiple selections, this should be a character column which will be updated with a comma separated list of selected items. | ||
+ | |valign="top"|controlSource||valign="top"|Character | ||
|- | |- | ||
|valign="top"|[[Data Attributes#Default|Default]]||An optional default value as an expression, e.g. "" or 0. You can use this to initialize a default variable such as m.m_listValue. | |valign="top"|[[Data Attributes#Default|Default]]||An optional default value as an expression, e.g. "" or 0. You can use this to initialize a default variable such as m.m_listValue. | ||
+ | |valign="top"|defaultValue||valign="top"|Character | ||
|- | |- | ||
|valign="top"|[[Data Attributes#GroupBox caption|GroupBox caption]]||An optional caption for the GroupBox containing the CheckListView items | |valign="top"|[[Data Attributes#GroupBox caption|GroupBox caption]]||An optional caption for the GroupBox containing the CheckListView items | ||
+ | |valign="top"|headerLabels||valign="top"|Character | ||
|- | |- | ||
|valign="top"|[[Data Attributes#Allow multiple selections|Allow multiple selections]]||Allow multiple selections (True | False) | |valign="top"|[[Data Attributes#Allow multiple selections|Allow multiple selections]]||Allow multiple selections (True | False) | ||
+ | |valign="top"|treeCheckListMultiSelect||valign="top"|Boolean | ||
+ | |- | ||
+ | |valign="top"|[[Data Attributes#Choicelist|Choicelist]]||A list of items | ||
+ | |valign="top"|choiceList||valign="top"|Character | ||
|- | |- | ||
|valign="top"|[[CSS|CSS style]]||CSS style for the gadget (separate attributes with ; or use app:/filename.css) | |valign="top"|[[CSS|CSS style]]||CSS style for the gadget (separate attributes with ; or use app:/filename.css) | ||
+ | |valign="top"|gadgetCssStyle||valign="top"|Character | ||
|- | |- | ||
|valign="top"|[[Data Attributes#Row height|Row height]]||Row height for the CheckListView items | |valign="top"|[[Data Attributes#Row height|Row height]]||Row height for the CheckListView items | ||
+ | |valign="top"|treeViewRowHeight||valign="top"|Int | ||
|- | |- | ||
|valign="top"|[[Data Attributes#Font size|Font size]]||Font size for the CheckListView items | |valign="top"|[[Data Attributes#Font size|Font size]]||Font size for the CheckListView items | ||
+ | |valign="top"|treeViewFontSize||valign="top"|Int | ||
|- | |- | ||
|valign="top"|[[Colors|Background color]]||The background color for the gadget | |valign="top"|[[Colors|Background color]]||The background color for the gadget | ||
+ | |valign="top"|captionToColor||valign="top"|Character | ||
|- | |- | ||
|valign="top"|[[Colors|Foreground color]]||The foreground color for the gadget | |valign="top"|[[Colors|Foreground color]]||The foreground color for the gadget | ||
+ | |valign="top"|captionToColor||valign="top"|Character | ||
|- | |- | ||
|} | |} |
Revision as of 11:11, 7 July 2016
Contents
Getting and Setting Attributes
The setAttribute(name, value) method can be used to set the value of an Attribute:
Lianja.get("pageid.sectionid.fieldid").setAttribute("caption","Formitem1")
Note: the shortened form setAttr(name,value) is also available.
The getAttribute(name) method can be used to get the value of an Attribute:
cTitle = Lianja.get("pageid.sectionid.fieldid").getAttribute("caption")
Note: the shortened form getAttr(name) is also available.
Details
Attribute | Description | Name | Type |
---|---|---|---|
Name | The name for this gadget (unique to the section) | id | Character |
Meta types | A comma separated list of metatype names | metatypes | Character |
Type | The type of control: Gadget (readonly) | type | Character |
Gadget type | The type of gadget: checklistview (readonly) | gadgetType | Character |
Margin | Margin size around the gadget | gadgetMargin | Int |
Fixed width | Fixed gadget width in pixels | gadgetFixedWidth | Int |
Fixed height | Fixed gadget height in pixels | gadgetFixedHeight | Int |
Inline | Render the gadget inline rather than it its own column (True | False) | gadgetInline | Boolean |
Stretch width | Auto stretch the width of the gadget into the width of the section (True | False) | gadgetStretchWidth | Boolean |
Geometry
Attribute | Description | Name | Type |
---|---|---|---|
Absolute | Enable or disable absolute positioning (True | False) | absolutePosition | Boolean |
Top | Top position in pixels | absolutePositionY | Int |
Left | Left position in pixels | absolutePositionX | Int |
Width | Width in pixels | absolutePositionWidth | Int |
Height | Height in pixels | absolutePositionHeight | Int |
CSS style | CSS style (separate attributes with ; or use app:/filename.css) | cssStyle | Character |
Caption
Attribute | Description | Name | Type |
---|---|---|---|
Caption | The caption for the gadget | caption | Character |
Background color | The background color for the caption | backColor | Character |
Foreground color | The foreground color for the caption | foreColor | Character |
Font | The font for the caption | captionFont | Character |
Icon | The image for the caption (png | jpg | gif). Use app:/imagename.ext for app specific images. |
captionIcon | Character |
Border width | The caption border width | captionBorderWidth | Int |
Border color | The caption border color | captionBorderColor | Character |
Transparency | Specify a transparency percentage from 0 to 100 | transparency | Int |
Gradient colors | Render the caption color as a gradient (True | False) | captionGradient | Boolean |
Gradient type | Specify the gradient type | captionGradientType | Int |
Gradient start color | Gradient start color | captionFromColor | Character |
Gradient end color | Gradient end color | captionToColor | Character |
Data
Attribute | Description | Name | Type |
---|---|---|---|
Data source | The table and column that this CheckListView is bound to. If this checklist allows multiple selections, this should be a character column which will be updated with a comma separated list of selected items. | controlSource | Character |
Default | An optional default value as an expression, e.g. "" or 0. You can use this to initialize a default variable such as m.m_listValue. | defaultValue | Character |
GroupBox caption | An optional caption for the GroupBox containing the CheckListView items | headerLabels | Character |
Allow multiple selections | Allow multiple selections (True | False) | treeCheckListMultiSelect | Boolean |
Choicelist | A list of items | choiceList | Character |
CSS style | CSS style for the gadget (separate attributes with ; or use app:/filename.css) | gadgetCssStyle | Character |
Row height | Row height for the CheckListView items | treeViewRowHeight | Int |
Font size | Font size for the CheckListView items | treeViewFontSize | Int |
Background color | The background color for the gadget | captionToColor | Character |
Foreground color | The foreground color for the gadget | captionToColor | Character |
Other Options
Attribute | Description | Name | Type |
---|---|---|---|
Hide header | Hide gadget header at runtime (True | False) | gadgetHideHeader | Boolean |
Custom Delegates
Attribute | Description | Name | Type |
---|---|---|---|
Init | The delegate for the Init event | ||
Load | The delegate for the Load event | ||
Ready | The delegate for the Ready event | ||
Change | The delegate for the Change event | ||
Click | The delegate for the item Clicked event | ||
Refresh | The delegate for the Refresh event |
Permissions and Roles
Attribute | Description | Name | Type |
---|---|---|---|
Read roles | A comma separated list of roles that can read (and view) the data. | permRead | Character |
Update roles | A comma separated list of roles that can perform update operations on the data. | permUpdate | Character |
UI Presentation Rules
Attribute | Description | Name | Type |
---|---|---|---|
Desktop | Include this gadget in a Desktop client (True | False). | desktopUI | Boolean |
Web | Include this gadget in a Web client (True | False). | webUI | Boolean |
Tablet | Include this gadget in a Tablet client (True | False). | tabletUI | Boolean |
Phone | Include this gadget in a Phone client (True | False). | mobileUI | Boolean |
UI States | UI states that affect this gadget. Specify multiple states as a comma separated list. | state | Character |
Initial UI state | The initial UI state for this gadget. | uiStateInit | Character |
Readonly when | Gadget is readonly at runtime if specified expression evaluates to true. | readonlyWhen | Character |
Visible when | Gadget is visible at runtime if specified expression evaluates to true. | visibleWhen | Character |
Display orientation | Display depending on mobile device orientation for Tablets and Phones. (Always | Portrait | Landscape) | displayOrientation | Character |
Apply rules on change | Apply UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False). | applyRulesOnChange | Boolean |