Difference between revisions of "Grid Gadget Attributes"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
| Line 3: | Line 3: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="80%"|Description |
| − | + | ||
| − | + | ||
|- | |- | ||
| − | |valign="top"|Name||The name for this gadget (unique to the section) | + | |valign="top"|Name||The name for this gadget (unique to the section) |
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|Meta types||A comma separated list of metatype names |
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|Type||The type of control: Gadget (readonly) |
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|Gadget type||The type of gadget: grid (readonly) |
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|Margin||Margin size around the gadget |
|- | |- | ||
| − | |valign="top"|Fixed | + | |valign="top"|Fixed width||Fix the gadget width (True | False) |
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|Fixed height||Fix the gadget height (True | False) |
|- | |- | ||
| − | |valign="top"|Stretch width||Auto stretch the width of the gadget into the width of the section (True | False) | + | |valign="top"|Inline||Render the gadget inline rather than it its own column (True | False) |
| + | |- | ||
| + | |valign="top"|Stretch width||Auto stretch the width of the gadget into the width of the section (True | False) | ||
|- | |- | ||
|} | |} | ||
| Line 28: | Line 28: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="80%"|Description |
| − | + | ||
| − | + | ||
|- | |- | ||
| − | |valign="top"|Absolute||Enable or disable absolute positioning (True | False) | + | |valign="top"|Absolute||Enable or disable absolute positioning (True | False) |
|- | |- | ||
| − | |valign="top"|Top||Top position in pixels | + | |valign="top"|Top||Top position in pixels |
|- | |- | ||
| − | |valign="top"|Left||Left position in pixels | + | |valign="top"|Left||Left position in pixels |
|- | |- | ||
| − | |valign="top"|Width||Width in pixels | + | |valign="top"|Width||Width in pixels |
|- | |- | ||
| − | |valign="top"|Height||Height in pixels | + | |valign="top"|Height||Height in pixels |
|- | |- | ||
| − | |valign="top"|CSS style||CSS style (separate attributes with ; or use app:/filename.css) | + | |valign="top"|CSS style||CSS style (separate attributes with ; or use app:/filename.css) |
|- | |- | ||
|} | |} | ||
| Line 49: | Line 47: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="80%"|Description |
| − | + | ||
| − | + | ||
|- | |- | ||
| − | |valign="top"|Caption||The caption for the gadget | + | |valign="top"|Caption||The caption for the gadget |
|- | |- | ||
| − | |valign="top"|[[Colors|Background color]]||The background color for the caption | + | |valign="top"|[[Colors|Background color]]||The background color for the caption |
|- | |- | ||
| − | |valign="top"|[[Colors|Foreground color]]||The foreground color for the caption | + | |valign="top"|[[Colors|Foreground color]]||The foreground color for the caption |
|- | |- | ||
| − | |valign="top"|Font||The font for the caption | + | |valign="top"|Font||The font for the caption |
|- | |- | ||
| − | |valign="top"|Icon||The image for the caption (png | jpg | gif).<br>Use app:/imagename.ext for app specific images. | + | |valign="top"|Icon||The image for the caption (png | jpg | gif).<br>Use app:/imagename.ext for app specific images. |
|- | |- | ||
| − | |valign="top"|Border width||The caption border width | + | |valign="top"|Border width||The caption border width |
|- | |- | ||
| − | |valign="top"|[[Colors|Border color]]||The caption border color | + | |valign="top"|[[Colors|Border color]]||The caption border color |
|- | |- | ||
| − | |valign="top"|Transparency||Specify a transparency percentage from 0 to 100 | + | |valign="top"|Transparency||Specify a transparency percentage from 0 to 100 |
|- | |- | ||
| − | |valign="top"|[[Gradients#Gradient colors|Gradient colors]]||Render the caption color as a gradient (True | False) | + | |valign="top"|[[Gradients#Gradient colors|Gradient colors]]||Render the caption color as a gradient (True | False) |
|- | |- | ||
| − | |valign="top"|[[Gradients#Gradient type|Gradient type]]||Specify the gradient type | + | |valign="top"|[[Gradients#Gradient type|Gradient type]]||Specify the gradient type |
|- | |- | ||
| − | |valign="top"|[[Gradients#Gradient start color|Gradient start color]]||Gradient start color | + | |valign="top"|[[Gradients#Gradient start color|Gradient start color]]||Gradient start color |
|- | |- | ||
| − | |valign="top"|[[Gradients#Gradient end color|Gradient end color]]||Gradient end color | + | |valign="top"|[[Gradients#Gradient end color|Gradient end color]]||Gradient end color |
|- | |- | ||
|} | |} | ||
| Line 82: | Line 78: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="80%"|Description |
| − | + | ||
| − | + | ||
|- | |- | ||
| − | |valign="top"|Data source||The table or SQL SELECT statement to display in the grid. | + | |valign="top"|Data source||The table or SQL SELECT statement to display in the grid. |
|- | |- | ||
| − | |valign="top"|Editable||Data is editable (True | False) | + | |valign="top"|Editable||Data is editable (True | False) |
|- | |- | ||
| − | |valign="top"|Hide OK/Cancel Buttons||Hide the OK/Cancel buttons (True | False) | + | |valign="top"|Hide OK/Cancel Buttons||Hide the OK/Cancel buttons (True | False) |
|- | |- | ||
| − | |valign="top"|Hide actionbar||Hide actionbar buttons (True | False) | + | |valign="top"|Hide actionbar||Hide actionbar buttons (True | False) |
|- | |- | ||
| − | |valign="top"|Filter||The filter expression that restricts the records that will be included in the grid | + | |valign="top"|Filter||The filter expression that restricts the records that will be included in the grid |
|- | |- | ||
| − | |valign="top"|CSS style||CSS style for the gadget (separate attributes with ; or use app:/filename.css) | + | |valign="top"|CSS style||CSS style for the gadget (separate attributes with ; or use app:/filename.css) |
|- | |- | ||
| − | |valign="top"|Pagination||Grid is always rendered using pagination (for large data sets)(True | False) | + | |valign="top"|Pagination||Grid is always rendered using pagination (for large data sets)(True | False) |
|- | |- | ||
| − | |valign="top"|Automatic pagination||Grid is rendered using pagination if the number of records exceeds below amount (True | False) | + | |valign="top"|Automatic pagination||Grid is rendered using pagination if the number of records exceeds below amount (True | False) |
|- | |- | ||
| − | |valign="top"|Automatic pagination size||Grid is rendered using pagination if Automatic pagination is true and the number of records exceeds this amount | + | |valign="top"|Automatic pagination size||Grid is rendered using pagination if Automatic pagination is true and the number of records exceeds this amount |
|- | |- | ||
| − | |valign="top"|Grid row height||Height of the grid rows | + | |valign="top"|Grid row height||Height of the grid rows |
|- | |- | ||
| − | |valign="top"|[[Colors|Background color]]||The background color for the gadget | + | |valign="top"|[[Colors|Background color]]||The background color for the gadget |
|- | |- | ||
| − | |valign="top"|[[Colors|Foreground color]]||The foreground color for the gadget | + | |valign="top"|[[Colors|Foreground color]]||The foreground color for the gadget |
|- | |- | ||
|} | |} | ||
| Line 115: | Line 109: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="80%"|Description |
| − | + | ||
| − | + | ||
|- | |- | ||
| − | |valign="top"|Hide header||Hide gadget header at runtime (True | False) | + | |valign="top"|Hide header||Hide gadget header at runtime (True | False) |
|- | |- | ||
|} | |} | ||
| Line 173: | Line 165: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="80%"|Description |
| − | + | ||
| − | + | ||
|- | |- | ||
| − | |valign="top"|Read roles||A comma separated list of roles that can read (and view) the data | + | |valign="top"|Read roles||A comma separated list of roles that can read (and view) the data |
|- | |- | ||
| − | |valign="top"|Update roles||A comma separated list of roles that can perform update operations on the data | + | |valign="top"|Update roles||A comma separated list of roles that can perform update operations on the data |
|- | |- | ||
|} | |} | ||
| Line 186: | Line 176: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="80%"|Description |
| − | + | ||
| − | + | ||
|- | |- | ||
| − | |valign="top"|Desktop||Include this gadget in a Desktop client (True | False) | + | |valign="top"|Desktop||Include this gadget in a Desktop client (True | False) |
|- | |- | ||
| − | |valign="top"|Web||Include this gadget in a Web client (True | False) | + | |valign="top"|Web||Include this gadget in a Web client (True | False) |
|- | |- | ||
| − | |valign="top"|Tablet||Include this gadget in a Tablet client (True | False) | + | |valign="top"|Tablet||Include this gadget in a Tablet client (True | False) |
|- | |- | ||
| − | |valign="top"|Phone||Include this gadget in a Phone client (True | False) | + | |valign="top"|Phone||Include this gadget in a Phone client (True | False) |
|- | |- | ||
| − | |UI States||UI states that affect this gadget. Specify multiple states as a comma separated list. | + | |UI States||UI states that affect this gadget. Specify multiple states as a comma separated list. |
|- | |- | ||
| − | |Initial UI state||The initial UI state for this gadget. | + | |Initial UI state||The initial UI state for this gadget. |
|- | |- | ||
| − | |valign="top"|Readonly when||Gadget is readonly at runtime if specified expression evaluates to true. | + | |valign="top"|Readonly when||Gadget is readonly at runtime if specified expression evaluates to true. |
|- | |- | ||
| − | |valign="top"|Visible when||Gadget is visible at runtime if specified expression evaluates to true. | + | |valign="top"|Visible when||Gadget is visible at runtime if specified expression evaluates to true. |
|- | |- | ||
| − | |valign="top"|Display orientation||Display depending on mobile device orientation for Tablets and Phones. (Always | Portrait | Landscape) | + | |valign="top"|Display orientation||Display depending on mobile device orientation for Tablets and Phones. (Always | Portrait | Landscape) |
|- | |- | ||
| − | |valign="top"|Apply rules on change||Apply Page UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False) | + | |valign="top"|Apply rules on change||Apply Page UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False) |
|- | |- | ||
|} | |} | ||
[[Category:Attributes|4 Grid Gadget]] | [[Category:Attributes|4 Grid Gadget]] | ||
Revision as of 08:44, 6 April 2016
Under construction
Contents
Details
| Attribute | Description |
|---|---|
| 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: grid (readonly) |
| Margin | Margin size around the gadget |
| Fixed width | Fix the gadget width (True | False) |
| Fixed height | Fix the gadget height (True | False) |
| 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 |
|---|---|
| Absolute | Enable or disable absolute positioning (True | False) |
| Top | Top position in pixels |
| Left | Left position in pixels |
| Width | Width in pixels |
| Height | Height in pixels |
| CSS style | CSS style (separate attributes with ; or use app:/filename.css) |
Caption
| Attribute | Description |
|---|---|
| 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 |
|---|---|
| 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 |
|---|---|
| Hide header | Hide gadget header at runtime (True | False) |
Custom Delegates
| Attribute | Description |
|---|---|
| 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 |
|---|---|
| Read roles | A comma separated list of roles that can read (and view) the data |
| Update roles | A comma separated list of roles that can perform update operations on the data |
UI Presentation Rules
| Attribute | Description |
|---|---|
| Desktop | Include this gadget in a Desktop client (True | False) |
| Web | Include this gadget in a Web client (True | False) |
| Tablet | Include this gadget in a Tablet client (True | False) |
| Phone | Include this gadget in a Phone client (True | False) |
| UI States | UI states that affect this gadget. Specify multiple states as a comma separated list. |
| Initial UI state | The initial UI state for this gadget. |
| Readonly when | Gadget is readonly at runtime if specified expression evaluates to true. |
| Visible when | Gadget is visible at runtime if specified expression evaluates to true. |
| Display orientation | Display depending on mobile device orientation for Tablets and Phones. (Always | Portrait | Landscape) |
| Apply rules on change | Apply Page UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False) |
