Grid Section Attributes

From Lianjapedia
Revision as of 09:54, 1 December 2014 by Yvonne.milne (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Under construction

Details

Attribute Description More Desktop Web Tablet Phone
Name The name for this section (unique to the page)
Type The type of section: grid (readonly)
Caption The section caption displayed in the section header
Database The database for this section
Table The table for this section
SQL statement The SQL statement used to populate a Virtual Table. Use {} macros in the WHERE condition to relate parent-->child sections and ORDER BY to order the display of records. This is native SQL for the target SQL database and may call stored procedures as well as SQL Select.
Timelines enabled Enable database timelines for this section
Filter The filter expression that restricts the records that will be included in the data
Where condition The dynamic WHERE condition for a Virtual Table that restricts which records will be retrieved
Height The section height
Fixed height Fix the section height (True|False)
Readonly Section is readonly (True|False)
Sortable Section is sortable by clicking on the column headers (True|False)
Double click to edit Double click grid rows to edit data (True|False)

Appearance

Attribute Description More Desktop Web Tablet Phone
Background color Section background color
Foreground color Section foreground color
Grid background color Grid background color
Grid foreground color Grid foreground color
CSS style CSS style (separate attributes with ; or use app:/filename.css)
Gradient colors Render the background color as a gradient (True|False)
Gradient type Specify the gradient type:
0=none
1=Vertical spread
2=Left to right
3=Right to left
4=Vertical centered
5=iPad style
Gradient start color Gradient start color
Gradient end color Gradient end color
Transparency Specify a transparency percentage from 0 to 100
Background image The background image for the section (png|jpg|gif).
Use app:/imagename.ext for app specific images.
Stretch image Stretch the background image to fill the section (True|False)
Margin Margin size around the section
Add spacer at bottom Add spacer at bottom of section (True|False)
Show actionbar Show the actionbar (True|False)
Show grid lines Show grid lines (True|False)
Alternating row colors Display alternating row colors (True|False)
Grid row height Height of the grid rows
Autoresize columns Autoresize grid columns to fit data (True|False)
Stretch last column Stretch last grid column (True|False)
Split grid Split the grid into a grid and a form (True|False)
Show split edit Display grid in split/form edit mode when displayed (True|False)
Show memo/object panel Show memo/object panel in splitbar mode (True|False)
Scrollbar Section displays the grid vertical scrollbar (True|False)
Show logicals as CheckBoxes Display logical/Boolean values as CheckBoxes (True|False)
Pagination Grid is always rendered using pagination (for large data sets)(True|False)
Automatic pagination Grid is rendered using pagination if the number of records exceeds below amount (True|False)
Automatic pagination size Grid is rendered using pagination if Automatic pagination is true and the number of records exceeds this amount

Header

Attribute Description More Desktop Web Tablet Phone
Hide header Hide section header at runtime (True|False)
Hide actionbar Hide actionbar buttons in the section header (True|False)
Hide navigation buttons Hide navigation buttons (True|False)
Hide editing buttons Hide editing buttons (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:
0=none
1=Vertical spread
2=Left to right
3=Right to left
4=Vertical centered
5=iPad style
Gradient start color Gradient start color
Gradient end color Gradient end color
Show OK/Cancel buttons Show OK/Cancel buttons in the section header (True|False)
Show Add/Delete buttons Show Add/Delete buttons in the section header (True|False)
Show Print button Show Print button in the section header (True|False)
Hide custom search icon Hide the custom search icon (True|False)
Show info tips icon Show the info tips icon in the section header (True|False)
Show help icon Show the help icon in the section header (True|False)
Help topic Help topic to display when the help icon is clicked in the section header

Related Data

Attribute Description More Desktop Web Tablet Phone
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
Cascade deletes When a record is deleted, cascade deletes and deleted any related child records (True|False).

Menu

Attribute Description More Desktop Web Tablet Phone
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 (comma separated list of values). Prefix with |, < or > to align center, left or right respectively.
Custom action Action to perform when a menuitem is selected See SHOWDOCUMENT()

Search Panel

Attribute Description More Desktop Web Tablet Phone
Visible Section search panel visible (True|False)
Width Section search panel width
Height Section search panel height
Background color Section search panel background color
Foreground color Section search panel foreground color
Autocreate Automatically create custom search panel for all search columns in this section (True|False).
Custom search panel The delegate used to create the custom search panel.

Subtitle

Attribute Description More Desktop Web Tablet Phone
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 (separate attributes with ; or use app:/filename.css)

Summary

Attribute Description More Desktop Web Tablet Phone
Visible Section summary visible (True|False)
Caption Section summary caption
Background color Section summary background color
Foreground color Section summary foreground color

Footer

Attribute Description More Desktop Web Tablet Phone
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 (comma separated list of values). If this list starts with #, then the menuitems are displayed as centred buttons. Prefix with #< or #> to display the buttons aligned left or right respectively.
Custom action Action to perform when a footer menuitem is selected See SHOWDOCUMENT()

Other Options

Attribute Description More Desktop Web Tablet Phone
Hide form NavBar Hide form Navigation Bar at runtime if this section is in an AccordionStack (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 More Desktop Web Tablet Phone
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 Changed event (after data is read)
Before Data Update The delegate for the BeforeUpdate event
After Data Update The delegate for the AfterUpdate event
Before Data Delete The delegate for the BeforeDelete event
After Data Delete The delegate for the AfterDelete event
Refresh The delegate for the Refresh event
Parent data changed The delegate for the ParentDataChanged event
Dialog button delegate The delegate for the DialogButtonClicked event. If a dialogbutton on a Field has no delegate, the Section delegate will be called. If the section has no delegate, then the Page delegate will be called.
Double click The delegate for the row DoubleClicked 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

Gestures

Attribute Description More Desktop Web Tablet Phone
Gestures enabled Enable gestures for this section: swipe, pan, pinch, tap and tapandhold (True|False).
If enabled, then the Gestures delegate will be called with two arguments, e.g. 'swipe','left' or 'swipe','right'
Swipe left gesture The Swipe Left gesture delegate
Swipe right gesture The Swipe Right gesture delegate
Swipe up gesture The Swipe Up gesture delegate
Swipe down gesture The Swipe Down gesture delegate
Pan gesture The Pan gesture delegate
Pinch gesture The Pinch gesture delegate
Tap gesture The Tap gesture delegate
Tap and hold gesture The Tap and Hold gesture delegate
Gestures The catch all delegate for the Gestures event

Permissions and Roles

Attribute Description More Desktop Web Tablet Phone
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 More Desktop Web Tablet Phone
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 columns.
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 section 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)