Custom Gadget Attributes

See Also

Developing Lianja Custom Gadgets in JavaScript, Developing Lianja Custom Gadgets in PHP, Developing Lianja Custom Gadgets in Python, Developing Lianja Custom Gadgets in Visual FoxPro, Category:Developing Custom Sections

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: custom (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
Scripting language	The scripting language used to write the code for this custom gadget: (Recital | Python | JavaScript | PHP (readonly)	gadgetScriptingLanguage	Character
Custom filename	The file containing the custom code for this gadget	gadgetArg	Character
Background color	The background color for the gadget	gadgetBackColor	Character
Foreground color	The foreground color for the gadget	gadgetForeColor	Character

Other Options

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

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