Data Attributes

From Lianjapedia
Jump to: navigation, search

Under Construction

Contents

See Also

Autosuggestions, Choices, Colors, Data Mapping, Fonts, Formitem Appearance, Help Attributes, Input Masks, Instant Search

ActiveX control

ActiveX component control to embed.

ActiveX control


The ActiveX control attribute can be set (as shown above) to the registered component's UUID, e.g.

{8E27C92B-1264-101C-8A2F-040224009C02}

or its class name:

MSCal.Calendar

or its full name:

Calendar Control 12.0

Notes on Client Support

Anchor

The anchor value for the control. Add values together for multiple anchors.

Anchor Value
None 0
Top left 1
Top absolute 2
Bottom absolute 4
Right absolute 8
Top relative 16
Left relative 32
Bottom relative 64
Right relative 128
Horizontal fixed size 256
Vertical fixed size 512
Autowidth 1024
Autoheight 2048
Autosize 4096
Autostretch 8192

Notes on Client Support

Allow multiple selections

Allow multiple selections (True | False)

Allow multiple selections: True



By default, when a Checklistview Gadget is added, the Allow multiple selections attribute is checked (True).

The checklist is displayed as a series of checkboxes.


Allow multiple selections: False



When the Allow multiple selections attribute is unchecked (False), the checklist is displayed as a series of radio buttons.


Notes on Client Support

Alternating row colors

Alternate row colors (True | False)

Alternating row colors: True



By default, when a Treeview Gadget is added, the Alternate row colors attribute is checked (True).

The Treeview is displayed with alternating 'Alice blue' rows.

Unchecking the Alternate row colors attribute causes all rows to be displayed in the Background color.


Notes on Client Support

Automatic pagination

Grid is rendered using pagination if the number of records exceeds below amount (True | False).

Automatic pagination: True



By default, when a Grid Gadget is added, the Automatic pagination attribute is checked (True).

If the number of records exceeds the Automatic pagination size, the grid rows are displayed in pages.

Unchecking the Automatic pagination attribute disables automatic pagination.


Notes on Client Support

Automatic pagination size

Grid is rendered using pagination if Automatic pagination is true and the number of records exceeds this amount.

Notes on Client Support

Autosuggestions

Autosuggest a list of values as the user types.

Autosuggestions


Notes on Client Support

Autosuggestion headers

A comma separated list of column headers to display for the Autosuggestions.

Notes on Client Support

Autosuggestion column to search

The column to search for Autosuggestions.

Notes on Client Support

Background color

The background color for the data.

Notes on Client Support

Caption

The caption for the control.

Choices

A list of choices.

Choices


Notes on Client Support

Column alignments

A comma separated list of column alignments, e.g.left,right,center.

Notes on Client Support

Column icons

A comma separated list of column icons.

Column icons


Here the Column icons attribute of the Treeview Gadget specifies the filenames for the icons to be displayed at the start of the first two columns.


:/images/forms,:/images/cat_contacts_sm

Notes on Client Support

Column widths

A comma separated list of column widths.

Notes on Client Support

Columns to group by

The number of columns to group by to form the tree hierarchy. When grouping data, use a SQL SELECT ORDER BY clause.

Columns to group by: 2


Here the Columns to group by is set to 2, so the tree items are grouped by customerid and shipname; the first 2 columns in the Tree items attribute SQL Select statement.


Columns to group by: 3


Here the Columns to group by is set to 3, so the tree items are grouped by customerid, shipname and orderid; the first 3 columns in the Tree items attribute SQL Select statement.


The Tree items attribute SQL Select statement is set to:

select customerid,shipname,orderid,orderdate,shippeddate from orders order by customerid

Notes on Client Support

Context Menu

Notes on Client Support

Control CSS style

Control CSS style (separate attributes with ';' or use app:/filename.css or specify CSS classes separated by spaces).

  • From v4.1
  • See CSS

Custom attributes

Notes on Client Support

Custom UI component

Specify a custom UI component from the UI Page Library to embed into this gadget.

Notes on Client Support

Data CSS style

Data CSS style (separate attributes with ';' or use app:/filename.css or specify CSS classes separated by spaces).

  • From v4.1
  • See CSS

Data size

Notes on Client Support

Data source

The field or memory variable the control is bound to.

For a field, this should be in the format tablename.fieldname:

customers.customerid

For memory variables, use the 'm.' prefix:

m.cMemvar1

Notes on Client Support

Default

Default value as an expression, e.g. date(), 0.0, space(10).

Default



The Default attribute specifies the default value for the field when a new record is added or the initial value of a memory variable data source.

