FormRef

Properties

association : string

The association path to the view containing the model that the popup will edit.

caption : string

String indentifier for caption display in the UI.

collectionNew : string

Alternative association path to use for create. Subclass name is optional.

Format: "assoc1(SubClassName) ... assocN(SubClassName).

commit : CommitKind

Specifies if the changes made in the models are sent to the server with commit flag as false, or true. One of "auto", "never", "always".

When set as "auto" the framework will apply rules based on the form association to figure out the value of the server request commit flag. The "never" value causes the server request flag to be false for all update requests. The "always" value causes the server reqeust flag to be true for all update requests.

Valid values based on“string”.
auto
never
always

delete : boolean

True if data can be deleted from the referenced form.

edit : boolean

True if data can be edited in the referenced form.

enabled : boolean

True if the referenced form is enabled.

form : identifier

Form name that this FormRef references.

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.

icon : string

Icon provides a means of visual recognition of the FormRef.

insert : boolean

True if data can be inserted from the referenced form.

lazy : boolean

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

name : uiIdentifier

Uniquely identifies the FormRef.

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.

orderBy : string

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

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.

query : string

List of additional attributes to include in read query.

style : string

Specifies the style for the FormRef.

The specified style is applied to the container of the referenced form.

tabIndex : int

The index number associated with the tab function.

tree : string

List of view paths to tree controls which can be masters of this detail form. Valid only if the "treeNodes" property is also specified.

Format: ((formRef1 tree1)...(formRefN treeN))

treeNodes : string

List of tree nodes within tree controls specified in the "tree" property.

Format: ((tree1staticNode1 ... tree1staticNodeN)...(treeNstaticNode1 ... treeNstaticNodeN))

type : FormEditType

Specifies the type of FormRef.

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

where : string

Optional where clause to be added to collection model query.

Content

Sequence of:
- MasterBinds [0..1]
- UnionBinds [0..1]

Parents