g_HolderContentsGroup_Grid

Grid

Properties

caption : string

String indentifier for caption display in the UI.

collapseIcon : string

Icon used to collapse repeaters.

collection : string

If blank, the Grid isn't data driven. Otherwise, the grid will be dynamically driven from the collection specified here.

An expression that specifies that a collection model must be set on the control.

Example: "" (empty string, or null) - all instances of the associated class for Forms and form controls. No collection for other controls like MenuItems.
(@@ ClassName) - all instances of the class specified by ClassName
(ControlName1 assoc1 ... assocN) ... (ControlNameM assoc1 ... assocX) - all instances filtered by the parent instances.
(@ assoc1 ... assocN) - variant of above example. All instances relative to the Form model.

collectionAnnotation : string

Space separated list of annotations which do not exist in the Domain Model.

collectionLazy : boolean

Load the collection on display, not when the screen is loaded.

If true, the query for the dynamic grid will only be executed when the grid is displayed. Otherwise, the grid will be loaded when the screen is loaded.

collectionNew : string

Alternative association path to use for create. Subclass name is optional. Format: "assoc1(SubClassName) ... assocN(SubClassName).

collectionOrderBy : string

Optional order by clause to be added to the Grid query: ((attr1 . asc1) ... (attrN . ascN)).

List of attributes or attribute and boolean pairs to indicate ascending (true) or descending (false).

Example: ((name . #t) (company . #f))

collectionQuery : string

List of additional attributes to include in collection read query.

collectionValue : identifierList

Value bind for data-driven Grid. Must be an attribute of the Grid's collection.

Passed as parameter to the UIEvent, if specified.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])\s+)(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*)?	Each element in the list must begin with a letter or underscore. Elements are space delimited.

collectionWhere : string

Optional clause to be added to collection model query.

commit : CommitKind

TODO: comment attribute commit

Valid values based on“string”.
auto
never
always

context : string

The attribute, association path, or a constant specifying context indentifier to be set. For context bus adapter.

See: Application'contextImplementation

control : identifier

The control type this should be rendered with.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

controlAuto : boolean

TODO: comment attribute controlAuto

controlDelete : boolean

TODO: comment attribute controlDelete

controlInsert : boolean

TODO: comment attribute controlInsert

controlUpDown : boolean

TODO: comment attribute controlUpDown

delete : string

Boolean attribute name, or constant specifying whether the delete operation is allowed in the layout.

deletePrompt : string

Delete prompt string identifier. Valid if promptOnDelete is true.

The string indentifier may accept the Class name, and instance name args.

edit : string

Boolean property specifying whether the insert, delete, or edit operations are allowed in the column.

editMode : FormEditType

Whether the control is used for querying, or editing.

Valid values based on“string”.
edit	Marks the form as edit only.
query	Marks the form as query only.

emptyListCaption : string

String indentifier for caption to be displayed when the list is empty in the UI.

emptyListCaptionAlign : Alignment

Horizontal alignment of the empty list caption.

Example: left, right, center.

Valid values based on“string”.
right
center
left

enabled : string

The attribute, association path, or a constant returning boolean to set enablement.

endOfListCaption : string

String indentifier for caption to be displayed when the end of the list is reached in the UI.

error : string

Expression returning non-#f if the message should be treated as an error. The raw message is passed as "this".

exclusive : boolean

If true lack of selection means disabling children collection query. Otherwise, children query is generated.

expandIcon : string

Icon used to expand repeaters.

factory : identifierList

Factory method for many to many grid.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])\s+)(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*)?	Each element in the list must begin with a letter or underscore. Elements are space delimited.

form : identifierList

The form that is bound to this Grid.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])\s+)(:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*)?	Each element in the list must begin with a letter or underscore. Elements are space delimited.

formCollapsible : boolean

Flag indicating whether the form can be collapsed.

formCollapsibleLayout : string

When repeater form is specified points to a layout in the form which will be automatically expanded for current grid row.

The layout must be a child of the root layout.

formVisible : boolean

Specifies if the attached form is visible. Useful only if 'form' attribute is set.

fullSelection : boolean

Specifies the ability of full selection in the Grid.

gearMenu : identifier

The Grid's gear menu. Must refer to an existing menu in the Form's collection of Menus.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

gridLines : boolean

Specifies if the grid contrain grid lines.

headers : boolean

Specifies if the Grid has attached column headers.

history : HistoryType

Sets the history behavior of the GridColumn. Values can be "auto", "true", or "false".

Valid values based on“string”.
auto
true
false

icon : string

Icon provides a means of visual recognition for the Grid.

insert : string

Boolean attribute name, or constant specifying whether the insert operation is allowed in the layout.