Here the orders.orderdate is populated with the system date when a new record is added.

The shipping details have also been populated with data from the parent customers table, e.g. 'Ship Name' has a Default of customers.companyname.

And the Default has also been set on the orders.orderid field using the SEQNO() function to generate a unique sequential number.


Note: the orders.customerid field automatically inherits the current customers.customerid value due to the Relationship Builder relation set between the customers Form Section and the orders Grid Section (key: customerid).


Notes on Client Support

Data Dictionary: Default

The Default attribute corresponds to the Default Column Constraint stored in the table's Data Dictionary.

Modify a Column: Default


The Default Column Constraint can be set in the Create a Column and Modify a Column dialogs in the Data Workspace and Page Builder.


It can also be specified in the CREATE TABLE and ALTER TABLE commands.

// Mandatory
ALTER TABLE "orders" MODIFY CONSTRAINT ORDERDATE SET DEFAULT date()

Default search field

Notes on Client Support

Deferred add

When adding new records, do not commit a blank record until saved. (True | False)

  • Uncheck this (False) if you want to use custom autosuggestions against data in the same table. Default is True.

Notes on Client Support

Dialog button

Notes on Client Support

Dialog button delegate

Notes on Client Support

Editable

Notes on Client Support

Enable when editing

Disable editing until in 'Edit' mode (True | False)

Notes on Client Support

Error message

Notes on Client Support

Expand all

Expand all Tree items when first loaded (True | False).

Expand all: Expand depth = 1


The Expand all attribute is unchecked (False) by default.

Here the 'Expand all attribute has been checked (True), so the nodes are expanded when first loaded up to the depth specified in the Expand depth attribute, here 1.


Expand all: Expand depth = 2


Here the Expand depth attribute has been set to 2.

Note: if the Expand depth attribute is left at its default value 0, all nodes are expanded when the Treeview Gadget is first loaded.


Notes on Client Support

Expand depth

Expand all Tree items when first loaded to this depth.

Notes on Client Support

Filter

The filter expression that restricts the records that will be included in the grid.

Filter


Here rows in the Grid Gadget are filtered on the following logical expression:

discount > 0

Notes on Client Support

Font

Notes on Client Support

Font size

Font size for the Tree or CheckListView items.

Font size: Checklistview Gadget


Here the Font size attribute of the Checklistview Gadget has been increased from the default of 8 to 16.


Font size: Treeview Gadget


Here the Font size attribute of the Treeview Gadget is at the default of 0 (corresponds to 8).


Notes on Client Support

Foreground color

Notes on Client Support

Get data mapping

Custom data mapping when reading data. Specify this as an expression.

Notes on Client Support

Grid row height

Height of the grid rows.

Grid row height


Here the Grid row height attribute has been increased from its default value of 22 to 30.


Notes on Client Support

GroupBox caption

An optional caption for the GroupBox containing the CheckListView items.

GroupBox caption


Here the GroupBox caption attribute has been set to the text 'GroupBox caption'.


Note that in the 'CheckListView App' (example_checklistview) demo App, the CSS style is set to 'border:0px;'.

This has been removed here to display the default groupbox border.


Notes on Client Support

Header labels

A comma separated list of header labels.

Header labels



The Hide column headers attribute must be unchecked (False) to display the Header labels.

Here the Header labels attribute has been set to:

Customer,Shipper,Order ID,Date Ordered,Date Shipped

Notes on Client Support

Help topic

Notes on Client Support

Hide column headers

Hide the column headers (True | False).

Hide column headers


Here the Hide column headers attribute is unchecked (False), so the comma-separated string specified in the Header labels is displayed in the column headers.


Notes on Client Support

Hide OK/Cancel Buttons

Hide the OK/Cancel buttons (True | False).

Hide the OK/Cancel buttons: False


When a Grid Gadget is added, the Hide the OK/Cancel buttons attribute is unchecked (False) by default.


Hide the OK/Cancel buttons: True


Check the Hide the OK/Cancel buttons attribute (True) to hide the OK and Cancel buttons in the action bar.


Notes on Client Support

Hide search field indicator

Notes on Client Support

Hide the action bar

Hide the action bar (True | False).

Hide the action bar: False


When a Grid Gadget is added, the Hide the action bar attribute is unchecked (False) by default.


Hide the action bar: True


Check the Hide the action bar attribute (True) to hide the action bar.


Notes on Client Support

Hyperlink

Notes on Client Support

Icon image

The icon image for the control.

Ignore after change

