Difference between revisions of "Page Attributes"
From Lianjapedia
Yvonne.milne (Talk | contribs) (Created page with "''Under construction'' ==Details== {| class="wikitable" width="100%" !width="20%"|Attribute !width="60%"|Description !width="20%"|More |- |valign="top"|Name||The unique name f...") |
Yvonne.milne (Talk | contribs) (→Left Sidebar) |
||
| (115 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | '' | + | =Overview= |
| + | ==Setting Attributes Declaratively== | ||
| + | |||
| + | You adjust the appearance and behavior of each UI Element in the '''Attributes''' Tab of the [[:Category:App_Inspector|App Inspector]]. | ||
| + | |||
| + | [[{{ns:file}}:bm-attributes.png|800px|left|border|link={{filepath:bm-attributes.png}}|Attributes]] | ||
| + | <br clear=all> | ||
| + | |||
| + | The attributes available consist of some common ones as well as some specific to the UI Element being inspected. | ||
| + | |||
| + | ==Getting and Setting Attributes Programatically== | ||
| + | The '''setAttribute(name, value)''' method can be used to set the value of an Attribute: | ||
| + | |||
| + | <pre>Lianja.get("pageid").setAttribute("title","Page1")</pre> | ||
| + | |||
| + | Note: on the desktop, 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("pageid").getAttribute("title")</pre> | ||
| + | |||
| + | Note: on the desktop, the shortened form '''getAttr(name)''' is also available. | ||
| + | |||
| + | =Attributes= | ||
==Details== | ==Details== | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="40%"|Description |
| − | !width="20%"| | + | !width="30%"|Name |
| + | !width="10%"|Type | ||
| + | |- | ||
| + | |valign="top"|[[Details Attributes#Name|Name]]||The unique name for this page. | ||
| + | |valign="top"|id||Character | ||
| + | |- | ||
| + | |valign="top"|[[Details Attributes#Title|Title]]||The menu title for this page. | ||
| + | |valign="top"|title||Character | ||
| + | |- | ||
| + | |valign="top"|[[Details Attributes#Alias name|Alias name]]||The alias name for this page. | ||
| + | |valign="top"|aliasid||Character | ||
| + | |- | ||
| + | |valign="top"|[[Details Attributes#App Doc|App Doc]]||The App Doc file for this page. This will be included in the [[App Doc]] when it is generated. | ||
| + | |valign="top"|appdoc||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[MetaTypes|Meta types]]||A comma separated list of metatype names. | ||
| + | |valign="top"|metatypes||Character | ||
| + | |- | ||
| + | |valign="top"|[[Details Attributes#Custom Props|Custom Props]]||A ';' separated list of custom prop key pairs, e.g. name=barry;company=lianja<br>From v5.3. | ||
| + | |valign="top"|customprops||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Details Attributes#Menu icon image|Menu icon image]]||The menu icon image for the title (png | jpg | gif).<br>Use app:/imagename.ext for app specific images.<br>Note that in the mobile client this icon will be displayed in the PageBar. | ||
| + | |valign="top"|menuIcon||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Details Attributes#Autosave in Page Library|Autosave in Page Library]]||Always save this page to the UI Page Library when an App is saved. | ||
| + | |valign="top"|alwaysSaveInPageLibrary||valign="top"|Boolean | ||
| + | |- | ||
| + | |valign="top"|[[Details Attributes#Query Page|Query Page]]||When this is checked, no data is shown until a search or filter has been performed. | ||
| + | |valign="top"|queryPage||Boolean | ||
| + | |- | ||
| + | |valign="top"|[[Details Attributes#Mobile login Page|Mobile login Page]]||When this is checked, this page will be used as the Mobile login page. | ||
| + | |valign="top"|loginPage||Boolean | ||
| + | |- | ||
| + | |valign="top"|[[Details Attributes#Deferred load|Deferred load]]||When this is checked, this page will be loaded with data only when it is first activated (speeds up App load time). | ||
| + | |valign="top"|deferredLoad||Boolean | ||
| + | |- | ||
| + | |valign="top"|[[Page Appearance#Refresh when activated|Refresh when activated]]||Refresh all sections on this page when the page is activated. | ||
| + | |valign="top"|refreshWhenActivated||valign="top"|Boolean | ||
| + | |- | ||
| + | |valign="top"|[[Page Appearance#Full page edit|Full page edit]]||Edit all editable sections on this page when the page is edited. | ||
| + | |valign="top"|fullPageEdit||valign="top"|Boolean | ||
| + | |- | ||
| + | |} | ||
| + | |||
| + | ==Printing== | ||
| + | {| class="wikitable" width="100%" | ||
| + | !width="20%"|Attribute | ||
| + | !width="40%"|Description | ||
| + | !width="30%"|Name | ||
| + | !width="10%"|Type | ||
| + | |- | ||
| + | |valign="top"|[[Instant Report#Print report header|Print report header]]||Print the report header when printing an Instant Report. From v6.1. | ||
| + | |valign="top"|printreportheader||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Instant Report#Report header|Report header]]||Instant Report header text. This can contain HTML. From v6.1. |
| + | |valign="top"|reportheader||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Instant Report#Print report footer|Print report footer]]||Print the report footer when printing an Instant Report. From v6.1. |
| + | |valign="top"|printreportfooter||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Instant Report#Report footer|Report footer]]||Instant Report footer text. This can contain HTML. From v6.1. |
| + | |valign="top"|reportfooter||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Instant Report#Report CSS style|Report CSS style]]||CSS style for rendered Instant Report image. From v6.1.<br>e.g. height:11in;width:8.5in |
| + | |valign="top"|reportstyle||valign="top"|Character | ||
|- | |- | ||
|} | |} | ||
| Line 19: | Line 98: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="40%"|Description |
| − | !width=" | + | !width="30%"|Name |
| + | !width="10%"|Type | ||
|- | |- | ||
| − | |valign="top"|Current page height||Current page height|| | + | |valign="top"|Current page height||Current page height (displayed in Attributes only). |
| + | |valign="top"| ||valign="top"| | ||
|- | |- | ||
| − | |valign="top"|Background color||Page background color|| | + | |valign="top"|[[Colors|Background color]]||Page background color. |
| + | |valign="top"|backColor||Character | ||
|- | |- | ||
| − | |valign="top"|Foreground color||Page foreground color|| | + | |valign="top"|[[Colors|Foreground color]]||Page foreground color. |
| + | |valign="top"|foreColor||Character | ||
|- | |- | ||
| − | |valign="top"|CSS style||CSS style (separate attributes with ; or use app:/filename.css)|| | + | |valign="top"|[[CSS|CSS style]]||CSS style (separate attributes with ; or use app:/filename.css). |
| + | |valign="top"|cssStyle||Character | ||
|- | |- | ||
| − | |valign="top"|Gradient colors||Render the background color as a gradient (True|False)|| | + | |valign="top"|[[Gradients#Gradient colors|Gradient colors]]||Render the background color as a gradient (True | False). |
| + | |valign="top"|pageGradient||Boolean | ||
|- | |- | ||
| − | |valign="top"|Gradient type||Specify the gradient type | + | |valign="top"|[[Gradients#Gradient type|Gradient type]]||Specify the gradient type. |
| + | |valign="top"|pageGradientType||Int | ||
|- | |- | ||
| − | |valign="top"|Gradient start color||Gradient start color|| | + | |valign="top"|[[Gradients#Gradient start color|Gradient start color]]||Gradient start color. |
| + | |valign="top"|pageFromColor||Character | ||
|- | |- | ||
| − | |valign="top"|Gradient end color||Gradient end color|| | + | |valign="top"|[[Gradients#Gradient end color|Gradient end color]]||Gradient end color. |
| + | |valign="top"|pageToColor||Character | ||
|- | |- | ||
| − | |valign="top"|Transparency||Specify a transparency percentage from 0 to 100|| | + | |valign="top"|[[Shading and Transparency|Transparency]]||Specify a transparency percentage from 0 to 100. |
| + | |valign="top"|transparency||Int | ||
|- | |- | ||
| − | |valign="top"|Background image||The | + | |valign="top"|[[Page Appearance#Background image|Background image]]||The background image for the page (png | jpg | gif).<br>Use app:/imagename.ext for app specific images. |
| + | |valign="top"|picture||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Stretch image||Stretch the background image to fill the page (True|False)|| | + | |valign="top"|[[Page Appearance#Stretch image|Stretch image]]||Stretch the background image to fill the page (True | False). |
| + | |valign="top"|stretch||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Margin||Margin size around the page|| | + | |valign="top"|[[Page Appearance#Margin|Margin]]||Margin size around the page. |
| + | |valign="top"|marginSize||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|Hide page from menu||Hide page from menu at runtime|| | + | |valign="top"|[[Page Appearance#Hide page from menu|Hide page from menu]]||Hide page from menu at runtime. |
| + | |valign="top"|hideFromMenuAtRuntime||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Working_with_UI_Page_Libraries#Register in UILib|Register in UILib]]||Register the page in the UILib. This allows the page and/or its sections to be rendered in a [[Lianja]].showDialog() / showDialogPanel() (True | False). From v6.0. |
| + | |valign="top"|registerinuilib||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Accordion Behavior#Accordion behavior|Accordion behavior]]||Render as accordion sections (True | False). |
| + | |valign="top"|accordionAtRuntime||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Use Accordions | + | |valign="top"|[[Accordion Behavior#Use Accordions|Use Accordions]]||Render as accordion sections on low resolution displays. |
| + | |valign="top"|useAccordionOnLowres||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Accordion Behavior#Use Accordions height|Use Accordions height]]||Render as accordion sections on low resolution displays less than this height. |
| + | |valign="top"|useAccordionOnLowresValue||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Accordion Behavior#Stacked behavior at runtime|Stacked behavior at runtime]]||Treat accordion sections as stacked at runtime allowing the sections to be made raised from the Navigation Panel. |
| + | |valign="top"|accordionStackAtRuntime||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Stretch last section | + | |valign="top"|[[Page Appearance#Stretch last section|Stretch last section]]||Stretch last section to bottom of page. |
| + | |valign="top"|stretchLastSectionAtRuntime||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Appearance#Auto layout sections|Auto layout sections]]||Auto layout sections by section percentage. |
| + | |valign="top"|autoLayoutSections||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Appearance#Last section min height|Last section min height]]||valign="top"|If the last section is less than this height, then set it to this height and show page vertical scrollbar. |
| + | |valign="top"|stretchLastSectionMinHeight||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Appearance#Last section fixed height|Last section fixed height]]||valign="top"|The last section is set to this fixed height and the previous section expanded to fill the space. |
| + | |valign="top"|stretchLastSectionMaxHeight||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Appearance#Hide actionbar|Hide actionbar]]||Hide the actionbar. |
| + | |valign="top"|hideActionBarAtRuntime||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Appearance#Hide navigation bar slider|Hide navigation bar slider]]||Hide the navigation bar slider. |
| + | |valign="top"|hideSlider||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Appearance#Hide navigation bar buttons|Hide navigation bar buttons]]||Hide specific navigation bar buttons. |
| + | |valign="top"|hideactionbarbuttonlist||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Appearance#Sync actionbar buttons|Sync actionbar buttons]]||Keep the actionbar buttons in sync with the current data position. Turn this off to improve performance with large amounts of data. |
| + | |valign="top"|syncActionBar||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Appearance#Show settings icon|Show settings icon]]||Show the settings menu icon in the actionbar. |
| + | |valign="top"|showSettingsButton||valign="top"|Boolean | ||
| + | |- | ||
| + | |valign="top"|[[Page Appearance#Custom settings menu|Custom settings menu]]||Custom settings menu (comma separated list of values). | ||
| + | |valign="top"|customSettingsMenu||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Page Appearance#Show options icon|Show options icon]]||Show the options menu icon in the actionbar. | ||
| + | |valign="top"|showOptionsButton||valign="top"|Boolean | ||
| + | |- | ||
| + | |valign="top"|[[Page Appearance#Custom options menu|Custom options menu]]||Custom options menu (comma separated list of values). | ||
| + | |valign="top"|customOptionsMenu||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Page Appearance#Show scrollbar|Show scrollbar]]||Show a vertical scrollbar for the page. | ||
| + | |valign="top"|scrollbarVisibleAtRuntime||valign="top"|Boolean | ||
| + | |- | ||
| + | |valign="top"|[[Page Appearance#Show scrollbar height|Show scrollbar height]]||Show vertical scrollbar on low resolution displays less than this height. | ||
| + | |valign="top"|useScrollbarMinHeight||valign="top"|Boolean | ||
| + | |- | ||
| + | |valign="top"|[[Colors|Navigation bar background color]]||Navigation bar background color. | ||
| + | |valign="top"|navbarBackColor||Character | ||
|- | |- | ||
|} | |} | ||
| Line 81: | Line 206: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="40%"|Description |
| − | !width=" | + | !width="30%"|Name |
| + | !width="10%"|Type | ||
| + | |- | ||
| + | |valign="top"|[[Page Header#Visible|Visible]]||Header visible (True | False). | ||
| + | |valign="top"|headerVisible||valign="top"|Boolean | ||
| + | |- | ||
| + | |valign="top"|[[Page Header#Custom header|Custom header]]||Render the page header using the 'Custom header display delegate' (True | False). | ||
| + | |valign="top"|customheader||valign="top"|Boolean | ||
| + | |- | ||
| + | |valign="top"|[[Page Header#Custom header display delegate|Custom header display delegate]]||The name of a procedure/function that will render the page header. | ||
| + | |valign="top"|customheaderdisplay||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Page Header#Caption|Caption]]||Header caption. | ||
| + | |valign="top"|headerCaption||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Page Header#Height|Height]]||Header height. | ||
| + | |valign="top"|headerheight||valign="top"|Int | ||
| + | |- | ||
| + | |valign="top"|[[Page Header#Background color|Background color]]||Header background color. | ||
| + | |valign="top"|headerBackColor||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Page Header#Foreground color|Foreground color]]||Header foreground color. | ||
| + | |valign="top"|headerForeColor||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Page Header#Header bottom border|Header bottom border]]||Display Header bottom border (True | False). | ||
| + | |valign="top"|headerBottomBorder||valign="top"|Boolean | ||
| + | |- | ||
| + | |valign="top"|[[Page Header#Header bottom border color|Header bottom border color]]||valign="top"|Header bottom border color. | ||
| + | |valign="top"|headerBorderBottomColor||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Page Header#Header image|Header image]]||The image for the Header (png | jpg | gif).<br>Use app:/imagename.ext for app specific images. | ||
| + | |valign="top"|headerImage||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Gradients#Gradient colors|Gradient colors]]||Render the Header background color as a gradient (True | False). |
| + | |valign="top"|headerGradient||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Gradients#Gradient type|Gradient type]]||Specify the gradient type. |
| + | |valign="top"|headerGradientType||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Gradients#Gradient start color|Gradient start color]]||Gradient start color. |
| + | |valign="top"|headerFromColor||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Gradients#Gradient end color|Gradient end color]]||Gradient end color. |
| + | |valign="top"|headerToColor||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Header#Hide header icon|Hide header icon]]||Hide the header icon in the page Header (True | False). |
| + | |valign="top"|hideHeaderIcon||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Header | + | |valign="top"|[[Page Header#Hide header icon|Hide header icon]]||Hide the header icon in the page Header (True | False). |
| + | |valign="top"|hideHeaderIcon||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Header | + | |valign="top"|[[Page Header#Hide database switcher|Hide database switcher]]||Hide the database switcher in the page Header (True | False). From v6.3. |
| + | |valign="top"|hidedatabaseswitcher||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Header | + | |valign="top"|[[Page Header#Minimum search text length|Minimum search text length]]||valign="top"|Minimum number of characters to type in the search box before search is made. |
| + | |valign="top"|searchBoxMinChars||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Header#Hide notifications icon|Hide notifications icon]]||Hide the notifications icon in the page Header (True | False). |
| + | |valign="top"|hideNotificationIcon||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Header#Hide search icon|Hide search icon]]||Hide the custom search icon in the page Header (True | False). |
| + | |valign="top"|hideCustomSearchIcon||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Header#Show Custom search dialog|Show Custom search dialog]]||Show custom search dialog when custom search icon clicked (True | False) |
| + | |valign="top"|showcustomsearchdialog||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Header#Show custom search dialog panel|Show custom search dialog panel]]||Show custom search dialog panel when custom search icon clicked<br>(True | False) |
| + | |valign="top"|showcustomsearchdialogpanel||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Header#Columns|Columns]]||Custom search columns |
| + | |valign="top"|columns||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Hide | + | |valign="top"|[[Page Header#Hide fullscreen icon|Hide fullscreen icon]]||Hide the fullscreen icon in the page Header (True | False). |
| + | |valign="top"|hideFullScreenIcon||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Header#Hide share icon|Hide share icon]]||Hide the share icon in the page Header (True | False). |
| + | |valign="top"|hideShareIcon||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Hide | + | |valign="top"|[[Page Header#Hide home icon|Hide home icon]]||Hide the home icon in the page Header (True | False). |
| + | |valign="top"|hidehomeicon||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Hide | + | |valign="top"|[[Page Header#Hide print icon|Hide print icon]]||Hide the print icon in the page Header (True | False). |
| + | |valign="top"|hideprinticon||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Hide | + | |valign="top"|[[Page Header#Hide hamburger menu|Hide hamburger menu]]||Hide the hamburger menu icon at runtime (True | False). |
| + | |valign="top"|hidehamburgermenuicon||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Hide | + | |valign="top"|[[Page Header#Hide navigation history icons|Hide navigation history icons]]||Hide the navigation history buttons in the page header (True | False). |
| + | |valign="top"|hidenavigationhistorybuttons||valign="top"|Boolean | ||
|- | |- | ||
|} | |} | ||
| Line 127: | Line 302: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="40%"|Description |
| − | !width=" | + | !width="30%"|Name |
| + | !width="10%"|Type | ||
|- | |- | ||
| − | |valign="top"|Visible||Footer visible (True|False)|| | + | |valign="top"|[[Page Footers#Visible|Visible]]||Footer visible (True | False). |
| + | |valign="top"|footerVisible||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Footers#Custom footer display delegate|Custom footer display delegate]]||The name of a procedure/function that will render the page footer. |
| + | |valign="top"|customfooterdisplay||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Footers#Height|Height]]||Footer height. |
| + | |valign="top"|footerHeight||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Footers#Background color|Background color]]||Footer background color. |
| + | |valign="top"|footerBackColor||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Footers#Foreground color|Foreground color]]||Footer foreground color. |
| + | |valign="top"|footerForeColor||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Footers#Footer image|Footer image]]||The image for the Footer (png | jpg | gif).<br>Use app:/imagename.ext for app specific images. |
| + | |valign="top"|footerImage||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Gradient | + | |valign="top"|[[Gradients#Gradient colors|Gradient colors]]||Render the Footer background color as a gradient (True | False). |
| + | |valign="top"|footerGradient||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Gradient | + | |valign="top"|[[Gradients#Gradient type|Gradient type]]||Specify the gradient type. |
| + | |valign="top"|footerGradientType||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|Gradient | + | |valign="top"|[[Gradients#Gradient start color|Gradient start color]]||Gradient start color. |
| + | |valign="top"|footerFromColor||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Gradients#Gradient end color|Gradient end color]]||Gradient end color. |
| + | |valign="top"|footerToColor||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Refresh interval||The interval in seconds that the Footer content will be refreshed|| | + | |valign="top"|[[Page Footers#Refresh interval|Refresh interval]]||The interval in seconds that the Footer content will be refreshed. |
| + | |valign="top"|footerCustomGadgetRefreshInterval||valign="top"|Int | ||
|- | |- | ||
|} | |} | ||
| Line 157: | Line 344: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="40%"|Description |
| − | !width=" | + | !width="30%"|Name |
| + | !width="10%"|Type | ||
|- | |- | ||
| − | |valign="top"|Show left sidebar||Show left sidebar (True|False)|| | + | |valign="top"|[[Left Sidebar#Show left sidebar|Show left sidebar]]||Show left sidebar (True | False). |
| + | |valign="top"|leftSidebarVisible||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Collapse left sidebar||Collapse left sidebar when the App is first loaded (True|False)|| | + | |valign="top"|[[Left Sidebar#Collapse left sidebar|Collapse left sidebar]]||Collapse left sidebar when the App is first loaded (True | False). |
| + | |valign="top"|collapseLeftSidebar||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Width||Left sidebar width|| | + | |valign="top"|[[Left Sidebar#Width|Width]]||Left sidebar width. |
| + | |valign="top"|leftSidebarWidth||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|Show left sidebar logo image||Show left sidebar logo image (True|False)|| | + | |valign="top"|[[Left Sidebar#Show left sidebar logo image|Show left sidebar logo image]]||valign="top"|Show left sidebar logo image (True | False). |
| + | |valign="top"|leftSidebarImageVisible||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Logo image||The logo displayed at the top of the left sidebar (png|jpg|gif).<br>Use app:/imagename.ext for app specific images.|| | + | |valign="top"|[[Left Sidebar#Logo image|Logo image]]||The logo displayed at the top of the left sidebar (png | jpg | gif).<br>Use app:/imagename.ext for app specific images. |
| + | |valign="top"|leftSidebarImage||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Show login panel||Show the login panel in the left sidebar (True|False)|| | + | |valign="top"|[[Left Sidebar#Show login panel|Show login panel]]||Show the login panel in the left sidebar (True | False). |
| + | |valign="top"|leftSidebarLoginPanelVisible||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Show Apps||Show the Apps menu in the left sidebar (True|False)|| | + | |valign="top"|[[Left Sidebar#Show Apps|Show Apps]]||Show the Apps menu in the left sidebar (True | False). |
| + | |valign="top"|leftSidebarAppsVisible||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Show Apps Caption||Show the Apps caption above the Apps menu (True|False)|| | + | |valign="top"|[[Left Sidebar#Show Apps Caption|Show Apps Caption]]||Show the Apps caption above the Apps menu (True | False). |
| + | |valign="top"|leftSidebarAppsHeaderVisible||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Show Menu||Show the page menu in the left sidebar (True|False)|| | + | |valign="top"|[[Left Sidebar#Show Menu|Show Menu]]||Show the page menu in the left sidebar (True | False). |
| + | |valign="top"|leftSidebarMenuVisible||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Show Recent Items||Show Watches, Favorites, Recently Viewed/Modified items and Instant Selections in the left sidebar (True|False)|| | + | |valign="top"|[[Left Sidebar#Show Recent Items|Show Recent Items]]||Show Watches, Favorites, Recently Viewed/Modified items and Instant Selections in the left sidebar (True | False). |
| + | |valign="top"|leftSidebarItemsVisible||Boolean | ||
|- | |- | ||
| − | |valign="top"|Background color||Left sidebar background color|| | + | |valign="top"|[[Left Sidebar#Background color|Background color]]||Left sidebar background color. |
| + | |valign="top"|leftSidebarBackColor||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Foreground color||Left sidebar foreground color|| | + | |valign="top"|[[Left Sidebar#Foreground color|Foreground color]]||Left sidebar foreground color. |
| + | |valign="top"|leftSidebarForeColor||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Border color||Left sidebar border color|| | + | |valign="top"|[[Left Sidebar#Border color|Border color]]||Left sidebar border color. |
| + | |valign="top"|leftSidebarBorderColor||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Left Sidebar#Header colors|Header colors]]||A comma-separated list of colors:<br>foreground:background:bottombordercolor<br>From v9.6.4. |
| + | |valign="top"|leftSidebarColors||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Left Sidebar#Favorite items|Favorite items]]||The number of Favorites to display. |
| + | |valign="top"|leftSidebarFavoriteItems||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|Recently | + | |valign="top"|[[Left Sidebar#Recently viewed items|Recently viewed items]]||The number of Recently Viewed items to display. |
| + | |valign="top"|leftSidebarRecentlyViewedItems||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Left Sidebar#Recently modified items|Recently modified items]]||The number of Recently Modified items to display. |
| + | |valign="top"|leftSidebarRecentlyModifiedItems||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|Refresh interval||The interval in seconds that the Instant Selections content will be refreshed|| | + | |valign="top"|[[Left Sidebar#Watched items|Watched items]]||The number of Watched items to display. |
| + | |valign="top"|leftSidebarWatchedItems||valign="top"|Int | ||
| + | |- | ||
| + | |valign="top"|[[Left Sidebar#Refresh interval|Refresh interval]]||The interval in seconds that the Instant Selections content will be refreshed. | ||
| + | |valign="top"|leftSidebarRefreshInterval||valign="top"|Int | ||
|- | |- | ||
|} | |} | ||
| Line 201: | Line 410: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="40%"|Description |
| − | !width=" | + | !width="30%"|Name |
| + | !width="10%"|Type | ||
|- | |- | ||
| − | |valign="top"|Show navigation panel||Show a Navigation panel on the left side of the page (True|False).<br>By default this is a TreeGrid, so you can load it in the load delegate for the page and structure it as a Grid or a Tree.|| | + | |valign="top"|[[Navigation Panel#Show navigation panel|Show navigation panel]]||Show a Navigation panel on the left side of the page (True | False).<br>By default this is a TreeGrid, so you can load it in the load delegate for the page and structure it as a Grid or a Tree. |
| + | |valign="top"|leftSidebarTreeVisible||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Collapsable||Enable collapsing and expanding for the Navigation panel (True|False)|| | + | |valign="top"|[[Navigation Panel#Collapsable|Collapsable]]||Enable collapsing and expanding for the Navigation panel (True | False). |
| + | |valign="top"|navigationPanelCollapsable||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Collapse when first loaded||Hide Navigation panel when first loaded.<br>Use $("page:yourpagename?action=shownavigationpanel") to show it and $("page:yourpagename?action=hidenavigationpanel") to hide it again|| | + | |valign="top"|[[Navigation Panel#Collapse when first loaded|Collapse when first loaded]]||Hide Navigation panel when first loaded.<br>Use $("page:yourpagename?action=shownavigationpanel") to show it and $("page:yourpagename?action=hidenavigationpanel") to hide it again. |
| + | |valign="top"|navigationPanelCollapseOnload||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Position on page||Navigation panel position on page(Left|Right)|| | + | |valign="top"|[[Navigation Panel#Position on page|Position on page]]||Navigation panel position on page(Left | Right). |
| + | |valign="top"|navigationPanelPosition||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Show caption||Show Navigation panel caption (True|False)|| | + | |valign="top"|[[Navigation Panel#Show caption|Show caption]]||Show Navigation panel caption (True | False). |
| + | |valign="top"|leftSidebarTreeCaptionVisible||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Caption height||Navigation panel caption height|| | + | |valign="top"|[[Navigation Panel#Caption height|Caption height]]||Navigation panel caption height. |
| + | |valign="top"|leftSidebarTreeCaptionHeight||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|Caption||Navigation panel caption|| | + | |valign="top"|[[Navigation Panel#Caption|Caption]]||Navigation panel caption. |
| + | |valign="top"|leftSidebarTreeCaption||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Width||Navigation panel width|| | + | |valign="top"|[[Navigation Panel#Width|Width]]||Navigation panel width. |
| + | |valign="top"|leftSidebarTreeWidth||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|Custom UI page||Specify an (optional) custom UI Page from the UI Page Library to embed into the Navigation panel|| | + | |valign="top"|[[Navigation Panel#Custom UI page|Custom UI page]]||Specify an (optional) custom UI Page from the [[Working with UI Page Libraries|UI Page Library]] to embed into the Navigation panel. |
| + | |valign="top"|leftSidebarTreeCustomPage||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Show child indicators||Show child indicators|| | + | |valign="top"|[[Navigation Panel#Show child indicators|Show child indicators]]||Show child indicators. |
| + | |valign="top"|leftSidebarTreeShowChildIndicators||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Alternating row colors||Alternating row colors|| | + | |valign="top"|[[Navigation Panel#Alternating row colors|Alternating row colors]]||Alternating row colors. |
| + | |valign="top"|leftSidebarTreeAlternatingColors||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Double click to select||Check this if you want the selection delegate to be called on a double-click rather than a single click|| | + | |valign="top"|[[Navigation Panel#Double click to select|Double click to select]]||Check this if you want the selection delegate to be called on a double-click rather than a single click. |
| + | |valign="top"|leftSidebarTreeDoubleClick||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Column headers||Specify a comma separated list of column headers|| | + | |valign="top"|[[Navigation Panel#Column headers|Column headers]]||Specify a comma separated list of column headers. |
| + | |valign="top"|leftSidebarTreeColumnHeaders||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Data source||Specify a comma separated list of items to load as caption#icon | + | |valign="top"|[[Navigation Panel#Data source|Data source]]||Specify a comma separated list of items to load as caption#icon, a SQL SELECT statement to load from a data source or specify a .rsp, .jssp or html page.<br>Note that you can optionally load the Navigation panel in the load delegate for the page. |
| + | |valign="top"|leftSidebarTreeDataSource||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Selection column||When using a multi column TreeGrid, specify the column you want to select when calling the selection delegate|| | + | |valign="top"|[[Navigation Panel#Selection column|Selection column]]||When using a multi column TreeGrid, specify the column you want to select when calling the selection delegate. |
| + | |valign="top"|leftSidebarTreeSelectionColumn||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Item sync expression||Specify an expression to evaluate to keep the TreeGrid in sync while data is navigated in the page|| | + | |valign="top"|[[Navigation Panel#Item sync expression|Item sync expression]]||Specify an expression to evaluate to keep the TreeGrid in sync while data is navigated in the page. |
| + | |valign="top"|leftSidebarTreeItemExpr||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Selection delegate||Specify a delegate to call when a row is clicked.<br>Note that you can use an 'inline' delegate like this: $("section:yoursectionid?action=search&text={}")<br>Notice how {} is used to substitute the value of the item selected.|| | + | |valign="top"|[[Custom Delegates#Selection delegate|Selection delegate]]||Specify a delegate to call when a row is clicked.<br>Note that you can use an 'inline' delegate like this: $("section:yoursectionid?action=search&text={}")<br>Notice how {} is used to substitute the value of the item selected. |
| + | |valign="top"|navTreeSelectionAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Show ActionBar||Show the actionbar at the bottom of the Navigation panel (True|False)|| | + | |valign="top"|[[Navigation Panel#Show ActionBar|Show ActionBar]]||Show the actionbar at the bottom of the Navigation panel (True | False). |
| + | |valign="top"|navTreeActionbarVisible||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Add delegate||Specify a delegate to call when the 'Add' icon is clicked.<br>Note that you can use an 'inline' delegate like this: $("section:yoursectionid?action=add")|| | + | |valign="top"|[[Custom Delegates#Add delegate|Add delegate]]||Specify a delegate to call when the 'Add' icon is clicked.<br>Note that you can use an 'inline' delegate like this: $("section:yoursectionid?action=add"). |
| + | |valign="top"|navTreeAddAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Delete delegate||Specify a delegate to call when the 'Delete' icon is clicked.<br>Note that you can use an 'inline' delegate like this: $("section:yoursectionid?action=delete")|| | + | |valign="top"|[[Custom Delegates#Delete delegate|Delete delegate]]||Specify a delegate to call when the 'Delete' icon is clicked.<br>Note that you can use an 'inline' delegate like this: $("section:yoursectionid?action=delete"). |
| + | |valign="top"|navTreeDeleteAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Row height||Row height for the Tree items in the Navigation panel|| | + | |valign="top"|[[Navigation Panel#Row height|Row height]]||Row height for the Tree items in the Navigation panel. |
| + | |valign="top"|leftSidebarTreeRowheight||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|Font size||Font size for the Tree items in the Navigation panel|| | + | |valign="top"|[[Navigation Panel#Font size|Font size]]||Font size for the Tree items in the Navigation panel. |
| + | |valign="top"|leftSidebarTreeFontsize||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|CSS style||CSS style for the Navigation panel and its Tree (separate attributes with ; or use app:/filename.css)|| | + | |valign="top"|[[CSS|CSS style]]||CSS style for the Navigation panel and its Tree (separate attributes with ; or use app:/filename.css). |
| + | |valign="top"|leftSidebarTreeStylesheet||valign="top"|Character | ||
|- | |- | ||
|} | |} | ||
| Line 255: | Line 488: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="40%"|Description |
| − | !width=" | + | !width="30%"|Name |
| + | !width="10%"|Type | ||
|- | |- | ||
| − | |valign="top"|Show right sidebar||Show right sidebar (True|False)|| | + | |valign="top"|[[Right Sidebar#Show_right_sidebar|Show right sidebar]]||Show right sidebar (True | False). |
| + | |valign="top"|rightSidebarVisible||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Right Sidebar#Autosize gadgets|Autosize gadgets]]||Autosize the right sidebar gadgets for the height of the Page (True | False). From v9.6. |
| + | |valign="top"|rightsidebarautosize||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Right Sidebar#Collapse_right_sidebar|Collapse right sidebar]]||Collapse right sidebar when the App is first loaded (True | False). |
| + | |valign="top"|collapseRightSidebar||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Right Sidebar#Width|Width]]||Right sidebar width. |
| + | |valign="top"|rightSidebarWidth||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Right Sidebar#Background_color|Background color]]||Right sidebar background color. |
| + | |valign="top"|rightSidebarBackColor||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Right Sidebar#Foreground_color|Foreground color]]||Right sidebar foreground color. |
| + | |valign="top"|rightSidebarForeColor||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Right Sidebar#Border_color|Border color]]||Right sidebar border color. |
| + | |valign="top"|rightSidebarBorderColor||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Right Sidebar#Header_colors|Header colors]]||A comma-separated list of colors:<br>foreground:background:bottombordercolor<br>From v9.6.4. |
| + | |valign="top"|rightSidebarColors||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Right Sidebar#Custom_content_gadget|Custom content gadget]]||Gadget based on custom script. |
| + | |valign="top"| ||valign="top"| | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Show|+ Show]]||Show the custom content gadget (True | False). |
| + | |valign="top"|rightSidebarCustomGadgetVisible||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Expanded|+ Expanded]]||Expand the custom content gadget when the App is first loaded (True | False). |
| + | |valign="top"|rightSidebarCustomGadgetExpanded||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Height|+ Height]]||Custom content gadget height. |
| + | |valign="top"|rightSidebarCustomGadgetHeight||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Stretch|+ Stretch]]||Stretch the custom content into the right sidebar (True | False). |
| + | |valign="top"|rightSidebarCustomGadgetStretch||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Caption|+ Caption]]||Custom content gadget caption. |
| + | |valign="top"|rightSidebarCustomGadgetCaption||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Right Sidebar#Gadget|+ Gadget]]||The gadget to be displayed. |
| + | |valign="top"|rightSidebarCustomGadget||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Refresh_interval|+ Refresh interval]]||The interval in seconds that the content will be refreshed. |
| + | |valign="top"|rightSidebarCustomGadgetRefreshInterval||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Right Sidebar#Content_gadget_.231|Content gadget #1]]||Gadget based on URL. |
| + | |valign="top"| ||valign="top"| | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Show_2|+ Show]]||Show the gadget (True | False). |
| + | |valign="top"|rightSidebarContentVisible1||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Expanded_2|+ Expanded]]||Expand the gadget when the App is first loaded (True | False). |
| + | |valign="top"|rightSidebarContentExpanded1||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Height_2|+ Height]]||Gadget height. |
| + | |valign="top"|rightSidebarContentHeight1||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Caption_2|+ Caption]]||Gadget caption. |
| + | |valign="top"|rightSidebarContentCaption1||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#URL|+ URL]]||The URL of the content to be displayed. |
| + | |valign="top"|rightSidebarContentUrl1||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Right Sidebar#Refresh_interval_2|+ Refresh interval]]||The interval in seconds that the content will be refreshed. |
| + | |valign="top"|rightSidebarcontentInterval1||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Right Sidebar#Content_gadget_.232|Content gadget #2]]||Gadget based on URL. |
| + | |valign="top"| ||valign="top"| | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Show_3|+ Show]]||Show the gadget (True | False). |
| + | |valign="top"|rightSidebarContentVisible2||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Expanded_3|+ Expanded]]||Expand the gadget when the App is first loaded (True | False). |
| + | |valign="top"|rightSidebarContentExpanded2||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Height_3|+ Height]]||Gadget height. |
| + | |valign="top"|rightSidebarContentHeight2||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|+ Caption||Gadget caption|| | + | |valign="top"|[[Right Sidebar#Caption_3|+ Caption]]||Gadget caption. |
| + | |valign="top"|rightSidebarContentCaption2||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|+ URL||The URL of the content to be displayed|| | + | |valign="top"|[[Right Sidebar#URL_2|+ URL]]||The URL of the content to be displayed. |
| + | |valign="top"|rightSidebarContentUrl2||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|+ Refresh interval||The interval in seconds that the content will be refreshed|| | + | |valign="top"|[[Right Sidebar#Refresh_interval_3|+ Refresh interval]]||The interval in seconds that the content will be refreshed. |
| + | |valign="top"|rightSidebarcontentInterval2||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|Content gadget #3||Gadget based on URL|| | + | |valign="top"|[[Right Sidebar#Content_gadget_.233|Content gadget #3]]||Gadget based on URL. |
| + | |valign="top"| ||valign="top"| | ||
|- | |- | ||
| − | |valign="top"|+ Show||Show the gadget (True|False)|| | + | |valign="top"|[[Right Sidebar#Show_4|+ Show]]||Show the gadget (True | False). |
| + | |valign="top"|rightSidebarContentVisible3||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|+ Expanded||Expand the gadget when the App is first loaded (True|False)|| | + | |valign="top"|[[Right Sidebar#Expanded_4|+ Expanded]]||Expand the gadget when the App is first loaded (True | False). |
| + | |valign="top"|rightSidebarContentExpanded3||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|+ Height||Gadget height|| | + | |valign="top"|[[Right Sidebar#Height_4|+ Height]]||Gadget height. |
| + | |valign="top"|rightSidebarContentHeight3||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Caption_4|+ Caption]]||Gadget caption. |
| + | |valign="top"|rightSidebarContentCaption3||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#URL_3|+ URL]]||The URL of the content to be displayed. |
| + | |valign="top"|rightSidebarContentUrl3||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Refresh_interval_4|+ Refresh interval]]||The interval in seconds that the content will be refreshed. |
| + | |valign="top"|rightSidebarcontentInterval3||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Right Sidebar#Content_gadget_.234|Content gadget #4]]||Gadget based on URL. |
| + | |valign="top"| ||valign="top"| | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Right Sidebar#Show_5|+ Show]]||Show the gadget (True | False). |
| + | |valign="top"|rightSidebarContentVisible4||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Expanded_5|+ Expanded]]||Expand the gadget when the App is first loaded (True | False). |
| + | |valign="top"|rightSidebarContentExpanded4||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Height_5|+ Height]]||Gadget height. |
| + | |valign="top"|rightSidebarContentHeight4||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Caption_5|+ Caption]]||Gadget caption. |
| + | |valign="top"|rightSidebarContentCaption4||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#URL_4|+ URL]]||The URL of the content to be displayed. |
| + | |valign="top"|rightSidebarContentUrl4||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|+ | + | |valign="top"|[[Right Sidebar#Refresh_interval_5|+ Refresh interval]]||The interval in seconds that the content will be refreshed. |
| − | + | |valign="top"|rightSidebarcontentInterval4||valign="top"|Int | |
| − | |valign="top"| | + | |
| − | + | ||
| − | |valign="top"| | + | |
|- | |- | ||
|} | |} | ||
| Line 355: | Line 629: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="40%"|Description |
| − | !width=" | + | !width="30%"|Name |
| + | !width="10%"|Type | ||
| + | |- | ||
| + | |valign="top"|[[Custom Delegates#Scripting Language|Scripting language]]||The default scripting language for custom code in this page (Inherit | Recital | Visual FoxPro | Python | JavaScript | PHP). | ||
| + | |valign="top"|scriptingLanguage||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Custom Delegates#Custom Library|Custom library]]||The filename of the library containing code for event handlers and custom procedures/functions. | ||
| + | |valign="top"|customLibrary||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Custom Delegates#Print|Print]]||The delegate for the Print event. This is called when you click the 'Print' icon. | ||
| + | |valign="top"|printAction||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Custom Delegates#Hotkey|Hotkey]]||The delegate for the Hotkey event. | ||
| + | |valign="top"|hotkeyAction||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Custom Delegates#Enabled When|Enabled When]]||The delegate for the EnabledWhen event. | ||
| + | |valign="top"|enabledWhenAction||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Custom Delegates#Visible When|Visible When]]||The delegate for the VisibleWhen event. | ||
| + | |valign="top"|visibleWhenAction||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Custom Delegates#Valid When|Valid When]]||The delegate for the ValidWhen event. | ||
| + | |valign="top"|validWhenAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Custom Delegates#Activate|Activate]]||The delegate for the Activate event. |
| + | |valign="top"|activateAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Custom | + | |valign="top"|[[Custom Delegates#Deactivate|Deactivate]]||The delegate for the Deactivate event. |
| + | |valign="top"|deactivateAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Custom Delegates#Init|Init]]||The delegate for the Init event. |
| + | |valign="top"|initAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Custom Delegates#Destroy|Destroy]]||The delegate for the Destroy event. |
| + | |valign="top"|destroyAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Custom Delegates#Load|Load]]||The delegate for the Load event. |
| + | |valign="top"|loadAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Custom Delegates#Ready|Ready]]||The delegate for the Ready event. |
| + | |valign="top"|readyAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Custom Delegates#Unload|Unload]]||The delegate for the Unload event. |
| + | |valign="top"|unloadAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Custom Delegates#Change|Change]]||The delegate for the Change event. |
| + | |valign="top"|changedAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Custom Delegates#State Changed|Statechanged]]||The delegate for the Statechanged event. |
| + | |valign="top"|stateChangedAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Custom Delegates#Before Refresh|Before Refresh action]]||The delegate for the BeforeRefresh event. From v6.2. |
| + | |valign="top"|beforeRefreshAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Custom Delegates#After Refresh|After Refresh action]]||The delegate for the AfterRefresh event. |
| + | |valign="top"|afterRefreshAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Custom Delegates#Timer|Timer]]||The delegate for the Timer event. |
| + | |valign="top"|timerAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Custom Delegates#Timer interval|Timer interval]]||The timer interval in seconds that the Timer event will be called at runtime. |
| + | |valign="top"|timerInterval||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Custom Delegates#Custom options menu|Custom options menu]]||The delegate for the Custom menu event. |
| + | |valign="top"|customMenuAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Custom Delegates#Custom settings menu|Custom settings menu]]||The delegate for the Custom settings menu event. The text of the menuitem selected is passed as a parameter. |
| + | |valign="top"|customSettingsAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Custom | + | |valign="top"|[[Custom Delegates#Custom search|Custom search]]||The delegate for the Search event. |
| + | |valign="top"|customSearch||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Custom search||The delegate for the Search event|| | + | |valign="top"|[[Custom Delegates#Instant search|Instant search]]||The delegate for the Instant Search event. The text typed in the searchbox is passed as a parameter. |
| + | |valign="top"|searchAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Instant | + | |valign="top"|[[Custom Delegates#Instant selection|Instant selection]]||The delegate for the Instant Selection event. The filter condition is passed as a parameter. From v5.5.1. |
| + | |valign="top"|selectionAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|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|| | + | |valign="top"|[[Custom Delegates#Dialog button delegate|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. |
| + | |valign="top"|dialogButtonAction||valign="top"|Character | ||
|- | |- | ||
|} | |} | ||
| Line 401: | Line 716: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="40%"|Description |
| − | !width=" | + | !width="30%"|Name |
| + | !width="10%"|Type | ||
|- | |- | ||
| − | |valign="top"|Swipe navigation||Enable swipe left and swipe right to navigate between Pages (True|False)|| | + | |valign="top"|[[Gestures|Swipe navigation]]||Enable swipe left and swipe right to navigate between Pages (True | False). |
| + | |valign="top"|swipeNavigation||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Gestures enabled||Enable gestures for this page: swipe, pan, pinch, tap and tapandhold (True|False).<br>If enabled, then the Gestures delegate will be called with two arguments, e.g. 'swipe','left' or 'swipe','right'|| | + | |valign="top"|[[Gestures|Gestures enabled]]||Enable gestures for this page: swipe, pan, pinch, tap and tapandhold (True | False).<br>If enabled, then the Gestures delegate will be called with two arguments, e.g. 'swipe','left' or 'swipe','right'. |
| + | |valign="top"|gesturesEnabled||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Swipe left gesture| | + | |valign="top"|[[Custom Delegates#Swipe left gesture|Swipe left gesture]]||The delegate for the gestureSwipeLeft event. |
| + | |valign="top"|gestureSwipeLeftAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Swipe right gesture| | + | |valign="top"|[[Custom Delegates#Swipe right gesture|Swipe right gesture]]||The delegate for the gestureSwipeRight event. |
| + | |valign="top"|gestureSwipeRightAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Swipe up gesture| | + | |valign="top"|[[Custom Delegates#Swipe up gesture|Swipe up gesture]]||The delegate for the gestureSwipeUp event. |
| + | |valign="top"|gestureSwipeUpAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Swipe down gesture| | + | |valign="top"|[[Custom Delegates#Swipe down gesture|Swipe down gesture]]||The delegate for the gestureSwipeDown event. |
| + | |valign="top"|gestureSwipeDownAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Pan gesture| | + | |valign="top"|[[Custom Delegates#Pan gesture|Pan gesture]]||The delegate for the gesturePan event. |
| + | |valign="top"|gesturePanAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Pinch gesture| | + | |valign="top"|[[Custom Delegates#Pinch gesture|Pinch gesture]]||The delegate for the gesturePinch event. |
| + | |valign="top"|gesturePinchAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Tap gesture| | + | |valign="top"|[[Custom Delegates#Tap gesture|Tap gesture]]||The delegate for the gestureTap event. |
| + | |valign="top"|gestureTapAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Tap and hold gesture| | + | |valign="top"|[[Custom Delegates#Tap and hold gesture|Tap and hold gesture]]||The delegate for the gestureTapAndHold event. |
| + | |valign="top"|gestureTapAndHoldAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Gestures||The catch all delegate for the | + | |valign="top"|[[Custom Delegates#Gestures|Gestures]]||The catch all delegate for the gestures event. |
| + | |valign="top"|gesturesAction||valign="top"|Character | ||
|- | |- | ||
|} | |} | ||
| Line 431: | Line 758: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="40%"|Description |
| − | !width=" | + | !width="30%"|Name |
| + | !width="10%"|Type | ||
|- | |- | ||
| − | |valign="top"|Add action||The custom action function for Add. | + | |valign="top"|[[Custom Delegates#Custom Actions|Add action]]||The custom action function for Add.<br>This will be called to add a record. |
| + | |valign="top"|addAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Delete action||The custom action function for Delete. | + | |valign="top"|[[Custom Delegates#Custom Actions|Delete action]]||The custom action function for Delete.<br>This will be called to delete a record. |
| + | |valign="top"|deleteAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Refresh action||The custom action function for Refresh. | + | |valign="top"|[[Custom Delegates#Custom Actions|Refresh action]]||The custom action function for Refresh.<br>This will be called to refresh the current record. |
| + | |valign="top"|refreshAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|First action||The custom action function for First. | + | |valign="top"|[[Custom Delegates#Custom Actions|First action]]||The custom action function for First.<br>This will be called to read the first record. |
| + | |valign="top"|firstAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Previous action||The custom action function for Previous. | + | |valign="top"|[[Custom Delegates#Custom Actions|Previous action]]||The custom action function for Previous.<br>This will be called to read the previous record. |
| + | |valign="top"|previousAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Next action||The custom action function for Next. | + | |valign="top"|[[Custom Delegates#Custom Actions|Next action]]||The custom action function for Next.<br>This will be called to read the next record. |
| + | |valign="top"|nextAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Last action||The custom action function for Last. | + | |valign="top"|[[Custom Delegates#Custom Actions|Last action]]||The custom action function for Last.<br>This will be called to read the last record. |
| + | |valign="top"|lastAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Edit action||The custom action function for Edit. | + | |valign="top"|[[Custom Delegates#Custom Actions|Edit action]]||The custom action function for Edit.<br>This will be called to edit the current record. |
| + | |valign="top"|editAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Save action||The custom action function for Save. | + | |valign="top"|[[Custom Delegates#Custom Actions|Save action]]||The custom action function for Save.<br>This will be called to save changes. |
| + | |valign="top"|saveAction||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Cancel action||The custom action function for Cancel. | + | |valign="top"|[[Custom Delegates#Custom Actions|Cancel action]]||The custom action function for Cancel.<br>This will be called to cancel changes. |
| + | |valign="top"|cancelAction||valign="top"|Character | ||
|- | |- | ||
|} | |} | ||
| Line 459: | Line 797: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="40%"|Description |
| − | !width=" | + | !width="30%"|Name |
| + | !width="10%"|Type | ||
|- | |- | ||
| − | |valign="top"|Create roles||A comma separated list of roles that can perform create operations on data in the page|| | + | |valign="top"|[[Users and Roles|Create roles]]||A comma separated list of roles that can perform create operations on data in the page. |
| + | |valign="top"|permcreate||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Read roles||A comma separated list of roles that can read (and view) the page|| | + | |valign="top"|[[Users and Roles|Read roles]]||A comma separated list of roles that can read (and view) the page. |
| + | |valign="top"|permRead||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Update roles||A comma separated list of roles that can perform update operations on data in the page|| | + | |valign="top"|[[Users and Roles|Update roles]]||A comma separated list of roles that can perform update operations on data in the page. |
| + | |valign="top"|permUpdate||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Delete roles||A comma separated list of roles that can perform delete operations on data in the page|| | + | |valign="top"|[[Users and Roles|Delete roles]]||A comma separated list of roles that can perform delete operations on data in the page. |
| + | |valign="top"|permDelete||valign="top"|Character | ||
|- | |- | ||
|} | |} | ||
| Line 475: | Line 818: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="40%"|Description |
| − | !width=" | + | !width="30%"|Name |
| + | !width="10%"|Type | ||
|- | |- | ||
| − | |valign="top"|Desktop||Include this page in a Desktop client (True|False)|| | + | |valign="top"|[[UI Presentation Rules#Desktop|Desktop]]||Include this page in a Desktop client (True | False). |
| + | |valign="top"|desktopUI||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Web||Include this page in a Web client (True|False)|| | + | |valign="top"|[[UI Presentation Rules#Web|Web]]||Include this page in a Web client (True | False). |
| + | |valign="top"|webUI||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Tablet||Include this page in a Tablet client (True|False)|| | + | |valign="top"|[[UI Presentation Rules#Tablet|Tablet]]||Include this page in a Tablet client (True | False). |
| + | |valign="top"|tabletUI||valign="top"|Boolean | ||
|- | |- | ||
| − | |valign="top"|Phone||Include this page in a Phone client (True|False)|| | + | |valign="top"|[[UI Presentation Rules#Phone|Phone]]||Include this page in a Phone client (True | False). |
| + | |valign="top"|mobileUI||valign="top"|Boolean | ||
|- | |- | ||
| − | |UI | + | |valign="top"|[[UI Presentation Rules#Use mobile navigation bar|Use mobile navigation bar]]||Use a mobile styled navigation bar (material UI style) (True | False). |
| + | |valign="top"|mobilenavbar||valign="top"|Boolean | ||
|- | |- | ||
| − | | | + | |valign="top"|[[UI Presentation Rules#UI States|UI States]]||UI states that affect this page. Specify multiple states as a comma separated list. |
| + | |valign="top"|state||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[UI Presentation Rules#Initial UI state|Initial UI state]]||The initial UI state for this page. This will be applied to the page and all its sections and fields. |
| + | |valign="top"|uiStateInit||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[UI Presentation Rules#Readonly when|Readonly when]]||Page is readonly at runtime if specified expression evaluates to true. |
| + | |valign="top"|readonlyWhen||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Page | + | |valign="top"|[[UI Presentation Rules#Visible when|Visible when]]||Page is visible at runtime if specified expression evaluates to true. |
| + | |valign="top"|visibleWhen||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Apply rules on change||Apply | + | |valign="top"|[[UI Presentation Rules#Page transition effect|Page transition effect]]||The page transition effect when navigating between pages on Web/Tablet/Phone. (None | Fade | Pop | Flip | Turn | Flow | SlideFade | Slide | SlideUp | SlideDown). |
| + | |valign="top"|pageTransition||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"|applyRulesOnChange||valign="top"|Boolean | ||
| + | |- | ||
| + | |valign="top"|[[UI Presentation Rules#Navigation Panel Responsive UI width breakpoint|Navigation Panel Responsive UI width breakpoint]]||The Navigation Panel responsive UI width breakpoint in Web/Mobile Apps. From v5.4. | ||
| + | |valign="top"|navpanelresponsivewidth||valign="top"|Int | ||
|- | |- | ||
|} | |} | ||
| Line 503: | Line 863: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
| − | !width=" | + | !width="40%"|Description |
| − | !width=" | + | !width="30%"|Name |
| + | !width="10%"|Type | ||
|- | |- | ||
| − | |valign="top"|Category||The category in which the Tile should be displayed in the Page Center|| | + | |valign="top"|[[Page Center Tiles#Category|Category]]||The category in which the Tile should be displayed in the Page Center. |
| + | |valign="top"|tileCategory||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Tile caption||The caption for the Tile in the Page Center|| | + | |valign="top"|[[Page Center Tiles#Tile caption|Tile caption]]||The caption for the Tile in the Page Center. |
| + | |valign="top"|tileCaption||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Tile icon||The icon for the Tile in the Page Center|| | + | |valign="top"|[[Page Center Tiles#Tile icon|Tile icon]]||The icon for the Tile in the Page Center. |
| + | |valign="top"|tileIcon||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"|Tile size||The size of the Tile in the Page Center|| | + | |valign="top"|[[Page Center Tiles#Tile size|Tile size]]||The size of the Tile in the Page Center. |
| + | |valign="top"|tileSize||valign="top"|Character | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|[[Page Center Tiles#Tile order|Tile order]]||The order of the Tile in the Page Center (from v4.0). |
| + | |valign="top"|tileOrder||valign="top"|Int | ||
|- | |- | ||
| − | |valign="top"|Foreground color||The foreground color for the Tile displayed in the Page Center|| | + | |valign="top"|[[Page Center Tiles#Background color|Background color]]||The background color for the Tile displayed in the Page Center. |
| + | |valign="top"|tileBackColor||valign="top"|Character | ||
| + | |- | ||
| + | |valign="top"|[[Page Center Tiles#Foreground color|Foreground color]]||The foreground color for the Tile displayed in the Page Center. | ||
| + | |valign="top"|tileForeColor||valign="top"|Character | ||
|- | |- | ||
|} | |} | ||
| + | |||
| + | [[Category:Attributes|2 Page]] | ||
| + | [[Category:Pages]] | ||
| + | [[Category:PageAnatomy]] | ||
Latest revision as of 11:23, 8 May 2024
Contents
Overview
Setting Attributes Declaratively
You adjust the appearance and behavior of each UI Element in the Attributes Tab of the App Inspector.
The attributes available consist of some common ones as well as some specific to the UI Element being inspected.
Getting and Setting Attributes Programatically
The setAttribute(name, value) method can be used to set the value of an Attribute:
Lianja.get("pageid").setAttribute("title","Page1")
Note: on the desktop, 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").getAttribute("title")
Note: on the desktop, the shortened form getAttr(name) is also available.
Attributes
Details
| Attribute | Description | Name | Type |
|---|---|---|---|
| Name | The unique name for this page. | id | Character |
| Title | The menu title for this page. | title | Character |
| Alias name | The alias name for this page. | aliasid | Character |
| App Doc | The App Doc file for this page. This will be included in the App Doc when it is generated. | appdoc | Character |
| Meta types | A comma separated list of metatype names. | metatypes | Character |
| Custom Props | A ';' separated list of custom prop key pairs, e.g. name=barry;company=lianja From v5.3. |
customprops | Character |
| Menu icon image | The menu icon image for the title (png | jpg | gif). Use app:/imagename.ext for app specific images. Note that in the mobile client this icon will be displayed in the PageBar. |
menuIcon | Character |
| Autosave in Page Library | Always save this page to the UI Page Library when an App is saved. | alwaysSaveInPageLibrary | Boolean |
| Query Page | When this is checked, no data is shown until a search or filter has been performed. | queryPage | Boolean |
| Mobile login Page | When this is checked, this page will be used as the Mobile login page. | loginPage | Boolean |
| Deferred load | When this is checked, this page will be loaded with data only when it is first activated (speeds up App load time). | deferredLoad | Boolean |
| Refresh when activated | Refresh all sections on this page when the page is activated. | refreshWhenActivated | Boolean |
| Full page edit | Edit all editable sections on this page when the page is edited. | fullPageEdit | Boolean |
Printing
| Attribute | Description | Name | Type |
|---|---|---|---|
| Print report header | Print the report header when printing an Instant Report. From v6.1. | printreportheader | Boolean |
| Report header | Instant Report header text. This can contain HTML. From v6.1. | reportheader | Character |
| Print report footer | Print the report footer when printing an Instant Report. From v6.1. | printreportfooter | Boolean |
| Report footer | Instant Report footer text. This can contain HTML. From v6.1. | reportfooter | Character |
| Report CSS style | CSS style for rendered Instant Report image. From v6.1. e.g. height:11in;width:8.5in |
reportstyle | Character |
Appearance
| Attribute | Description | Name | Type |
|---|---|---|---|
| Current page height | Current page height (displayed in Attributes only). | ||
| Background color | Page background color. | backColor | Character |
| Foreground color | Page foreground color. | foreColor | Character |
| CSS style | CSS style (separate attributes with ; or use app:/filename.css). | cssStyle | Character |
| Gradient colors | Render the background color as a gradient (True | False). | pageGradient | Boolean |
| Gradient type | Specify the gradient type. | pageGradientType | Int |
| Gradient start color | Gradient start color. | pageFromColor | Character |
| Gradient end color | Gradient end color. | pageToColor | Character |
| Transparency | Specify a transparency percentage from 0 to 100. | transparency | Int |
| Background image | The background image for the page (png | jpg | gif). Use app:/imagename.ext for app specific images. |
picture | Character |
| Stretch image | Stretch the background image to fill the page (True | False). | stretch | Boolean |
| Margin | Margin size around the page. | marginSize | Int |
| Hide page from menu | Hide page from menu at runtime. | hideFromMenuAtRuntime | Boolean |
| Register in UILib | Register the page in the UILib. This allows the page and/or its sections to be rendered in a Lianja.showDialog() / showDialogPanel() (True | False). From v6.0. | registerinuilib | Boolean |
| Accordion behavior | Render as accordion sections (True | False). | accordionAtRuntime | Boolean |
| Use Accordions | Render as accordion sections on low resolution displays. | useAccordionOnLowres | Boolean |
| Use Accordions height | Render as accordion sections on low resolution displays less than this height. | useAccordionOnLowresValue | Int |
| Stacked behavior at runtime | Treat accordion sections as stacked at runtime allowing the sections to be made raised from the Navigation Panel. | accordionStackAtRuntime | Boolean |
| Stretch last section | Stretch last section to bottom of page. | stretchLastSectionAtRuntime | Boolean |
| Auto layout sections | Auto layout sections by section percentage. | autoLayoutSections | Boolean |
| Last section min height | If the last section is less than this height, then set it to this height and show page vertical scrollbar. | stretchLastSectionMinHeight | Int |
| Last section fixed height | The last section is set to this fixed height and the previous section expanded to fill the space. | stretchLastSectionMaxHeight | Int |
| Hide actionbar | Hide the actionbar. | hideActionBarAtRuntime | Boolean |
| Hide navigation bar slider | Hide the navigation bar slider. | hideSlider | Boolean |
| Hide navigation bar buttons | Hide specific navigation bar buttons. | hideactionbarbuttonlist | Character |
| Sync actionbar buttons | Keep the actionbar buttons in sync with the current data position. Turn this off to improve performance with large amounts of data. | syncActionBar | Boolean |
| Show settings icon | Show the settings menu icon in the actionbar. | showSettingsButton | Boolean |
| Custom settings menu | Custom settings menu (comma separated list of values). | customSettingsMenu | Character |
| Show options icon | Show the options menu icon in the actionbar. | showOptionsButton | Boolean |
| Custom options menu | Custom options menu (comma separated list of values). | customOptionsMenu | Character |
| Show scrollbar | Show a vertical scrollbar for the page. | scrollbarVisibleAtRuntime | Boolean |
| Show scrollbar height | Show vertical scrollbar on low resolution displays less than this height. | useScrollbarMinHeight | Boolean |
| Navigation bar background color | Navigation bar background color. | navbarBackColor | Character |
Header
| Attribute | Description | Name | Type |
|---|---|---|---|
| Visible | Header visible (True | False). | headerVisible | Boolean |
| Custom header | Render the page header using the 'Custom header display delegate' (True | False). | customheader | Boolean |
| Custom header display delegate | The name of a procedure/function that will render the page header. | customheaderdisplay | Character |
| Caption | Header caption. | headerCaption | Character |
| Height | Header height. | headerheight | Int |
| Background color | Header background color. | headerBackColor | Character |
| Foreground color | Header foreground color. | headerForeColor | Character |
| Header bottom border | Display Header bottom border (True | False). | headerBottomBorder | Boolean |
| Header bottom border color | Header bottom border color. | headerBorderBottomColor | Character |
| Header image | The image for the Header (png | jpg | gif). Use app:/imagename.ext for app specific images. |
headerImage | Character |
| Gradient colors | Render the Header background color as a gradient (True | False). | headerGradient | Boolean |
| Gradient type | Specify the gradient type. | headerGradientType | Int |
| Gradient start color | Gradient start color. | headerFromColor | Character |
| Gradient end color | Gradient end color. | headerToColor | Character |
| Hide header icon | Hide the header icon in the page Header (True | False). | hideHeaderIcon | Boolean |
| Hide header icon | Hide the header icon in the page Header (True | False). | hideHeaderIcon | Boolean |
| Hide database switcher | Hide the database switcher in the page Header (True | False). From v6.3. | hidedatabaseswitcher | Boolean |
| Minimum search text length | Minimum number of characters to type in the search box before search is made. | searchBoxMinChars | Int |
| Hide notifications icon | Hide the notifications icon in the page Header (True | False). | hideNotificationIcon | Boolean |
| Hide search icon | Hide the custom search icon in the page Header (True | False). | hideCustomSearchIcon | Boolean |
| Show Custom search dialog | Show custom search dialog when custom search icon clicked (True | False) | showcustomsearchdialog | Boolean |
| Show custom search dialog panel | Show custom search dialog panel when custom search icon clicked (True | False) |
showcustomsearchdialogpanel | Boolean |
| Columns | Custom search columns | columns | Character |
| Hide fullscreen icon | Hide the fullscreen icon in the page Header (True | False). | hideFullScreenIcon | Boolean |
| Hide share icon | Hide the share icon in the page Header (True | False). | hideShareIcon | Boolean |
| Hide home icon | Hide the home icon in the page Header (True | False). | hidehomeicon | Boolean |
| Hide print icon | Hide the print icon in the page Header (True | False). | hideprinticon | Boolean |
| Hide hamburger menu | Hide the hamburger menu icon at runtime (True | False). | hidehamburgermenuicon | Boolean |
| Hide navigation history icons | Hide the navigation history buttons in the page header (True | False). | hidenavigationhistorybuttons | Boolean |
| Attribute | Description | Name | Type |
|---|---|---|---|
| Visible | Footer visible (True | False). | footerVisible | Boolean |
| Custom footer display delegate | The name of a procedure/function that will render the page footer. | customfooterdisplay | Character |
| Height | Footer height. | footerHeight | Int |
| Background color | Footer background color. | footerBackColor | Character |
| Foreground color | Footer foreground color. | footerForeColor | Character |
| Footer image | The image for the Footer (png | jpg | gif). Use app:/imagename.ext for app specific images. |
footerImage | Character |
| Gradient colors | Render the Footer background color as a gradient (True | False). | footerGradient | Character |
| Gradient type | Specify the gradient type. | footerGradientType | Int |
| Gradient start color | Gradient start color. | footerFromColor | Character |
| Gradient end color | Gradient end color. | footerToColor | Character |
| Refresh interval | The interval in seconds that the Footer content will be refreshed. | footerCustomGadgetRefreshInterval | Int |
Left Sidebar
| Attribute | Description | Name | Type |
|---|---|---|---|
| Show left sidebar | Show left sidebar (True | False). | leftSidebarVisible | Boolean |
| Collapse left sidebar | Collapse left sidebar when the App is first loaded (True | False). | collapseLeftSidebar | Boolean |
| Width | Left sidebar width. | leftSidebarWidth | Int |
| Show left sidebar logo image | Show left sidebar logo image (True | False). | leftSidebarImageVisible | Boolean |
| Logo image | The logo displayed at the top of the left sidebar (png | jpg | gif). Use app:/imagename.ext for app specific images. |
leftSidebarImage | Character |
| Show login panel | Show the login panel in the left sidebar (True | False). | leftSidebarLoginPanelVisible | Boolean |
| Show Apps | Show the Apps menu in the left sidebar (True | False). | leftSidebarAppsVisible | Boolean |
| Show Apps Caption | Show the Apps caption above the Apps menu (True | False). | leftSidebarAppsHeaderVisible | Boolean |
| Show Menu | Show the page menu in the left sidebar (True | False). | leftSidebarMenuVisible | Boolean |
| Show Recent Items | Show Watches, Favorites, Recently Viewed/Modified items and Instant Selections in the left sidebar (True | False). | leftSidebarItemsVisible | Boolean |
| Background color | Left sidebar background color. | leftSidebarBackColor | Character |
| Foreground color | Left sidebar foreground color. | leftSidebarForeColor | Character |
| Border color | Left sidebar border color. | leftSidebarBorderColor | Character |
| Header colors | A comma-separated list of colors: foreground:background:bottombordercolor From v9.6.4. |
leftSidebarColors | Character |
| Favorite items | The number of Favorites to display. | leftSidebarFavoriteItems | Int |
| Recently viewed items | The number of Recently Viewed items to display. | leftSidebarRecentlyViewedItems | Int |
| Recently modified items | The number of Recently Modified items to display. | leftSidebarRecentlyModifiedItems | Int |
| Watched items | The number of Watched items to display. | leftSidebarWatchedItems | Int |
| Refresh interval | The interval in seconds that the Instant Selections content will be refreshed. | leftSidebarRefreshInterval | Int |
| Attribute | Description | Name | Type |
|---|---|---|---|
| Show navigation panel | Show a Navigation panel on the left side of the page (True | False). By default this is a TreeGrid, so you can load it in the load delegate for the page and structure it as a Grid or a Tree. |
leftSidebarTreeVisible | Boolean |
| Collapsable | Enable collapsing and expanding for the Navigation panel (True | False). | navigationPanelCollapsable | Boolean |
| Collapse when first loaded | Hide Navigation panel when first loaded. Use $("page:yourpagename?action=shownavigationpanel") to show it and $("page:yourpagename?action=hidenavigationpanel") to hide it again. |
navigationPanelCollapseOnload | Boolean |
| Position on page | Navigation panel position on page(Left | Right). | navigationPanelPosition | Character |
| Show caption | Show Navigation panel caption (True | False). | leftSidebarTreeCaptionVisible | Boolean |
| Caption height | Navigation panel caption height. | leftSidebarTreeCaptionHeight | Int |
| Caption | Navigation panel caption. | leftSidebarTreeCaption | Character |
| Width | Navigation panel width. | leftSidebarTreeWidth | Int |
| Custom UI page | Specify an (optional) custom UI Page from the UI Page Library to embed into the Navigation panel. | leftSidebarTreeCustomPage | Character |
| Show child indicators | Show child indicators. | leftSidebarTreeShowChildIndicators | Boolean |
| Alternating row colors | Alternating row colors. | leftSidebarTreeAlternatingColors | Boolean |
| Double click to select | Check this if you want the selection delegate to be called on a double-click rather than a single click. | leftSidebarTreeDoubleClick | Boolean |
| Column headers | Specify a comma separated list of column headers. | leftSidebarTreeColumnHeaders | Character |
| Data source | Specify a comma separated list of items to load as caption#icon, a SQL SELECT statement to load from a data source or specify a .rsp, .jssp or html page. Note that you can optionally load the Navigation panel in the load delegate for the page. |
leftSidebarTreeDataSource | Character |
| Selection column | When using a multi column TreeGrid, specify the column you want to select when calling the selection delegate. | leftSidebarTreeSelectionColumn | Character |
| Item sync expression | Specify an expression to evaluate to keep the TreeGrid in sync while data is navigated in the page. | leftSidebarTreeItemExpr | Character |
| Selection delegate | Specify a delegate to call when a row is clicked. Note that you can use an 'inline' delegate like this: $("section:yoursectionid?action=search&text={}") Notice how {} is used to substitute the value of the item selected. |
navTreeSelectionAction | Character |
| Show ActionBar | Show the actionbar at the bottom of the Navigation panel (True | False). | navTreeActionbarVisible | Boolean |
| Add delegate | Specify a delegate to call when the 'Add' icon is clicked. Note that you can use an 'inline' delegate like this: $("section:yoursectionid?action=add"). |
navTreeAddAction | Character |
| Delete delegate | Specify a delegate to call when the 'Delete' icon is clicked. Note that you can use an 'inline' delegate like this: $("section:yoursectionid?action=delete"). |
navTreeDeleteAction | Character |
| Row height | Row height for the Tree items in the Navigation panel. | leftSidebarTreeRowheight | Int |
| Font size | Font size for the Tree items in the Navigation panel. | leftSidebarTreeFontsize | Int |
| CSS style | CSS style for the Navigation panel and its Tree (separate attributes with ; or use app:/filename.css). | leftSidebarTreeStylesheet | Character |
Right Sidebar
| Attribute | Description | Name | Type |
|---|---|---|---|
| Show right sidebar | Show right sidebar (True | False). | rightSidebarVisible | Boolean |
| Autosize gadgets | Autosize the right sidebar gadgets for the height of the Page (True | False). From v9.6. | rightsidebarautosize | Boolean |
| Collapse right sidebar | Collapse right sidebar when the App is first loaded (True | False). | collapseRightSidebar | Boolean |
| Width | Right sidebar width. | rightSidebarWidth | Int |
| Background color | Right sidebar background color. | rightSidebarBackColor | Character |
| Foreground color | Right sidebar foreground color. | rightSidebarForeColor | Character |
| Border color | Right sidebar border color. | rightSidebarBorderColor | Character |
| Header colors | A comma-separated list of colors: foreground:background:bottombordercolor From v9.6.4. |
rightSidebarColors | Character |
| Custom content gadget | Gadget based on custom script. | ||
| + Show | Show the custom content gadget (True | False). | rightSidebarCustomGadgetVisible | Boolean |
| + Expanded | Expand the custom content gadget when the App is first loaded (True | False). | rightSidebarCustomGadgetExpanded | Boolean |
| + Height | Custom content gadget height. | rightSidebarCustomGadgetHeight | Int |
| + Stretch | Stretch the custom content into the right sidebar (True | False). | rightSidebarCustomGadgetStretch | Boolean |
| + Caption | Custom content gadget caption. | rightSidebarCustomGadgetCaption | Character |
| + Gadget | The gadget to be displayed. | rightSidebarCustomGadget | Character |
| + Refresh interval | The interval in seconds that the content will be refreshed. | rightSidebarCustomGadgetRefreshInterval | Int |
| Content gadget #1 | Gadget based on URL. | ||
| + Show | Show the gadget (True | False). | rightSidebarContentVisible1 | Boolean |
| + Expanded | Expand the gadget when the App is first loaded (True | False). | rightSidebarContentExpanded1 | Boolean |
| + Height | Gadget height. | rightSidebarContentHeight1 | Int |
| + Caption | Gadget caption. | rightSidebarContentCaption1 | Character |
| + URL | The URL of the content to be displayed. | rightSidebarContentUrl1 | Character |
| + Refresh interval | The interval in seconds that the content will be refreshed. | rightSidebarcontentInterval1 | Int |
| Content gadget #2 | Gadget based on URL. | ||
| + Show | Show the gadget (True | False). | rightSidebarContentVisible2 | Boolean |
| + Expanded | Expand the gadget when the App is first loaded (True | False). | rightSidebarContentExpanded2 | Boolean |
| + Height | Gadget height. | rightSidebarContentHeight2 | Int |
| + Caption | Gadget caption. | rightSidebarContentCaption2 | Character |
| + URL | The URL of the content to be displayed. | rightSidebarContentUrl2 | Character |
| + Refresh interval | The interval in seconds that the content will be refreshed. | rightSidebarcontentInterval2 | Int |
| Content gadget #3 | Gadget based on URL. | ||
| + Show | Show the gadget (True | False). | rightSidebarContentVisible3 | Boolean |
| + Expanded | Expand the gadget when the App is first loaded (True | False). | rightSidebarContentExpanded3 | Boolean |
| + Height | Gadget height. | rightSidebarContentHeight3 | Int |
| + Caption | Gadget caption. | rightSidebarContentCaption3 | Character |
| + URL | The URL of the content to be displayed. | rightSidebarContentUrl3 | Character |
| + Refresh interval | The interval in seconds that the content will be refreshed. | rightSidebarcontentInterval3 | Int |
| Content gadget #4 | Gadget based on URL. | ||
| + Show | Show the gadget (True | False). | rightSidebarContentVisible4 | Boolean |
| + Expanded | Expand the gadget when the App is first loaded (True | False). | rightSidebarContentExpanded4 | Boolean |
| + Height | Gadget height. | rightSidebarContentHeight4 | Int |
| + Caption | Gadget caption. | rightSidebarContentCaption4 | Character |
| + URL | The URL of the content to be displayed. | rightSidebarContentUrl4 | Character |
| + Refresh interval | The interval in seconds that the content will be refreshed. | rightSidebarcontentInterval4 | Int |
Custom Delegates
| Attribute | Description | Name | Type |
|---|---|---|---|
| Scripting language | The default scripting language for custom code in this page (Inherit | Recital | Visual FoxPro | Python | JavaScript | PHP). | scriptingLanguage | Character |
| Custom library | The filename of the library containing code for event handlers and custom procedures/functions. | customLibrary | Character |
| The delegate for the Print event. This is called when you click the 'Print' icon. | printAction | Character | |
| Hotkey | The delegate for the Hotkey event. | hotkeyAction | Character |
| Enabled When | The delegate for the EnabledWhen event. | enabledWhenAction | Character |
| Visible When | The delegate for the VisibleWhen event. | visibleWhenAction | Character |
| Valid When | The delegate for the ValidWhen event. | validWhenAction | Character |
| Activate | The delegate for the Activate event. | activateAction | Character |
| Deactivate | The delegate for the Deactivate event. | deactivateAction | Character |
| Init | The delegate for the Init event. | initAction | Character |
| Destroy | The delegate for the Destroy event. | destroyAction | Character |
| Load | The delegate for the Load event. | loadAction | Character |
| Ready | The delegate for the Ready event. | readyAction | Character |
| Unload | The delegate for the Unload event. | unloadAction | Character |
| Change | The delegate for the Change event. | changedAction | Character |
| Statechanged | The delegate for the Statechanged event. | stateChangedAction | Character |
| Before Refresh action | The delegate for the BeforeRefresh event. From v6.2. | beforeRefreshAction | Character |
| After Refresh action | The delegate for the AfterRefresh event. | afterRefreshAction | Character |
| Timer | The delegate for the Timer event. | timerAction | Character |
| Timer interval | The timer interval in seconds that the Timer event will be called at runtime. | timerInterval | Int |
| Custom options menu | The delegate for the Custom menu event. | customMenuAction | Character |
| Custom settings menu | The delegate for the Custom settings menu event. The text of the menuitem selected is passed as a parameter. | customSettingsAction | Character |
| Custom search | The delegate for the Search event. | customSearch | Character |
| Instant search | The delegate for the Instant Search event. The text typed in the searchbox is passed as a parameter. | searchAction | Character |
| Instant selection | The delegate for the Instant Selection event. The filter condition is passed as a parameter. From v5.5.1. | selectionAction | Character |
| 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. | dialogButtonAction | Character |
Gestures
| Attribute | Description | Name | Type |
|---|---|---|---|
| Swipe navigation | Enable swipe left and swipe right to navigate between Pages (True | False). | swipeNavigation | Boolean |
| 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'. |
gesturesEnabled | Boolean |
| Swipe left gesture | The delegate for the gestureSwipeLeft event. | gestureSwipeLeftAction | Character |
| Swipe right gesture | The delegate for the gestureSwipeRight event. | gestureSwipeRightAction | Character |
| Swipe up gesture | The delegate for the gestureSwipeUp event. | gestureSwipeUpAction | Character |
| Swipe down gesture | The delegate for the gestureSwipeDown event. | gestureSwipeDownAction | Character |
| Pan gesture | The delegate for the gesturePan event. | gesturePanAction | Character |
| Pinch gesture | The delegate for the gesturePinch event. | gesturePinchAction | Character |
| Tap gesture | The delegate for the gestureTap event. | gestureTapAction | Character |
| Tap and hold gesture | The delegate for the gestureTapAndHold event. | gestureTapAndHoldAction | Character |
| Gestures | The catch all delegate for the gestures event. | gesturesAction | Character |
Custom Actions
| Attribute | Description | Name | Type |
|---|---|---|---|
| Add action | The custom action function for Add. This will be called to add a record. |
addAction | Character |
| Delete action | The custom action function for Delete. This will be called to delete a record. |
deleteAction | Character |
| Refresh action | The custom action function for Refresh. This will be called to refresh the current record. |
refreshAction | Character |
| First action | The custom action function for First. This will be called to read the first record. |
firstAction | Character |
| Previous action | The custom action function for Previous. This will be called to read the previous record. |
previousAction | Character |
| Next action | The custom action function for Next. This will be called to read the next record. |
nextAction | Character |
| Last action | The custom action function for Last. This will be called to read the last record. |
lastAction | Character |
| Edit action | The custom action function for Edit. This will be called to edit the current record. |
editAction | Character |
| Save action | The custom action function for Save. This will be called to save changes. |
saveAction | Character |
| Cancel action | The custom action function for Cancel. This will be called to cancel changes. |
cancelAction | Character |
Permissions and Roles
| Attribute | Description | Name | Type |
|---|---|---|---|
| Create roles | A comma separated list of roles that can perform create operations on data in the page. | permcreate | Character |
| Read roles | A comma separated list of roles that can read (and view) the page. | permRead | Character |
| Update roles | A comma separated list of roles that can perform update operations on data in the page. | permUpdate | Character |
| Delete roles | A comma separated list of roles that can perform delete operations on data in the page. | permDelete | Character |
UI Presentation Rules
| Attribute | Description | Name | Type |
|---|---|---|---|
| Desktop | Include this page in a Desktop client (True | False). | desktopUI | Boolean |
| Web | Include this page in a Web client (True | False). | webUI | Boolean |
| Tablet | Include this page in a Tablet client (True | False). | tabletUI | Boolean |
| Phone | Include this page in a Phone client (True | False). | mobileUI | Boolean |
| Use mobile navigation bar | Use a mobile styled navigation bar (material UI style) (True | False). | mobilenavbar | Boolean |
| UI States | UI states that affect this page. Specify multiple states as a comma separated list. | state | Character |
| Initial UI state | The initial UI state for this page. This will be applied to the page and all its sections and fields. | 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 |
| Page transition effect | The page transition effect when navigating between pages on Web/Tablet/Phone. (None | Fade | Pop | Flip | Turn | Flow | SlideFade | Slide | SlideUp | SlideDown). | pageTransition | 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 |
| Navigation Panel Responsive UI width breakpoint | The Navigation Panel responsive UI width breakpoint in Web/Mobile Apps. From v5.4. | navpanelresponsivewidth | Int |
Page Center Tile
| Attribute | Description | Name | Type |
|---|---|---|---|
| Category | The category in which the Tile should be displayed in the Page Center. | tileCategory | Character |
| Tile caption | The caption for the Tile in the Page Center. | tileCaption | Character |
| Tile icon | The icon for the Tile in the Page Center. | tileIcon | Character |
| Tile size | The size of the Tile in the Page Center. | tileSize | Character |
| Tile order | The order of the Tile in the Page Center (from v4.0). | tileOrder | Int |
| Background color | The background color for the Tile displayed in the Page Center. | tileBackColor | Character |
| Foreground color | The foreground color for the Tile displayed in the Page Center. | tileForeColor | Character |
