Grid Variable

GridVariableImg01

Grid Variable node has the following properties:

Category Property  
General Properties Name GridVariableImg02
Description
Invite Message
Read Only
Load Code
Sortable ByTitle
Conditional Formatting
Column Tags
Totalizer
Type Definition Data Type
Domain / Attribute
Type
Form Theme Class
Visible
Control Info Control Info
Control Info Based On
Conditions (Dynamic Controls)
Control Type
Custom Properties Custom Properties
General Width
Title Category
Responsive Customization Visible (Extra Small)
Visible (Small)
Visible (Medium)
Visible (Large)
Column Selector Visible by Default
Export Include In Export
Export Report Include In Export Report
Export CSV Include In Export CSV
Title Filter Include Title Filter
Search Box
Search Box Condition
Data List
Selected Item Condition
Data List Include Total Records
Data List Max Values
Data List Fixed Values
Group Allow Grouping
Group Caption
Group Field

General Properties:

Name:

Grid variable's name. This property is required as to identify it on the form, Rules and Events.

Description:

Grid variable's description. Represents the title of the variable's column in grid . It has the same meaning as Grid Attribute's Description property (if you want to see examples about it open Grid Attribute node).

Invite Message:

Specifies a message that will be displayed in the variable's field in order to describe what you should fulfill on it. When the end user starts to write something on the variable, this message disappears. It is supported only when property 'Document type' property of the KB is HTML 5.

Read Only:

Variable is read only.

Load Code:

Specifies the code that will be set in the Grid´s Load Event in order to load this variable. User has the flexibility to do whatever he wants as to load it. For example, the variable can be assigned by invoking a procedure (call or udp), assign it from an attribute value or as a result of some concatenation of attributes, mathematical operation, etc.

Sortable by title:

Specifies whether the column will have the possibility to be sorted by clicking on it or not. This sorting will be server side, so will sort all the records and not only the visible ones. The values for this properties are:

  • <default>: will take its value from Grid
  • True: will add the possibility to click on that column and order the records ascendant or descendant by that attribute
  • True (Order 'SomeOrder'): will add the possibility to click on that column and order the records ascendant or descendant by that Order. The Order is a child node of Orders. For example, for PersonFullName we have the following options:

GridVariableImg03

TitleSorting can be used un Genexus grids, ColumnsSelector grids or GXUI grids.

For visualizing some example images of title sorting, and more information about it, follow the link: Title Sorting (Server Side)

Conditional Formatting:

Specifies the conditions that will apply different formats to this column. There is an example of the use of this property on Grid Attribute, and also you can read more information about this feature in the following link: Conditional Formatting

Column Tags:

Specifies the conditions that will apply different tags to this column.

Totalizer:

Specifies whether that attribute will have sum totalizer, average totalizer or won´t have totalizer. The possible values are:

  • False
  • Sum: it will sum the attribute value of all the records that are being shown in the grid (from all pages).
  • Average: it will calculate the average of the attribute value considering all the records that are being shown in the grid (from all pages).
  • Minimum.
  • Maximum.

If you set Sum or Average, the preview will show you how it will look like at runtime:

GridVariableImg04

In the following video you can see an overview of this functionality:

Properties Of Category Type Definition:

The properties inside this category refer to the variable's type.

Data Type:

Specifies whether the variable will have a basic type (value Basic) or whether it will be based on some attribute, domain (value based on).

Depending on the value of Data Type property some properties are visible or hidden automatically.

Type Definition: Based on

GridVariableImg05

Domain/Attribute:

Specifies the domain, attribute on which the variable will be based on. This property is required in order to define the variable in the generated object (Transaction, Selection, View, etc.).

Type Definition: Basic

GridVariableImg06

Type:

Specifies the type of the variable. Most of the GeneXus possible types are supported by this property:

VariableImg15

Depending on which type you have selected, some other properties will appear. For example, if you select Numeric type you have the option to define the amount of decimals, and if you select Varchar you have the length of it.

Properties Of Category Form

Theme class:

Variable´s theme class. 

Visible:

Specifies whether the variable will be visible inside its grid or not.

Properties Of Category Control Info

The properties inside this category refer to the variable's control type.

Control Info:

Specifies whether the variable will have a specific control type based on some domain/attribute, etc or will be defined customized. If you leave this property in its default value (based on) with empty value in 'Control info based on' property the control type of the variable will be the same as its definition.

Depending on the value of 'Control Info' property some properties are visible or hidden automatically.

Control Info: Based on

VariableImg19

Control info based on:

Specifies the domain or attribute in which the variable's control info will be based on.

Conditions (Dynamic controls):

Specifies the conditions to be added to the control (only if the control is Dynamic Combo, Listbox or Suggest).


Control Info: Custom

VariableImg20

Control Type:

Specifies the variable's control type.

Most of the options that GeneXus allows for control types are supported in this property:

VariableImg21

Depending on the control type selected, other properties may appear. For instance, if the control type is Combo box, the properties Values and Empty Item will be visible.

Properties Of Category Custom Properties:

Custom Properties:

Gives the option to assign specific properties to variables, properties that are not available within the variable node. This should be used in just a few cases. Detailed info: Custom Properties for Grid, Attributes and Variables

Properties Of Category General:

Width:

Specifies the width of the column where the variable will be displayed. If the value is 0 it will base its value on the Autoresize property within the definition of the attribute/domain. This applies for editable variables and read only variables, but not within ColumnsSelector grids. There is an example of this property on the following link: Grid Attribute

