Orders property

Defines several criteria for ordering Grid / Tabular Grid data.

Scope

Generators: Android, Apple, Angular
Controls: Grid, Tabular Grid

Description

This property can be set for Grids and Tabular Grids (in this last case, only for Angular) included in Panel objects.

It allows you to define different (simple or compound) orders so that the end user can select any of them at any time.

Each order is identified by a name and composed of a list of attributes (in ascending or descending order).

If more than one order is specified, at runtime the end user will see a combo box with all the order names.

Runtime/Design time

This property applies only at design time.

Samples

Consider a Knowledge Base containing the following Transaction objects:

Neighborhood
{ 
   NeighborhoodId*
   NeighborhoodName
}

Property
{
   PropertyId*
   PropertyName
   PropertyPhoto
   PropertyAddress
   NeighborhoodId
   NeighborhoodName
}

Suppose you include a Grid control in the Layout of a Panel object as shown below.

Two orders have been defined for the Orders property of the Grid:

1) Property Name, composed of the PropertyName attribute.
2) Neighborhood, composed of the NeighborhoodName, PropertyName attributes.

Each "Order" node (in the above example there are two "Order" nodes) has a set of properties to configure:

• Name: The name given to the order. At runtime, it will be shown in the combo box that offers the possible orders.
• Break by: Allows control break. False by default. This property is not supported for Tabular Grids yet.
• Enable Alpha Indexer property: See Enable Alpha Indexer Property. False by default.

When the Break by property is set to True, the following properties are enabled:

• Break by up to: Indicates, when the order is composed of two or more attributes (for example, Att1, Att2, ..., AttN), the range of attributes for the break. That is, if it is up to Att2, the grouping criteria will be: Att1, Att2. The other attributes (from Att3 to AttN) will be used only for ordering purposes inside each group and not for the grouping itself.
• Description attribute: See Description attribute.

In turn, for each attribute in the list that makes up the order, there are three properties to be set:

• Attribute: Attribute Name.
• Description: See Description property.
• Ascending: True by default.

Continuing with the example, suppose that for the first order, you leave the default property values and for the second order, you set the properties as follows:

This means that although the second order is composed of two attributes (NeighborhoodName, PropertyName), a break is desired but only by the NeighborhoodName attribute (to show the properties grouped by NeighborhoodName). As the order is composed of the pair (NeighborhoodName, PropertyName), for each NeighborhoodName the properties will be displayed ordered by PropertyName.

At runtime, when the second order is selected, the result will be as follows:

On the other hand, when the first order is selected (by PropertyName and with no break), the result will be as follows:

"Break By" node

Suppose you do not want to define orders but to define a break. This node allows you to indicate the attributes for which you want to make the break.

See Also

Orders and Filters in Grids of Panels
Order clause (in For Each, Data Providers and Data Selectors)