Custom Section Attributes

From Lianjapedia
Revision as of 06:22, 20 May 2016 by Yvonne.milne (Talk | contribs)

Jump to: navigation, search

Under construction

See Also

Developing Lianja Custom Sections in JavaScript, Developing Lianja Custom Sections in PHP, Developing Lianja Custom Sections in Python, Developing Lianja Custom Sections in Visual FoxPro,

Details

Attribute Description
Name The name for this section (unique to the page)
Meta types A comma separated list of metatype names
Type The type of section: custom (readonly)
Caption The section caption displayed in the section header

Appearance

Attribute Description
Height The section height
Fixed height Fix the section height (True | False)
Transparency Specify a transparency percentage from 0 to 100
Margin Margin size around the section
Add spacer at bottom Add spacer at bottom of section (True | False)

Header

Attribute Description
Hide header Hide section header at runtime(True | False)
Hide actionbar Hide actionbar buttons in the section header (True | False)
Hide navigation buttons Hide actionbar navigation 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

Custom scripting code

Attribute Description
Scripting language The scripting language used to write the code for this custom section: (Recital | Python | JavaScript | PHP (readonly)
Custom filename The file containing the custom code for this section
Custom UI library The library containing the custom UI class for this section (.scp or .vcp file)
Custom UI class The name of the custom UI class in the custom UI library for this section

Custom BROWSE or EDIT command

Attribute Description
Database The database for this section
Table The table for this section
Timelines enabled Enable database timelines for this section
Command A custom BROWSE or EDIT command to be executed in this section, e.g. BROWSE NOEDIT FIELDS name,account,amount=items*itemcount:h"Total

Related Data

Attribute Description
Parent section name Name of related parent section
Automatically relate Automatically relate the child section (True | False). If this is unchecked then you need to manually relate it in the parentdatachanged delegate.
Parent key Parent key
Child key Child key

Menu

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

Search Panel

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

Subtitle

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

Footer

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

Other Options

Attribute Description
Hide form NavBar Hide form Navigation Bar at runtime if this section is in an Accordion Stack (True | False)
Collapsable The section is collapsible at runtime (True | False)
Exclude from accordion The section is excluded from accordion behavior at runtime (True | False)
Double-click action Page to activate on double click of a grid row
Hide search icon Hide the search icon at runtime (True | False)

Custom Delegates

Attribute Description
Scripting language The default scripting language for custom code in this section (Inherit | Recital | Visual FoxPro | Python | JavaScript | PHP)
Custom library The filename of the library containing code for event handlers and custom procedures/functions
Expanded The delegate for the Expanded event
Collapsed The delegate for the Collapsed event
Enabled When The delegate for the EnabledWhen event
Visible When The delegate for the VisibleWhen event
Valid When The delegate for the ValidWhen event
Activate The delegate for the Activate event
Deactivate The delegate for the Deactivate event
Init The delegate for the Init event
Destroy The delegate for the Destroy event
Load The delegate for the Load event
Ready The delegate for the Ready event
Unload The delegate for the Unload event
Change The delegate for the Change event
Link Click The delegate for the Hyperlink/Button Click event. This is called with two arguments: functionname(controlsource,text)
Before Data Create The delegate for the BeforeCreated event
After Data Create The delegate for the AfterCreated event
After Data Changed The delegate for the dataChanged event (after data is read)
Before Data Update The delegate for the BeforeUpdate event
After Data Update The delegate for the AfterUpdate event
Before Data Delete The delegate for the BeforeDelete event
After Data Delete The delegate for the AfterDelete event
Refresh The delegate for the Refresh event
Parent data changed The delegate for the ParentDataChanged event
Dialog button delegate The delegate for the DialogButtonClicked event. If a dialogbutton on a Field has no delegate, the Section delegate will be called. If the section has no delegate, then the Page delegate will be called.
Click The delegate for the row Clicked event
Double click The delegate for the dblClick event
Sort The delegate for the column Sort event fired when the header is clicked. This is called with two arguments: nColumn, nDirection
Timer The delegate for the Timer event
Timer interval The timer interval in seconds that the Timer event will be called at runtime
Custom footer menu The delegate for the footer menu event
Custom search command The delegate for the search event
Custom section menu The delegate for the section menu event

Permissions and Roles

Attribute Description
Create roles A comma separated list of roles that can perform create operations on data in the section
Read roles A comma separated list of roles that can read (and view) the section
Update roles A comma separated list of roles that can perform update operations on data in the section
Delete roles A comma separated list of roles that can perform delete operations on data in the section

UI Presentation Rules

Attribute Description
Desktop Include this section in a Desktop client (True | False).
Web Include this section in a Web client (True | False).
Tablet Include this section in a Tablet client (True | False).
Phone Include this section in a Phone client (True | False).
UI States UI states that affect this section. Specify multiple states as a comma separated list.
Initial UI state The initial UI state for this section. This will be applied to the section and all its fields and gadgets.
Readonly when Section is readonly at runtime if specified expression evaluates to true.
Visible when Section is visible at runtime if specified expression evaluates to true.
Display orientation Display depending on mobile device orientation for Tablets and Phones. (Always | Portrait | Landscape)
Apply rules on change Apply UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False).
Apply rules on parent change Apply section UI presentation rules (Visible when and Readonly when) when parent data is changed by navigating records (True | False)
Retrieved from "https://www.lianja.com/doc/index.php?title=Custom_Section_Attributes&oldid=13323"