g_CustomControlModel_Models_Model

Model

An individual model assigned to a custom control.

Properties

cached : boolean

True if the collection is cached on the client.

collection : boolean

Specifies if the model will be a collectionModel. True if a collection model, false if an instance 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.

collectionOrderBy : string

Optional order by clause to be added to the Label collection 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.

collectionWhere : string

Optional clause to be added to collection model query.

editMode : FormEditType

Whether the model 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.

name : string

Uniquely identifies the model by name.

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.

recursion : string

Name of the recursive model.

value : string

If collection=false then the class instance to which the control will bind.

Example: (@) - the current instance model associated with the current form.

If collection=true then an expression that specifies the class or association path to which the control will bind.
Example: (@) - all instances of the associated class for Forms and form controls.
(@@ 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.

valueDriven : boolean

True if the current index of the collection is driven by instance value.

Content

Sequence of:
- g_CustomControlModel_Models_Model_Binds [0..*] - A collection of binds to be assigned to a custom control.

Parents

g_CustomControlModel_Models - A collection of models to be given to a control.

g_CustomControlModel_Models_Model_Binds
A collection of binds to be assigned to a custom control.

Parent topic: g_CustomControlModel_Models