Title Category

Specifies the desired category for this variable within the Grid. You should set the desired text that will be displayed above the Column Title in the Grid.

For example:

SelectionGridAttributeImg22

Properties Of Category Responsive Customization:

Visible (Extra Small) - Visible (Small) - Visible (Medium) - Visible (Large):

With these properties, you can set whether the variable will be visible in the different browser sizes. For example, you can set that is visible when the browser is Large and not visible when the browser is Extra Small. The possible values for these properties are true or false.

Properties Of Category Columns selector:

Visible by default :

Specifies whether the variable will be visible by default in the grid. In other words, specifies if the variable will be visible as the page loads its first time (PersonWW for example). Only applies when the Column Selector property of node that contains it is True, and for Selection and Grid Tab objects. If the attribute has its Visible property on False, this property is not valid because the attribute would never be visible.

This property has the same meaning as Grid Attribute´s Visible by default property. (if you want to see an example of this open Grid Attribute node).

Properties Of Category Export:

Include in Export:

Specifies whether the variable will be included in the excel export or not. Only applies when StandardAction Export is enabled for this object. 

Properties Of Category Export Report:

Include in Export Report:

Specifies whether the variable will be included in the PDF report or not. Only applies when StandardAction Export Report is enabled for this object.

Properties Of Category Export CSV:

Include in Export CSV:

Specifies whether the variable will be included in the CSV file or not. Only applies when StandardAction Export CSV is enabled for this object.
 

The values of the properties 'Include in Export', 'Include in Export Report' and 'Include in Export CSV' are <default>, True and False. <default> value will have the same behavior as the previous versions (will include it only if it is visible in grid). If the property is True, the attribute/variable will be included and False will not be included.

Properties of Category Title Filter:

Include Title Filter:

Specifies whether to include column title filtering for this variable or not. The possible values are:

  • False
  • True

If True, a new set of properties appear, so to configure the column filter of the variable:

GridVariableImg07

Search Box:

Specifies whether the variable will have a search box inside the column title filter. The possible values are:

  • None: it won't include a search box
  • Single: it will include one search box
  • Range: it will include two search boxes, so that users can filter from some data to other data

GridVariableImg08

Search Box Condition:

Specifies the condition that will be used to filter that column records. In the case of variables, it is mandatory to define a condition in order to have the search box, as it will define the condition that will use.

Data List:

Specifies whether the attribute will have a list of the possible values or not, in the column title. The options for this property are:

  • Dynamic: means that it will include a list of real values of this column, and these search will be done on server side, which means that will display values from the current page and from pages that are not visible.
    GridVariableImg09
     
  • Fixed: means that it will include a list of fixed items. This can be used when the attribute contains enumerated values, or is a combo box with fixed items. When this value is choosen specifically for an attribute, a new property will appear where you have to specify the fixed values that will appear on the list. If the attribute is combo, or has enumerated values it will take that values for the list automatically. If not, you would have to specify it separating the items with a comma. For example: 1:Male,2:Female (1 is the value and Male is the description).
    GridVariableImg10
     
  • None: it won't include a list with possible values for that column.

Selected Item Condition:

Specifies the condition to apply when end user selects an item from the Data List. It is mandatory to set this condition, as if not the grid won't filter anything when clicking in an item of the list of the variable. Generally, when clicking in an item, the condition is an equal one (I.E <SomeAttribute> = &variable).


Data List Include Total Records:

Specifies whether to include next to the data item, the amount of records which have that value. This only applies when the data list is dynamic. 
 

Data List Max Values:

Specifies the maximum amount of items to display in the dynamic data list.
 

If you want to read more information about Column Filters, read the following link: Column Filters

Data List FIxed Values:

Specifies the filters with fixed values that will be added to the column filter. It is analogous to the same property in grid attributes, and there is an example of this property on Grid Attribute

Properties Of Category Group:

These properties are associated to grouping the records of a grid, and only applies when the property 'Group Field' within the 'Grid' node is 'Multiple options'. There is a sample of this feature in the following link: Grouped Columns

When the Group column is a variable (like this case), you need to have enabled the 'Sortable by Title' of the column, and select the 'Order' associated to that column.

Allow Grouping:

Specifies whether the end user will be able to group the records of the grid by this column. 

Group Caption:

Specifies the caption to be displayed in the group row, when selecting this column. The value <default> will take its value from WorkWithPlus Settings -> Labels -> 'Group Caption'.

In WorkWithPlus Settings -> Labels node -> 'Group Caption' property, you can mention the tags <ATT_DESCRIPTION>, <ATT_VALUE_DSC> and <GROUP_COUNT>.

Example 1:

  • Group column: PersonStatus
  • Value of 'Group caption': format('%1: %2', <ATT_DESCRIPTION>, <ATT_VALUE_DSC>)
  • At runtime each group row will display:
    • Status: Started
    • Status: Finished
    • Status: Canceled

Example 2

  • Group column: PersonStatus
  • Value of 'Group caption': format('%1: %2' (%3), <ATT_DESCRIPTION>, <ATT_VALUE_DSC>,<GROUP_COUNT>)
  • At runtime each group row will display:
    • Status: Started (74)
    • Status: Finished (52)
    • Status: Canceled (59)

Group Field:

Specifies the field that WorkWithPlus will use to group the records of a grid when selecting this column to group. In most cases, this property will be set as '<default>', which means that will use the attribute itself. But in some cases, for example an inferred attribute of another transaction, you can select here to choose by the FK in order to have better performance.

Interesting links