After data is edited (TextBox only), the 'Change' delegate only is called and it is assumed to update the field. This provides the ability to handle custom search logic in the App for this field (True | False)

Notes on Client Support

Image

The static image to be displayed in this gadget.

Image


Here the Image gadget's Image attribute is set to 'stars.jpg'.

The Stretch image attribute is checked (True) by default, so the image is resized to fit the gadget.


Notes on Client Support

Inherit dictionary rules

Inherit the data dictionary rules (e.g. Choices will change when dictionary Choices is altered)

Section: Inherit dictionary rules


Form Section Fields and Canvas Section Advanced Controls can 'inherit' the Data Dictionary rules. This populates the control's relevant attributes with the settings from the Data Dictionary.

By default, controls have the Inherit dictionary rules attribute set to True, but the containing Form and Canvas Sections have the attribute set to False.

To enable dictionary inheritance for all the controls in a Section, set the Section's attribute to True.


Field: Inherit dictionary rules



The attributes of the controls will be populated with the dictionary settings (save and reload the App).

Inherit dictionary rules can then be disabled for individual controls as required.

Remember, enabling Inherit dictionary rules for the control has no effect unless Inherit dictionary rules for the control's containing Section is enabled.


Notes on Client Support

Inherit dictionary caption

When Inherit dictionary rules is set to true at both section and formitem level, Inherit dictionary caption determines whether this also applies to the formitem caption. If Inherit dictionary caption is true, the formitem inherits the column's field caption, if false, the formitem can have a caption customized in the UI.

Notes on Client Support

Input mask

Notes on Client Support

Input mask type

Notes on Client Support

List items

A list of items.

List items: comma separated text


Here the List items is set to the comma separated text string shown below.

Note it includes icon file names prefixed with an '@'.


USA@:/images/cat_internet_sm,UK@:/images/home,Germany@:/images/cat_finance_sm
List items: SQL Select


Here the List items is set to the SQL Select statement shown below.


select productname from products order by productname

Notes on Client Support

Mandatory input

Data must be entered in this field.

Mandatory input



The Mandatory input attribute specifies that the field cannot be empty.

Attempting to save a record without entering non-empty data in a field with the Mandatory input attribute set returns an error message and the record is not saved.

Note: 0 is considered an empty numeric value.


Notes on Client Support

Data Dictionary: Not Null

The Mandatory input attribute corresponds to the Not Null Column Constraint stored in the table's Data Dictionary.

Modify a Column: Mandatory / Not Null


The Mandatory / Not Null Column Constraint can be set in the Create a Column and Modify a Column dialogs in the Data Workspace and Page Builder.


It can also be specified in the CREATE TABLE and ALTER TABLE commands.

// Mandatory
ALTER TABLE "customers" MODIFY CONSTRAINT CUSTOMERID SET NOT NULL
// Not Mandatory
ALTER TABLE "customers" MODIFY CONSTRAINT CUSTOMERID SET NULL

Pagination

Grid is always rendered using pagination (for large data sets) (True | False)

Pagination: True



If the Pagination attribute is checked (True) - default is unchecked (False) - the grid rows are always displayed in pages, regardless of the number of records.


Notes on Client Support

Password input

Notes on Client Support

Placeholder text

Notes on Client Support

Readonly

Notes on Client Support

Recalculate

Notes on Client Support

Refresh section when row changes

Refresh other fields in the section when row changes (True | False).

Refresh section when row changes: True


Here navigating rows in the Grid Gadget refreshes the other fields in the section from the southwind!order_details table.


Notes on Client Support

Relate on change

Notes on Client Support

Return tabs

Notes on Client Support

Row height

Row height for the Tree or CheckListView items.

Row height: Checklistview Gadget


Here the Row height attribute of the Checklistview Gadget is set to the default: 25 (pixels).


Row height: Treeview Gadget


Here the Row height attribute of the Treeview Gadget has been increased from the default of 18 to 25 (pixels).


Notes on Client Support

Search field

Notes on Client Support

Search panel field

Notes on Client Support

Selection column

The column to substitute into the Click/DblClick delegate. Use {} in the delegate where you want the text from this column to be placed.

Selection column


Here the Selection column is set to 1, so passes the select customerid to the DblClick delegate.


The Tree items attribute is set to:

select customerid,shipname,orderid,orderdate,shippeddate from orders order by customerid

The Double Click delegate is set to the following inline delegate:

?page:page1.section1?action=search&text={}||page:page1.section1?action=editmode

Notes on Client Support

Set data mapping

Custom data mapping when writing data. Specify this as an expression.

Notes on Client Support

Show indicators

Show expand/collapse indicators in the tree (True | False).


