Difference between revisions of "Grid Gadget Attributes"

Revision as of 10:09, 7 July 2016

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)
Meta types	A comma separated list of metatype names
Type	The type of control: Gadget (readonly)
Gadget type	The type of gadget: webview (readonly)
Margin	Margin size around the gadget
Fixed width	Fixed gadget width in pixels
Fixed height	Fixed gadget height in pixels
Inline	Render the gadget inline rather than it its own column (True \| False)
Stretch width	Auto stretch the width of the gadget into the width of the section (True \| False)

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
Background color	The background color for the caption
Foreground color	The foreground color for the caption
Font	The font for the caption
Icon	The image for the caption (png \| jpg \| gif). Use app:/imagename.ext for app specific images.
Border width	The caption border width
Border color	The caption border color
Transparency	Specify a transparency percentage from 0 to 100
Gradient colors	Render the caption color as a gradient (True \| False)
Gradient type	Specify the gradient type
Gradient start color	Gradient start color
Gradient end color	Gradient end color

Data

Attribute	Description	Name	Type
Data source	The table or SQL SELECT statement to display in the grid.
Editable	Data is editable (True \| False)
Hide OK/Cancel Buttons	Hide the OK/Cancel buttons (True \| False)
Hide actionbar	Hide actionbar buttons (True \| False)
Filter	The filter expression that restricts the records that will be included in the grid
CSS style	CSS style for the gadget (separate attributes with ; or use app:/filename.css)
Pagination	Grid is always rendered using pagination (for large data sets)(True \| False)
Automatic pagination	Grid is rendered using pagination if the number of records exceeds below amount (True \| False)
Automatic pagination size	Grid is rendered using pagination if Automatic pagination is true and the number of records exceeds this amount
Grid row height	Height of the grid rows
Background color	The background color for the gadget
Foreground color	The foreground color for the gadget

Other Options

Attribute	Description	Name	Type
Hide header	Hide gadget header at runtime (True \| False)

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
Activate	The delegate for the Activate event
Deactivate	The delegate for the Deactivate event
Change	The delegate for the Change event
Before Data Create	The delegate for the BeforeCreated event
After Data Create	The delegate for the AfterCreated event
After Data Changed	The delegate for the dataChanged event (after data is read)
Before Data Update	The delegate for the BeforeUpdate event
After Data Update	The delegate for the AfterUpdate event
Before Data Delete	The delegate for the BeforeDelete event
After Data Delete	The delegate for the AfterDelete event
Refresh	The delegate for the Refresh event
Parent data changed	The delegate for the ParentDataChanged event
Click	The delegate for the item Clicked event.
Double click	The delegate for the dblClick event
Sort	The delegate for the column Sort event fired when the header is clicked. This is called with two arguments: nColumn, nDirection
Timer	The delegate for the Timer event
Timer interval	The timer interval in seconds that the Timer event will be called at runtime

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

@@ Line 15: / Line 15: @@
 {| class="wikitable" width="100%"
 !width="20%"|Attribute
-!width="80%"|Description
+!width="45%"|Description
+!width="25%"|Name
+!width="10%"|Type
 |-
 |valign="top"|[[Details Attributes#Name|Name]]||The name for this gadget (unique to the section)
@@ Line 40: / Line 42: @@
 {| class="wikitable" width="100%"
 !width="20%"|Attribute
-!width="80%"|Description
+!width="45%"|Description
+!width="25%"|Name
+!width="10%"|Type
 |-
 |valign="top"|[[Geometry#Absolute|Absolute]]||Enable or disable absolute positioning (True &#124; False)
+|valign="top"|absolutePosition||valign="top"|Boolean
 |-
 |valign="top"|[[Geometry#Top|Top]]||Top position in pixels
+|valign="top"|absolutePositionY||valign="top"|Int
 |-
 |valign="top"|[[Geometry#Left|Left]]||Left position in pixels
+|valign="top"|absolutePositionX||valign="top"|Int
 |-
 |valign="top"|[[Geometry#Width|Width]]||Width in pixels
+|valign="top"|absolutePositionWidth||valign="top"|Int
 |-
 |valign="top"|[[Geometry#Height|Height]]||Height in pixels
+|valign="top"|absolutePositionHeight||valign="top"|Int
 |-
 |valign="top"|[[CSS|CSS style]]||CSS style (separate attributes with ; or use app:/filename.css)
+|valign="top"|cssStyle||valign="top"|Character
 |-
 |}
@@ Line 59: / Line 69: @@
 {| class="wikitable" width="100%"
 !width="20%"|Attribute
-!width="80%"|Description
+!width="45%"|Description
+!width="25%"|Name
+!width="10%"|Type
 |-
 |valign="top"|[[Formitem Appearance#Caption|Caption]]||The caption for the gadget
@@ Line 90: / Line 102: @@
 {| class="wikitable" width="100%"
 !width="20%"|Attribute
-!width="80%"|Description
+!width="45%"|Description
+!width="25%"|Name
+!width="10%"|Type
 |-
 |valign="top"|[[Data Attributes#Data source|Data source]]||The table or SQL SELECT statement to display in the grid.
@@ Line 121: / Line 135: @@
 {| class="wikitable" width="100%"
 !width="20%"|Attribute
-!width="80%"|Description
+!width="45%"|Description
+!width="25%"|Name
+!width="10%"|Type
 |-
 |valign="top"|[[Details Attributes#Hide_header|Hide header]]||Hide gadget header at runtime (True &#124; False)
@@ Line 130: / Line 146: @@
 {| class="wikitable" width="100%"
 !width="20%"|Attribute
-!width="80%"|Description
+!width="45%"|Description
+!width="25%"|Name
+!width="10%"|Type
 |-
 |valign="top"|[[Custom Delegates#Init|Init]]||The delegate for the Init event
@@ Line 177: / Line 195: @@
 {| class="wikitable" width="100%"
 !width="20%"|Attribute
-!width="50%"|Description
+!width="45%"|Description
-!width="20%"|Name
+!width="25%"|Name
 !width="10%"|Type
 |-
@@ Line 192: / Line 210: @@
 {| class="wikitable" width="100%"
 !width="20%"|Attribute
-!width="50%"|Description
+!width="45%"|Description
-!width="20%"|Name
+!width="25%"|Name
 !width="10%"|Type
 |-