Difference between revisions of "Calendar Section Attributes"

Revision as of 09:12, 5 July 2016

Getting and Setting Attributes

The setAttribute(name, value) method can be used to set the value of an Attribute:

Lianja.get("pageid.sectionid").setAttribute("title","Section1")

Note: the shortened form setAttr(name,value) is also available.

The getAttribute(name) method can be used to get the value of an Attribute:

cTitle = Lianja.get("pageid.sectionid").getAttribute("title")

Note: the shortened form getAttr(name) is also available.

Details

Attribute	Description	Name	Type
Name	The name for this section (unique to the page)
Meta types	A comma separated list of metatype names
Type	The type of section: calendar (readonly)
Caption	The section caption displayed in the section header
Database	The database for this section
Table	The table for this section
Height	The section height
Fixed height	Fix the section height (True \| False)
Auto layout percent	Auto layout percentage of page size. If set to 0, then all sections on a page are resized to an equal height
Readonly	Section is readonly (True \| False)

Appearance

Attribute	Description	Name	Type
Margin	Margin size around the section
Add spacer at bottom	Add spacer at bottom of section (True \| False)

Header

Attribute	Description	Name	Type
Hide header	Hide section header at runtime(True \| False)
Hide actionbar	Hide actionbar buttons in the section header (True \| False)
Header CSS style	CSS style (separate attributes with ; or use app:/filename.css)
Header icon	The image for the Header (png \| jpg \| gif). Use app:/imagename.ext for app specific images.
Gradient colors	Render the Header background color as a gradient (True \| False)
Gradient type	Specify the gradient type
Gradient start color	Gradient start color
Gradient end color	Gradient end color
Show OK/Cancel buttons	Show OK/Cancel buttons in the section header (True \| False)
Show Add/Delete buttons	Show Add/Delete buttons in the section header (True \| False)
Show Print button	Show Print button in the section header (True \| False)
Hide custom search icon	Hide the custom search icon (True \| False)
Show info tips icon	Show the info tips icon in the section header (True \| False)
Show help icon	Show the help icon in the section header (True \| False)
Help topic	Help topic to display when the help icon is clicked in the section header

Calendar Options

Attribute	Description	Name	Type
Default view	The default view to be displayed (Month \| Week \| Day)
Event type column	The (character) event type column from the table for the events in the calendar.
Event type choices	The event type choices for the events in the calendar. This can be a comma separated list or a SQL statement.
Event title column	The (character) event title column from the table.
Event start column	The (datetime) event start column from the table.
Event end column	The (datetime) event end column from the table.
Event repeat column	The (int) event repeating flag column from the table.
Event allday column	The (logical) event allday flag column from the table.
Event key column	The key expression for events in the calendar.
Event type value	The event type for this calendar, e.g. meeting, vacation, appointment. Calendar contents will be filtered on this.
Autosize	Autosize the calendar into the viewport (True \| False)
Other options	Other calendar options
Click delegate	Delegate to call when a calendar event is clicked
Dynamic day backcolor	Delegate to return the background colors and dates. You should return this as a comma separated list. The delegate is called with one parameter: 'dates' or 'colors'. The currently selected cursor contains the selected records.
Dynamic event backcolor	Delegate to return the background color of the event for the specified event type, which is passed as a parameter.
Dynamic event forecolor	Delegate to return the foreground color of the event for the specified event type, which is passed as a parameter.
Custom delegate library	Custom library containing the day and event dynamic color delegates.
Filter	The filter expression that restricts which events will be included in the calendar.

Related Data

Attribute	Description	Name	Type
Parent section name	Name of related parent section
Automatically relate	Automatically relate the child section (True \| False)
Parent key	Parent key
Child key	Child key

Search Panel

Attribute	Description	Name	Type
Visible	Section search panel visible (True \| False)
Height	Section search panel height
Background color	Section search panel background color
Foreground color	Section search panel foreground color
Auto create	Automatically create search panel for all Section search fields
Custom search panel	The delegate used to create the custom search panel

Subtitle

Attribute	Description	Name	Type
Visible	Section subtitle visible (True \| False)
Caption	Section subtitle caption
Height	Section subtitle height
Background color	Section subtitle background color
Foreground color	Section subtitle foreground color
Font	Section subtitle font
CSS style	CSS style

Footer

Attribute	Description	Name	Type
Visible	Section footer visible (True \| False)
Caption	Section footer caption
Height	Section footer height
Background color	Section footer background color
Foreground color	Section footer foreground color
Custom menu	Section footer menu contents
Custom action	Action to perform when a footer menu item is selected
Footer button CSS	Footer button CSS style
Footer button width	Footer button width

Other Options

Attribute	Description	Name	Type
Hide form NavBar	Hide form Navigation Bar at runtime if this section is in an Accordion Stack (True \| False)
Collapsable	The section is collapsible at runtime (True \| False)
Exclude from accordion	The section is excluded from accordion behavior at runtime (True \| False)

Custom Delegates

Attribute	Description	Name	Type
Scripting language	The default scripting language for custom code in this section (Inherit \| Recital \| Visual FoxPro \| Python \| JavaScript \| PHP)
Custom library	The filename of the library containing code for event handlers and custom procedures/functions
Expanded	The delegate for the Expanded event
Collapsed	The delegate for the Collapsed event
Parent data changed	The delegate for the ParentDataChanged event
Timer	The delegate for the Timer event
Timer interval	The timer interval in seconds that the Timer event will be called at runtime
Custom footer menu	The delegate for the footer menu event
Custom search command	The delegate for the search event
Custom section menu	The delegate for the section menu event