Show indicators


Here the Show indicators attribute is checked (True), to allow the nodes to be expanded and collapsed.


Notes on Client Support

Stretch image

Stretch image (True | False).

Stretch image: False


Here the Stretch image attribute is unchecked (False).

See the same Image gadget with the Stretch image attribute checked (True) to resize the image to fit the gadget here.


Stretch image: False; Fixed width and Fixed height set


This is the same Image gadget with the Stretch image attribute unchecked (False), but with the Fixed width and Fixed height attributes defined to fit the image.


Notes on Client Support

Tab order

Notes on Client Support

Text alignment

Data text alignment.

Notes on Client Support

Tooltip

A tooltip to display when the mouse hovers over the data.

Notes on Client Support

Tree items

A list of items to display in the Tree.

Tree items


Here the Tree items is set to the SQL Select statement shown below.

The Hide column headers attribute has been unchecked (False) to show the header text defined in the Header labels.


select customerid,shipname,orderid,orderdate,shippeddate from orders order by customerid

Notes on Client Support

URL

The URL for this gadget or section.

Notes on Client Support

User selectable search field

The user can select this as the search field interactively by clicking on it.

Notes on Client Support

Validation

Data input validation expression.

Notes on Client Support

Validation error message

Error message to display if data input validation fails.

Notes on Client Support

Notes on Client Support

Attribute Notes
ActiveX control Supported on the Windows Desktop client only.
Anchor
Allow multiple selections Setting Allow multiple selections to false is recognized on the Desktop client only.
On the Web/Mobile client, the checklist is displayed and operates as a series of checkboxes.
Alternating row colors The Treeview Gadget is currently supported on the Desktop client only.
Automatic pagination The Grid Gadget is currently supported on the Desktop client only.
Automatic pagination size The Grid Gadget is currently supported on the Desktop client only.
Autosuggestions
Autosuggestion headers
Autosuggestion column to search
Background color
Choices
Column alignments The Listview and Treeview Gadgets are currently supported on the Desktop client only.
Column icons The Treeview Gadget is currently supported on the Desktop client only.
Column widths The Listview and Treeview Gadgets are currently supported on the Desktop client only.
Columns to group by The Treeview Gadget is currently supported on the Desktop client only.
Context Menu Currently supported on the Desktop client only.
Custom attributes
Custom UI component
Data size
Data source
Default
Default search field
Dialog button
Dialog button delegate
Editable
Error message
Expand all The Treeview Gadget is currently supported on the Desktop client only.
Expand depth The Treeview Gadget is currently supported on the Desktop client only.
Filter The Grid Gadget is currently supported on the Desktop client only.
Font
Font size The Font size CheckListView Gadget attribute is supported on the Desktop client only.
The Treeview Gadget is currently supported on the Desktop client only.
Foreground color
Get data mapping
Grid row height The Grid Gadget is currently supported on the Desktop client only.
GroupBox caption Currently supported on the Desktop client only.
Header labels The Treeview Gadget is currently supported on the Desktop client only.
Help topic Currently supported on the Desktop client only.
Hide column headers The Treeview Gadget is currently supported on the Desktop client only.
Hide OK/Cancel Buttons The Grid Gadget is currently supported on the Desktop client only.
Hide search field indicator
Hide the action bar The Grid Gadget is currently supported on the Desktop client only.
Hyperlink
Ignore after change
Image Static image (filename) Image Gadgets are currently supported on the Desktop client only. Data bound Image Gadgets are supported on all clients.
Inherit dictionary rules
Inherit dictionary caption
Input mask
Input mask type
List items The Listview Gadget is currently supported on the Desktop client only.
Mandatory input
Pagination The Grid Gadget is currently supported on the Desktop client only.
Password input
Placeholder text
Readonly
Recalculate
Refresh section when row changes The Grid Gadget is currently supported on the Desktop client only.
Relate on change
Return tabs
Row height The Row height CheckListView Gadget attribute is supported on the Desktop client only.
The Treeview Gadget is currently supported on the Desktop client only.
Search field
Search panel field
Selection column The Treeview Gadget is currently supported on the Desktop client only.
Set data mapping
Show indicators The Treeview Gadget is currently supported on the Desktop client only.
Stretch image Setting Stretch image to false is recognized on the Desktop client only.
On the Web/Mobile client, the (data bound) image is always shown resized to fit the Image Gadget.
Tab order
Text alignment
Tooltip Currently supported on the Desktop client only.
Tree items The Treeview Gadget is currently supported on the Desktop client only.
URL
User selectable search field
Validation
Validation error message