insertMenu : identifier

TODO: comment attribute insertMenu

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

maxRowCount : int

This property sets the maximum number of rows queried at a time. The count attribute of the request will be set to this number.

menu : identifier

The Grid's main menu. Must refer to an existing menu in the Form's collection of Menus.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

menuColumnTopSpacing : int

Specifies the spacing above the menu column icon. Vertically center aligned if not specified.

multipleSelection : boolean

Enables multiple row selection in the grid.

multipleSelectionMenu : identifier

The Grid's multiple selection menu. Must refer to an existing menu in the Form's collection of Menus.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

name : uiIdentifier

Uniquely identifies the tabbable control.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter. Case and length are not restricted. Letters and numbers are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

paging : Paging

Paging determines the paging behavior of 'list' UI controls.

Paging affects any control that presents lists and has an <a href="#orderBy">orderBy</a> property. An Order By attribute must have a unique index defined in the persistence mapping/schema to be used in paging. This means that each attribute bound to sortable columns in a 'pageable' grid must be indexed. If not, all rows will be retrieved to the client for sorting.

Valid values based on“string”.
auto	The model determines the best paging type to use. The model looks at the Order By property of the UI control. If there is a unique index defined in the schema that starts with the attribute(s) listed in the Order By property, bookmark paging will be used. If there is a non-unique index defined in the schema that starts with the attribute(s) listed in the Order By property, offset paging will be used. If the Order By has no index, none-sortserver paging will be used. Enumeration value is 0.
bookmark	The model can use bookmark paging.
offset	The model can use offset paging.
none-sortclient	The model will have no paging and a sort on the server.
none-sortserver	The model will have no paging and a sort on the client.

popupTooltip : identifier

The name of screen appearing as popup tooltip.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

popupTooltipJustification : RelativeJustification

The popup tooltip justification relative to its anchor. One of "before", or "after".

Valid values based on“string”.
before
after

popupTooltipPosition : RelativePosition

The position of the popup tooltip relative to its anchor. One of "above", "below", "left", or "right.

Valid values based on“string”.
above
below
left
right

promptOnDelete : boolean

Prompt the user before deleting an item.

query : string

List of additional attributes to include in read query.

reorderColumns : boolean

Specifies if the Grid can be reordered.

required : string

The attribute, association path, or a constant returning boolean to set whether the value for the control is required.

If the attribute is required in the model, it takes precedence and one cannot change this setting in the UI. If the attribute is not required in the model, the requiredness can be set to an attribute, association path, or a constant returning boolean. If the value is set to #t, or the attribute value is true, the requiredness cannot be changed using 'required' view property that is set via client-side API. If the value is left blank, it is set to #f, or the attribute value is false, the requiredness can be changed using 'required' view property that is set via client-side API.

resizeableColumns : boolean

Specifies if the columns in the Grid are resizeable.

rowDraggable : boolean

Specifies whether a row can be drag and dropped.

rowHeight : Dimension

Height of the control data rows (not repeater rows). Units can be one of pixels, points or percentage. If not set, use the default height set in the extraCSS "Grid-Row" style, or 26px.

Example: 100px, 100pt

Valid values based on“string”.
(\d{1,8})\|(\d{1,8}px)\|(\d{1,8}pt)\|(\d{1,8}%)

rows : int

This property specifies the number of rows to query on the initial query in a paging-enabled (i.e. not 'none-' paging mode) grids. Subsequent page size may be adjusted depending on the actual rendered size of the Grid. Must be an integer.

This is not to be confused with rowSpan. RowSpan specifies how many rows the grid visually spans. Rows specifies how many internal rows the grid contains. For FlatMobile application, value of -1 is interpreted as no maximum row limit.

scroll : boolean

Specifies if the GridColumn is scrollable.

showCaption : boolean

Specifies whether to display caption for the Grid.

showMenu : boolean

Specifies the visibility of the menu.

showMenuColumn : boolean

Specifies whether the menu column is shown. Useful only if 'showMenu' attribute is set to true.

showMoreOnRepeaterOverflow : boolean

Specifies if the more label will be shown then the contents of a repeater overflow outside of the grid.

showPageSizeSelector : boolean

Flag indicating if the user is allowed to adjust the page size.

singleLineCaption : boolean

When true grid caption is optimized to display caption, toolbar, and gear menu on a single line.

style : string

The style of the GridColumn.

tabIndex : long

The index number of the tabbable control. Must be a long integer.

tabStop : boolean

Specifies if tabbing should stop on the tabbable control

toolbar : identifier

The Grid's main toolbar. Must refer to an existing menu in the Forms's collection of Menus.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

tooltip : string