Permissions and Roles

Attribute	Description	Name	Type
Create roles	A comma separated list of roles that can perform create operations on data in the section.	permcreate	Character
Read roles	A comma separated list of roles that can read (and view) the section.	permRead	Character
Update roles	A comma separated list of roles that can perform update operations on data in the section.	permUpdate	Character
Delete roles	A comma separated list of roles that can perform delete operations on data in the section.	permDelete	Character

UI Presentation Rules

Attribute	Description	Name	Type
Desktop	Include this section in a Desktop client (True \| False).	desktopUI	Boolean
Web	Include this section in a Web client (True \| False).	webUI	Boolean
Tablet	Include this section in a Tablet client (True \| False).	tabletUI	Boolean
Phone	Include this section in a Phone client (True \| False).	mobileUI	Boolean
UI States	UI states that affect this section. Specify multiple states as a comma separated list.	state	Character
Initial UI state	The initial UI state for this section. This will be applied to the section and all its fields and gadgets.	uiStateInit	Character
Readonly when	Section is readonly at runtime if specified expression evaluates to true.	readonlyWhen	Character
Visible when	Section is visible at runtime if specified expression evaluates to true.	visibleWhen	Character
Display orientation	Display depending on mobile device orientation for Tablets and Phones. (Always \| Portrait \| Landscape)	displayOrientation	Character
Apply rules on change	Apply UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True \| False).	applyRulesOnChange	Boolean
Apply rules on parent change	Apply section UI presentation rules (Visible when and Readonly when) when parent data is changed by navigating records (True \| False)	applyRulesOnParentChange	Boolean

@@ Line 302: / Line 302: @@
 |-
 |valign="top"|[[Users and Roles|Create roles]]||A comma separated list of roles that can perform create operations on data in the section.
-|valign="top"|permcreate||Character
+|valign="top"|permcreate||valign="top"|Character
 |-
 |valign="top"|[[Users and Roles|Read roles]]||A comma separated list of roles that can read (and view) the section.
-|valign="top"|permRead||Character
+|valign="top"|permRead||valign="top"|Character
 |-
 |valign="top"|[[Users and Roles|Update roles]]||A comma separated list of roles that can perform update operations on data in the section.
-|valign="top"|permUpdate||Character
+|valign="top"|permUpdate||valign="top"|Character
 |-
 |valign="top"|[[Users and Roles|Delete roles]]||A comma separated list of roles that can perform delete operations on data in the section.
-|valign="top"|permDelete||Character
+|valign="top"|permDelete||valign="top"|Character
 |-
 |}
@@ Line 322: / Line 322: @@
 !width="10%"|Type
 |-
 |valign="top"|[[UI Presentation Rules#Desktop|Desktop]]||Include this section in a Desktop client (True &#124; False).
+|valign="top"|desktopUI||valign="top"|Boolean
 |-
 |valign="top"|[[UI Presentation Rules#Web|Web]]||Include this section in a Web client (True &#124; False).
+|valign="top"|webUI||valign="top"|Boolean
 |-
 |valign="top"|[[UI Presentation Rules#Tablet|Tablet]]||Include this section in a Tablet client (True &#124; False).
+|valign="top"|tabletUI||valign="top"|Boolean
 |-
 |valign="top"|[[UI Presentation Rules#Phone|Phone]]||Include this section in a Phone client (True &#124; False).
+|valign="top"|mobileUI||valign="top"|Boolean
 |-
 |valign="top"|[[UI Presentation Rules#UI States|UI States]]||UI states that affect this section.  Specify multiple states as a comma separated list.
+|valign="top"|state||valign="top"|Character
 |-
 |valign="top"|[[UI Presentation Rules#Initial UI state|Initial UI state]]||The initial UI state for this section.  This will be applied to the section and all its fields and gadgets.
+|valign="top"|uiStateInit||valign="top"|Character
 |-
 |valign="top"|[[UI Presentation Rules#Readonly when|Readonly when]]||Section is readonly at runtime if specified expression evaluates to true.
+|valign="top"|readonlyWhen||valign="top"|Character
 |-
 |valign="top"|[[UI Presentation Rules#Visible when|Visible when]]||Section is visible at runtime if specified expression evaluates to true.
+|valign="top"|visibleWhen||valign="top"|Character
 |-
 |valign="top"|[[UI Presentation Rules#Display orientation|Display orientation]]||Display depending on mobile device orientation for Tablets and Phones. (Always &#124; Portrait &#124; Landscape)
+|valign="top"|displayOrientation||valign="top"|Character
 |-
 |valign="top"|[[UI Presentation Rules#Apply rules on change|Apply rules on change]]||Apply UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True &#124; False).
+|valign="top"|applyRulesOnChange||valign="top"|Boolean
 |-
 |valign="top"|[[UI Presentation Rules#Apply rules on parent change|Apply rules on parent change]]||Apply section UI presentation rules (Visible when and Readonly when) when parent data is changed by navigating records (True &#124; False)
+|valign="top"|applyRulesOnParentChange||valign="top"|Boolean
 |-
 |}
 [[Category:Attributes|3 Calendar Section]]

Attribute	Description	Name	Type
Visible	Section menu visible (True \| False)
Height	Section menu height
Background color	Section menu background color
Foreground color	Section menu foreground color
Custom menu	Section menu contents
Custom action	Action to perform when a menu item is selected