Combo

Properties

bounded : Bounded

If "auto" the system determines if the combo is bounded. If true the combo is bounded.

Valid values based on“string”.
auto	Automatically sets bounded to true if the value is bound to a required attribute, otherwise unbounded.
true	Force the list to be bounded.
false	Force the list to be unbounded.

cached : boolean

True if the query should be allowed to be cached. False if the query should not be cached.

caption : identifierList

If the value is an object, the caption is an attribute on the object to display in the text portion.

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.

collection : string

If blank, the ComboType isn't data driven. Otherwise, the combo 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.

collectionCaption : identifierList

Caption bind for data-driven Combo. Must be an attribute of the Combo's collection.

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.

collectionLazy : boolean

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

If true, the query for the dynamic combo will only be executed when the combo is displayed. Otherwise, the combo 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 Combo 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.

collectionTooltip : string

The attribute, association path, or a constant specifying tooltip for each collection item.

collectionValue : identifierList

Value bind for data-driven Combo. Must be an attribute of the Combo'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

conjunction : string

The name of the "any" group in the query.

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.

deletePrompt : string

Delete prompt string indentifier. 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.

enabled : string

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

error : string

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

event : identifier

The UIEvent attached to the Combo control. UIEvents are handled by UIActions.

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.

exclusive : boolean

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

factory : identifierList

Factory method for many to many combo.

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.

menu : identifier

The menu associated with the Combo.

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.

nullItemCaption : string

First list item caption. Selecting it sets the value to null.

operator : Operator

An evaluation operator applied to [?] resulting in [?].

Example: <, >, <=, >=, !=, like?

Valid values based on“string”.
=
!=
<
<=
>
>=
like?

promptOnDelete : boolean

Prompt the user before deleting an item.

query : string

List of additional attributes to include in read query.

radio : boolean

Specifies if the Combo box appears as a radio button, rather than a drop-down list.

radioColumns : int

The number columns the radio button spans. Must be an Integer.

read : string

Custom read event. [<class>]'<event> <arg1> ... <argN>

Specification: [<class>]'<event> <arg1> ... <argN>

<class> is an optional class symbol. When omitted ActiveNode's class is used. <event> is a read event symbol. <arg#> is an event argument value which can be either a constant or a scheme expression evaluating to a constant at run-time on the client, using special local variables provided by the framework: this (=controller), :node (=active node), :attributes, :where, :orderBy, :count, :offset, :xlock, or a UI initializer variable.

If arguments are not specified, a default list is supplied by the framework: :attributes :where :orderBy :count :offset :xlock

Examples:

a) Generate a request to 'readList event with default arguments: readList

b) Generate request to readList event with attributes, and orderBy argument values supplied by the framework. readList :attributes :orderBy

c) Generate request to Contact'readDetail with attributes supplied by the framework, and the contact argument calculated using (current-contact) client library function. Contact'readDetail :attributes (current-contact this :node)

In a library: (define (current-contact controller node) ... )

d) Generate request to 'read event with a constant attribute list: read '(lastName firstName) :where :orderBy :count :offset :xlock

refreshAlways : boolean

Whether the control makes a server submission upon every list selection.

When false the framework may still force the control to make submissions upon every list selection if there are UI event handlers where the control is a source, or if the control is part of hierarchical combo relationship. The property should be used sparingly for cases when a custom script needs to run with every dropdown selection. It increases a load on the server.

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.

sort : ComboSortType

The type of sorting to be applied when retrieving the collection model.

Specifies the type of sorting to be applied when retrieving the collection model. A setting of 'Client' will perform the sorting after all values have been retrieved from the server and can be used to sort calculated attributes. The default is 'Server'.

Valid values based on“string”.
client	The model will be sorted on the client.
server	The model will be sorted on the server.

style : string

Style of the Combo background

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 toolbar associated with the Combo.

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

The attribute, association path, or a constant specifying tooltip.

value : string

The attribute to which the control will bind.

visible : string

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

Parents