Component Definition

Description

Properties for a component embedded in a UX Component.

Component name 

The name of the component embedded in the UX. E.g., if a Grid called "Customers.a5wcmp" is embedded in the UX, the Component name would be "Customers".

Component type 

The embedded component type. E.g. "Grid", "UX".

Component alias 

The embedded component's alias. If you specify <DefaultAlias> a default alias will be used. If you specify an explicit alias, that value (prefixed with the alias of this component) will be used.

It is recommended to give the embedded component an explicit alias. This allows you to use methods such as {dialog.object}.getChildComponent() to get a pointer to the embedded component.

Base Filter 

An optional base filter for the component. The Base filter cannot be removed by the user. The Grid is filtered on both the Base filter and the User filter.

Base Filter only applies to an embedded Grid component.

User Filter 

An optional user filter. The User filter can be removed if the user executes a 'Show All' command. The Grid is filtered on both the Base filter and the User filter.

User Filter only applies to an embedded Grid component.

Link 

When you link a Grid, the records in the target Grid are filtered on the linking fields.

In addition, when the user enters new records into the target Grid, the linking field(s) are automatically filled in with the linking value(s) from the current row in the source Grid. This means that any new records that are entered are automatically 'linked' to the current record in the Grid.

It is possible for Grid components to be linked on multiple fields (e.g. Firstname and Lastname).

It is possible to define a Link and also a Filter. The Filter will further restrict the records shown in the target Grid.

For example, you might link a Grid on a common 'CustomerId' field and then specify a filter of 'OrderAmount > 1000'. The records shown in the target grid will be all those for which the 'CustomerId' matches the 'CustomerId' in the current record AND those records with an OrderAmount > 1000.

Live link 

If checked, the Grid will be refreshed if the value in any Linked controls changes.

Order 

An optional order.

Argument bindings 

Defines the value for arguments in the embedded object. Arguments can be populated from fields in the UX Component.

Use master style 

Use the style specified in the 'Additional Grid Styles' property.

The style used by the target component must be specified in the 'Additional Grid Styles' property, or else the CSS for the target component will not be loaded.

Override settings 

You can define override settings in the component. You may need to specify additional "flags" if the settings being overridden require recomputing the component. See How to Override Grid Component Settings in an .a5w page or OnGridExecute event for more information about flags.

Working message 

Specify the message to display while the server computes the Grid before it is displayed for the first time.

onLoadComplete Javascript 

Specify the Javascript to run when this embedded component has finished loading.

This code runs in the context of the embedded UX (so, for example, {dialog.object} refers to the embedded UX object, not the component in which the UX has been embedded).