Difference between revisions of "Attachments Section Attributes"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
Line 425: | Line 425: | ||
|- | |- | ||
|valign="top"|[[Users and Roles|Create roles]]||A comma separated list of roles that can perform create operations on data in the section. | |valign="top"|[[Users and Roles|Create roles]]||A comma separated list of roles that can perform create operations on data in the section. | ||
− | |valign="top"|permcreate||Character | + | |valign="top"|permcreate||valign="top"|Character |
|- | |- | ||
|valign="top"|[[Users and Roles|Read roles]]||A comma separated list of roles that can read (and view) the section. | |valign="top"|[[Users and Roles|Read roles]]||A comma separated list of roles that can read (and view) the section. | ||
− | |valign="top"|permRead||Character | + | |valign="top"|permRead||valign="top"|Character |
|- | |- | ||
|valign="top"|[[Users and Roles|Update roles]]||A comma separated list of roles that can perform update operations on data in the section. | |valign="top"|[[Users and Roles|Update roles]]||A comma separated list of roles that can perform update operations on data in the section. | ||
− | |valign="top"|permUpdate||Character | + | |valign="top"|permUpdate||valign="top"|Character |
|- | |- | ||
|valign="top"|[[Users and Roles|Delete roles]]||A comma separated list of roles that can perform delete operations on data in the section. | |valign="top"|[[Users and Roles|Delete roles]]||A comma separated list of roles that can perform delete operations on data in the section. | ||
− | |valign="top"|permDelete||Character | + | |valign="top"|permDelete||valign="top"|Character |
|- | |- | ||
|} | |} | ||
Line 446: | Line 446: | ||
|- | |- | ||
|valign="top"|[[UI Presentation Rules#Desktop|Desktop]]||Include this section in a Desktop client (True | False). | |valign="top"|[[UI Presentation Rules#Desktop|Desktop]]||Include this section in a Desktop client (True | False). | ||
− | |valign="top"|desktopUI||Boolean | + | |valign="top"|desktopUI||valign="top"|Boolean |
|- | |- | ||
|valign="top"|[[UI Presentation Rules#Web|Web]]||Include this section in a Web client (True | False). | |valign="top"|[[UI Presentation Rules#Web|Web]]||Include this section in a Web client (True | False). | ||
− | |valign="top"|webUI||Boolean | + | |valign="top"|webUI||valign="top"|Boolean |
|- | |- | ||
|valign="top"|[[UI Presentation Rules#Tablet|Tablet]]||Include this section in a Tablet client (True | False). | |valign="top"|[[UI Presentation Rules#Tablet|Tablet]]||Include this section in a Tablet client (True | False). | ||
− | |valign="top"|tabletUI||Boolean | + | |valign="top"|tabletUI||valign="top"|Boolean |
|- | |- | ||
|valign="top"|[[UI Presentation Rules#Phone|Phone]]||Include this section in a Phone client (True | False). | |valign="top"|[[UI Presentation Rules#Phone|Phone]]||Include this section in a Phone client (True | False). | ||
− | |valign="top"|mobileUI||Boolean | + | |valign="top"|mobileUI||valign="top"|Boolean |
|- | |- | ||
|valign="top"|[[UI Presentation Rules#UI States|UI States]]||UI states that affect this section. Specify multiple states as a comma separated list. | |valign="top"|[[UI Presentation Rules#UI States|UI States]]||UI states that affect this section. Specify multiple states as a comma separated list. | ||
− | |valign="top"|state||Character | + | |valign="top"|state||valign="top"|Character |
|- | |- | ||
|valign="top"|[[UI Presentation Rules#Initial UI state|Initial UI state]]||The initial UI state for this section. This will be applied to the section and all its fields and gadgets. | |valign="top"|[[UI Presentation Rules#Initial UI state|Initial UI state]]||The initial UI state for this section. This will be applied to the section and all its fields and gadgets. | ||
− | |valign="top"|uiStateInit||Character | + | |valign="top"|uiStateInit||valign="top"|Character |
|- | |- | ||
|valign="top"|[[UI Presentation Rules#Readonly when|Readonly when]]||Page is readonly at runtime if specified expression evaluates to true. | |valign="top"|[[UI Presentation Rules#Readonly when|Readonly when]]||Page is readonly at runtime if specified expression evaluates to true. | ||
− | |valign="top"|readonlyWhen||Character | + | |valign="top"|readonlyWhen||valign="top"|Character |
|- | |- | ||
|valign="top"|[[UI Presentation Rules#Visible when|Visible when]]||Page is visible at runtime if specified expression evaluates to true. | |valign="top"|[[UI Presentation Rules#Visible when|Visible when]]||Page is visible at runtime if specified expression evaluates to true. | ||
− | |valign="top"|visibleWhen||Character | + | |valign="top"|visibleWhen||valign="top"|Character |
|- | |- | ||
|valign="top"|[[UI Presentation Rules#Display orientation|Display orientation]]||Display depending on mobile device orientation for Tablets and Phones. (Always | Portrait | Landscape) | |valign="top"|[[UI Presentation Rules#Display orientation|Display orientation]]||Display depending on mobile device orientation for Tablets and Phones. (Always | Portrait | Landscape) | ||
− | |valign="top"|displayOrientation||Character | + | |valign="top"|displayOrientation||valign="top"|Character |
|- | |- | ||
|valign="top"|[[UI Presentation Rules#Apply rules on change|Apply rules on change]]||Apply UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False). | |valign="top"|[[UI Presentation Rules#Apply rules on change|Apply rules on change]]||Apply UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False). | ||
− | |valign="top"|applyRulesOnChange||Boolean | + | |valign="top"|applyRulesOnChange||valign="top"|Boolean |
|- | |- | ||
|valign="top"|[[UI Presentation Rules#Apply rules on parent change|Apply rules on parent change]]||Apply section UI presentation rules (Visible when and Readonly when) when parent data is changed by navigating records (True | False) | |valign="top"|[[UI Presentation Rules#Apply rules on parent change|Apply rules on parent change]]||Apply section UI presentation rules (Visible when and Readonly when) when parent data is changed by navigating records (True | False) | ||
− | |valign="top"|applyRulesOnParentChange||Boolean | + | |valign="top"|applyRulesOnParentChange||valign="top"|Boolean |
|- | |- | ||
|} | |} | ||
[[Category:Attributes|3 Attachments Section]] | [[Category:Attributes|3 Attachments Section]] |
Revision as of 10:01, 5 July 2016
Contents
See Also
Attachments Options, Using Attachment Sections, DocumentView Options, DocumentView Section Attributes
Getting and Setting Attributes
The setAttribute(name, value) method can be used to set the value of an Attribute:
Lianja.get("pageid.sectionid").setAttribute("title","Section1")
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").getAttribute("title")
Note: the shortened form getAttr(name) is also available.
Details
Attribute | Description | Name | Type |
---|---|---|---|
Name | The name for this section (unique to the page) | ||
Meta types | A comma separated list of metatype names | ||
Type | The type of section: attachments (readonly) | ||
Caption | The section caption displayed in the section header | ||
Database | The database for this section | ||
Table | The table for this section | ||
SQL statement | The SQL statement used to populate a Virtual Table. Use {} macros in the WHERE condition to relate parent-->child sections and ORDER BY to order the display of records. This is native SQL for the target SQL database and may call stored procedures as well as SQL Select. | ||
Timelines enabled | Enable database timelines for this section | ||
Filter | The filter expression that restricts the records that will be included in the data | ||
Where condition | The dynamic WHERE condition for a Virtual Table that restricts which records will be retrieved | ||
Attachment field | Name of the (blob) attachment column | ||
Attachment date field | Name of the (date) attachment creation date column | ||
Attachment description field | Name of the (character) attachment description column | ||
Attachment size field | Name of the (numeric) attachment file size column | ||
Attachment link text | Link text to display for the attachment | ||
Height | The section height | ||
Fixed height | Fix the section height (True | False) | ||
Auto layout percent | Auto layout percentage of page size. If set to 0, then all sections on a page are resized to an equal height | ||
Readonly | Section is readonly (True | False) | ||
Sortable | Section is sortable by clicking on the column headers (True | False) | ||
Double click to edit | Double click grid rows to edit data (True | False) |
Appearance
Attribute | Description | Name | Type |
---|---|---|---|
Background color | Section background color | ||
Foreground color | Section foreground color | ||
Grid background color | Grid background color | ||
Grid foreground color | Grid foreground color | ||
CSS style | CSS style (separate attributes with ; or use app:/filename.css) | ||
Gradient colors | Render the background color as a gradient (True | False) | ||
Gradient type | Specify the gradient type | ||
Gradient start color | Gradient start color | ||
Gradient end color | Gradient end color | ||
Transparency | Specify a transparency percentage from 0 to 100 | ||
Background image | The background image for the section (png | jpg | gif). Use app:/imagename.ext for app specific images. | ||
Stretch image | Stretch the background image to fill the section (True | False) | ||
Margin | Margin size around the section | ||
Add spacer at bottom | Add spacer at bottom of section (True | False) | ||
Show actionbar | Show the actionbar (True | False) | ||
Show grid lines | Show grid lines (True | False) | ||
Alternating row colors | Display alternating row colors (True | False) | ||
Grid row height | Height of the grid rows | ||
Autoresize columns | Autoresize grid columns to fit data (True | False) | ||
Stretch last column | Stretch last grid column (True | False) | ||
Split grid | Split the grid into a grid and a form (True | False) | ||
Show split edit | Display grid in split/form edit mode when displayed (True | False) | ||
Show memo/object panel | Show memo/object panel in splitbar mode (True | False) | ||
Scrollbar | Section displays the grid vertical scrollbar (True | False) | ||
Show logicals as CheckBoxes | Display logical/Boolean values as CheckBoxes (True | False) | ||
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 |
Header
Attribute | Description | Name | Type |
---|---|---|---|
Hide header | Hide section header at runtime(True | False) | ||
Hide actionbar | Hide actionbar buttons in the section header (True | False) | ||
Header CSS style | CSS style (separate attributes with ; or use app:/filename.css) | ||
Header icon | The image for the Header (png | jpg | gif). Use app:/imagename.ext for app specific images. | ||
Gradient colors | Render the Header background color as a gradient (True | False) | ||
Gradient type | Specify the gradient type | ||
Gradient start color | Gradient start color | ||
Gradient end color | Gradient end color | ||
Show OK/Cancel buttons | Show OK/Cancel buttons in the section header (True | False) | ||
Show Add/Delete buttons | Show Add/Delete buttons in the section header (True | False) | ||
Show Print button | Show Print button in the section header (True | False) | ||
Hide custom search icon | Hide the custom search icon (True | False) | ||
Show info tips icon | Show the info tips icon in the section header (True | False) | ||
Show help icon | Show the help icon in the section header (True | False) | ||
Help topic | Help topic to display when the help icon is clicked in the section header |
Related Data
Attribute | Description | Name | Type |
---|---|---|---|
Parent section name | Name of related parent section | ||
Automatically relate | Automatically relate the child section (True | False). If this is unchecked then you need to manually relate it in the parentdatachanged delegate. | ||
Parent key | Parent key | ||
Child key | Child key |
Menu
Attribute | Description | Name | Type |
---|---|---|---|
Visible | Section menu visible (True | False) | ||
Height | Section menu height | ||
Background color | Section menu background color | ||
Foreground color | Section menu foreground color | ||
Custom menu | Section menu contents | ||
Custom action | Action to perform when a menu item is selected |
Search Panel
Attribute | Description | Name | Type |
---|---|---|---|
Visible | Section search panel visible (True | False) | ||
Height | Section search panel height | ||
Background color | Section search panel background color | ||
Foreground color | Section search panel foreground color | ||
Auto create | Automatically create search panel for all Section search fields | ||
Custom search panel | The delegate used to create the custom search panel |
Subtitle
Attribute | Description | Name | Type |
---|---|---|---|
Visible | Section subtitle visible (True | False) | ||
Caption | Section subtitle caption | ||
Height | Section subtitle height | ||
Background color | Section subtitle background color | ||
Foreground color | Section subtitle foreground color | ||
Font | Section subtitle font | ||
CSS style | CSS style |
Summary
Attribute | Description | Name | Type |
---|---|---|---|
Visible | Section summary visible (True | False) | ||
Background color | Section summary background color | ||
Foreground color | Section summary foreground color |
Attribute | Description | Name | Type |
---|---|---|---|
Visible | Section footer visible (True | False) | ||
Caption | Section footer caption | ||
Height | Section footer height | ||
Background color | Section footer background color | ||
Foreground color | Section footer foreground color | ||
Custom menu | Section footer menu contents | ||
Custom action | Action to perform when a footer menu item is selected | ||
Footer button CSS | Footer button CSS style | ||
Footer button width | Footer button width |
Other Options
Attribute | Description | Name | Type |
---|---|---|---|
Hide form NavBar | Hide form Navigation Bar at runtime if this section is in an Accordion Stack (True | False) | ||
Collapsable | The section is collapsible at runtime (True | False) | ||
Exclude from accordion | The section is excluded from accordion behavior at runtime (True | False) | ||
Double-click action | Page to activate on double click of a grid row | ||
Hide search icon | Hide the search icon at runtime (True | False) |
Custom Delegates
Attribute | Description | Name | Type |
---|---|---|---|
Scripting language | The default scripting language for custom code in this section (Inherit | Recital | Visual FoxPro | Python | JavaScript | PHP) | ||
Custom library | The filename of the library containing code for event handlers and custom procedures/functions | ||
Expanded | The delegate for the Expanded event | ||
Collapsed | The delegate for the Collapsed event | ||
Enabled When | The delegate for the EnabledWhen event | ||
Visible When | The delegate for the VisibleWhen event | ||
Valid When | The delegate for the ValidWhen event | ||
Activate | The delegate for the Activate event | ||
Deactivate | The delegate for the Deactivate event | ||
Init | The delegate for the Init event | ||
Destroy | The delegate for the Destroy event | ||
Load | The delegate for the Load event | ||
Ready | The delegate for the Ready event | ||
Unload | The delegate for the Unload event | ||
Change | The delegate for the Change event | ||
Link Click | The delegate for the Hyperlink/Button Click event. This is called with two arguments: functionname(controlsource,text) | ||
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 | ||
Dialog button delegate | The delegate for the DialogButtonClicked event. If a dialogbutton on a Field has no delegate, the Section delegate will be called. If the section has no delegate, then the Page delegate will be called. | ||
Double click | The delegate for the row 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 | ||
Custom footer menu | The delegate for the footer menu event | ||
Custom search command | The delegate for the customsearch event | ||
Custom section menu | The delegate for the section menu event |
Gestures
Attribute | Description | Name | Type |
---|---|---|---|
Gestures enabled | Enable gestures for this page: swipe, pan, pinch, tap and tapandhold (True | False). If enabled, then the Gestures delegate will be called with two arguments, e.g. 'swipe','left' or 'swipe','right'. | ||
Swipe left gesture | The delegate for the gestureSwipeLeft event. | ||
Swipe right gesture | The delegate for the gestureSwipeRight event. | ||
Swipe up gesture | The delegate for the gestureSwipeUp event. | ||
Swipe down gesture | The delegate for the gestureSwipeDown event. | ||
Pan gesture | The delegate for the gesturePan event. | ||
Pinch gesture | The delegate for the gesturePinch event. | ||
Tap gesture | The delegate for the gestureTap event. | ||
Tap and hold gesture | The delegate for the gestureTapAndHold event. | ||
Gestures | The catch all delegate for the gestures event. |
Permissions and Roles
Attribute | Description | Name | Type |
---|---|---|---|
Create roles | A comma separated list of roles that can perform create operations on data in the section. | permcreate | Character |
Read roles | A comma separated list of roles that can read (and view) the section. | permRead | Character |
Update roles | A comma separated list of roles that can perform update operations on data in the section. | permUpdate | Character |
Delete roles | A comma separated list of roles that can perform delete operations on data in the section. | permDelete | Character |
UI Presentation Rules
Attribute | Description | Name | Type |
---|---|---|---|
Desktop | Include this section in a Desktop client (True | False). | desktopUI | Boolean |
Web | Include this section in a Web client (True | False). | webUI | Boolean |
Tablet | Include this section in a Tablet client (True | False). | tabletUI | Boolean |
Phone | Include this section in a Phone client (True | False). | mobileUI | Boolean |
UI States | UI states that affect this section. Specify multiple states as a comma separated list. | state | Character |
Initial UI state | The initial UI state for this section. This will be applied to the section and all its fields and gadgets. | uiStateInit | Character |
Readonly when | Page is readonly at runtime if specified expression evaluates to true. | readonlyWhen | Character |
Visible when | Page 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 |
Apply rules on parent change | Apply section UI presentation rules (Visible when and Readonly when) when parent data is changed by navigating records (True | False) | applyRulesOnParentChange | Boolean |