Difference between revisions of "CatalogView Section Attributes"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
Line 1: | Line 1: | ||
==See Also== | ==See Also== | ||
[[CatalogView Options]], [[CatalogView Sections (Video)]] | [[CatalogView Options]], [[CatalogView Sections (Video)]] | ||
+ | |||
+ | ==Getting and Setting Attributes== | ||
+ | The '''setAttribute(name, value)''' method can be used to set the value of an Attribute: | ||
+ | |||
+ | <pre>Lianja.get("sectionid").setAttribute("title","Section1")</pre> | ||
+ | |||
+ | Note: the shortened form '''setAttr(name,value)''' is also available. | ||
+ | |||
+ | The '''getAttribute(name)''' method can be used to get the value of an Attribute: | ||
+ | |||
+ | <pre>cTitle = Lianja.get("sectionid").getAttribute("title")</pre> | ||
+ | |||
+ | Note: the shortened form '''getAttr(name)''' is also available. | ||
==Details== | ==Details== |
Revision as of 06:12, 5 July 2016
Contents
See Also
CatalogView Options, CatalogView Sections (Video)
Getting and Setting Attributes
The setAttribute(name, value) method can be used to set the value of an Attribute:
Lianja.get("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("sectionid").getAttribute("title")
Note: the shortened form getAttr(name) is also available.
Details
Attribute | Description |
---|---|
Name | The name for this section (unique to the page) |
Meta types | A comma separated list of metatype names |
Type | The type of section: catalogview (readonly) |
Caption | The section caption displayed in the section header |
Database | The database for this section |
Table | The table for this section |
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 |
Appearance
Attribute | Description |
---|---|
Margin | Margin size around the section |
Add spacer at bottom | Add spacer at bottom of section (True | False) |
Header
Attribute | Description |
---|---|
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 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 |
CatalogView Options
Attribute | Description |
---|---|
Heading | The Catalogview heading. This defaults to none, which causes the heading to not be displayed |
Cell width | The width of each cell (this is a percentage that the cell will used in the display area). This defaults to 100% |
Cell height | The height of the cell in pixels. This defaults to just take up the space that is required to display the cell |
Columns across | The number of columns to display across the page |
Image | The name of the (blob/object) column in the table containing the image for each cell |
Image width | The width of the image in pixels |
Image height | The height of the image in pixels |
Caption | The name of the (character) column in the table containing the caption for each cell |
Caption delegate | The inline delegate to invoke when the caption is clicked. |
Caption link searchkey | The search key expression to be postfixed to the caption delegate when it is invoked |
Sub caption | The name of the (character) column in the table containing the sub-caption for each cell |
Details | The name of the (memo/varchar) column in the table containing the details for each cell |
Read more | Show the 'Read more' link (True | False) |
Details height | Maximum height of details to display if 'Read more' is specified |
Read more delegate | The inline delegate to invoke when the 'Read more' link is clicked. Alternatively, the 'Click' delegate can be used. |
Read more link searchkey | The search key expression to be postfixed to the 'Read more' delegate when it is invoked |
Order by | The orderby expression for the data in the Catalogview |
Filter | The filter expression that restricts which records will be included in the Catalogview |
Pagination | Paginate the rows displayed (True | False) |
Pagination size | The number of rows to paginate |
CSS Stylesheet | You can override the CSS style for the table containing the cells and the style of the cells themselves by specifying your own stylesheet. |
Other options | Other Catalogview options |
Custom library | Custom library containing the Tile producer delegate. |
Tile producer | Delegate to call to render a custom tile. This should just output the HTML. |
Related Data
Attribute | Description |
---|---|
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. |
Menu
Attribute | Description |
---|---|
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 |
---|---|
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 |
---|---|
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 |
Attribute | Description |
---|---|
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 |
---|---|
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) |
Custom Delegates
Attribute | Description |
---|---|
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 |
Parent data changed | The delegate for the ParentDataChanged event |
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 search event |
Custom section menu | The delegate for the section menu event |
Permissions and Roles
Attribute | Description |
---|---|
Create roles | A comma separated list of roles that can perform create operations on data in the section |
Read roles | A comma separated list of roles that can read (and view) the section |
Update roles | A comma separated list of roles that can perform update operations on data in the section |
Delete roles | A comma separated list of roles that can perform delete operations on data in the section |
UI Presentation Rules
Attribute | Description |
---|---|
Desktop | Include this section in a Desktop client (True | False). |
Web | Include this section in a Web client (True | False). |
Tablet | Include this section in a Tablet client (True | False). |
Phone | Include this section in a Phone client (True | False). |
UI States | UI states that affect this section. Specify multiple states as a comma separated list. |
Initial UI state | The initial UI state for this section. This will be applied to the section and all its fields and gadgets. |
Readonly when | Section is readonly at runtime if specified expression evaluates to true. |
Visible when | Section 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 UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False). |
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) |