Grid

GridWWSImg01

Grid node form has the following properties:

Category Property  
General Properties Back Color Style GridWWSImg02
Cell Spacing
Cell Pading
Paging Type
Page
Save Grid State
Save Grid State In Tabs
Grid State SDT
Save Grid Current Page
Save And Load Grid State Compatible
Send Grid State to Procedures
Always use Column Title Property
Action Columns Auto Resize
Column Auto Resize
Notify Context Change
Columns Selector Column Selector 
Column Selector Type
Always Calculate Records Count
Add New Columns
Save Grid Columns State
Orders Sortable By Titles
Sortable By Titles (FS with Header)
Include Sortable By Title In Drop Down Options
Orders Combo visible
Allow Selection Selection Color
Hovering Color
Type Type
GXUI Type Actions Resizable
Actions Hideable
Actions Menu Disabled 
Data Columns Hideable
Data Columns Menu Disabled 
Enable Column Move
Conditional Formatting Row Conditional Formatting Options
Icon Tag Options
Text Tag Options
Tag Column Tooltip Position
Fix Column FixedColumn Default Value

 

 

General Properties:

Back Color Style:

Specifies the back color style of every grid within the instances.


Cell spacing:

Specifies the size of the Cell spacing property of every grid within the instances.


Cell padding:

Specifies the size of the Cell padding property of every grid within the instances. 

Paging Type:

Specifies the paging type of every grid within the instances.

The options are:

  • One page at time.
  • Infitine scrolling (form scroll bar)
  • Infitine scrolling (grid scroll bar)


Page:

Specifies the default value for this property on Selection node. This property specifies the number of rows per page that its grid will display. This property can be '<unlimited>', 'Page.Rows' or directly the number of rows that we want the grid to display. If this property is '<unlimited>' the grid will not have paging (all records will be displayed within a grid page). It can be the result of invoking some procedure also, like GetNumberOfRows.udp(&parm1,...)


Save grid state:

Specifies how the filters and orders selected will be saved, so that when user returns to it will visualize the same orders and filters that had selected before. The options are: No (will not save filters and orders), In session (will save filters and orders just in session, so that if user closes the application and opens it again the filters and orders selected before will not remain), Custom (allows developer to save the filters and orders as he needs).

When the property has value 'In session' or 'Custom' it will call to a subroutine 'LoadGridState' in Start Event in order it load the filters and orders saved and also will call to subroutine 'SaveGridState' in refresh event in order to save the changes made in the filters and orders.

GridWWSImg03

GridWWSImg04

Example of Custom value

The 'LoadGridState' subroutine will call to a procedure named LoadGridState where developer will add the code necessary in order to load the filters and orders in the way that he needs.

GridWWSImg05

And the 'SaveGridState' subroutine will call to a procedure named SaveGridState where developer will add the code necessary in order to load the filters and orders in the way that he needs. 

GridWWSImg06

And the procedures LoadGridState and SaveGridState are user procedures (developer will add the code needed). There is a suggestion in order to save filters and orders state in database. You would have to follow the instructions on them:

GridWWSImg07

GridWWSImg08

Save grid state in Tabs:

Specifies how the filters and orders selected will be saved, so that when user returns to it will visualize the same orders and filters that had selected before, in GridTab objects. The values are the same as 'Save grid state' property, so you can visualize an example of it above. 


Grid State SDT:

Specifies the SDT that will be used in order to save the state of the filter's grids.


Save Grid Current Page:

Specifies whether to save or not the current page that the end user is navigating, so that when he goes to another page and returns the grid displays the page he was visualizing at last.


Save and Load Grid State Compatible:  

Specifies whether to include the code to save and load the grid state compatible with versions 8 or lower (when saving the state in the Data Base) or not. Only applies if 'Save Grid State' or 'Save Grid State in Tabs' are 'True' respectively.


Send Grid State to procedures:

Specifies the mechanism that will be used in order to send the information of the grid (filters, column filters, orders, parameters, etc). The options are by parameters or by session.


Always Use Column Title Property:

If True, when creating the instances, the description property of the attributes in the grid will be taken always from the Column Title property. If False, when the attributes in the grids are not foreing keys or not inferred, the description will be taken from the Contextual Title property.


Action Columns Auto Resize:

Specifies whether to set the property AutoResize in True or False for actions columns in grid.  


Column Auto Resize:

Specifies whether to set the property AutoResize in True, False or will take its value from property AutoResize of the attribute or variable definition for columns that are not actions in grid. These columns could be attributes or variables.


Notify Context Change:

Specifies whether to set the property NotifyContextChange of Grid in True or False. Only applies if the ColumnsSelector property of grid is false.

Properties Of Category Columns Selector:

Column selector:

Specifies the default value for this property on instance Grid node. This property specifies whether to generate the grid allowing Columns Selector functionality or not. If this property is True, WorkWithPlus pattern will give the possibility to select at runtime which columns to be visible and which ones not visible. This is useful when we have too many columns in a grid, and user whishes to visualize ones or others depending on what is analyzing.
 

If you want to read more information about about the Columns Selector, follow this link: Column Selector

Columns Selector Type:

Specifies the type of Columns Selector that will be used when you specify that some Grid is Columns Selector. The options are: Free Style Grid and Regular Grid.


Free Style Grid: WorkWithPlus will implement the ColumnsSelector feature using a Free Style Grid. This means that you will have the option to hide/show columns and also reorder them.

Regular Grid: WorkWithPlus will implement the ColumnsSelector feature using a Regular Grid. This means that you will have the option to hide/show columns but you won't have the option to reorder them. Using a Regular grid for ColumnsSelector also allows you to enable selection of rows or add actions which needs to have information of many columns of a record.

GridWWSImg09

In order to set some grid as ColumnsSelector using Regular grid, it is necessary to add the StandardAction EditColumns within the object's instance:

GridWWSImg10

Always Calculate Records Count:

Specifies whether to calculate the number of records of the grid always, even when the grid is showing the first page. Applies only when ColumnsSelector is enabled.


Add New Columns:

Specifies whether the new columns that were inserted in the grid will be inserted in the saved configuration of the user. In other words, when some user saves a columns configuration and then the developer adds some new columns in grid, this property will determine if this new columns will be added in the user configuration or not.


Save Grid Columns State:

Specifies whether to save the state of the columns (columns configuration) in session or not. This is useful when the configuration of columns is not saved for each user in DB.

Properties Of Category Orders:

Sortable By Titles:

Specifies the default value for this property on variables or attributes inside a grid. This property in attributes or variables specifies whether the records of the grid will be sortable by cliking in that column. Applies for attributes or variables inside regular grids of a grid object.


Sortable By Titles (FS with Header):

Specifies the default value for this property on variables or attributes inside a free style grid. This property in attributes or variables specifies whether the records of the grid will be sortable by cliking in that column. Applies for attributes or variables inside free style grids of a grid object.

Include Sortable By Title in Drop Down Options:

Specifies whether the option to sort a grid column (attribute or variable) will be inside the Drop Down Options always or just when the Drop Down Options is created for other reason (for having column filtering). The Drop Down Options is the following:

GridWWSImg11

Orders Combo Visible:

Specifies the default value for this property on Orders node. This property specifies whether the orders combo will be visible or not, when the orders node contains more than one order.

Properties Of Category Allow Selection:

Selection color:

Specifies the color to asign to the selected row in grid. This property will set the value of 'Selection color' in grid. Only applies in grids that has Allow selection property in true.


Hovering color:

Specifies the color to asign to the hovered row in grid. This property will set the value of 'Hovering color' in grid. Only applies in grids which has Allow Hovering in property true.

Properties Of Category Type:

Type:

Specifies the type of all the grids by default. The values for this property are GeneXus and all the Custom Render of grids that are installed in your version of GeneXus. 

Properties Of Category GXUI Type:

Actions Resizable:

Specifies whether the actions will have the possibility to change its size or not. 


Actions Hidable:

Specifies whether the actions will have the possibility to hide them or not. 


Actions Menu Disabled:

Specifies whether the menu of that action will be disabled or not. Is the menu that contains some functionalities relationed to the action column.to order the grid by that column, or set it as hidden. 


Data Columns Hidable:

Specifies whether the columns of attributes or variables will have the possibility to hide them or not. 


Data Columns Menu Disabled:

Specifies whether the menu of that column will be disabled or not. Is the menu that allows to order the grid by that column, or set it as hidden. 


Enable Column Move:

Specifies whether it will have the possibility to move the columns of the grid or not.

Properties Of Category Conditional Formatting:

Row Conditional Formatting Options:

Specifies the possible format options that will be available to use when setting some conditional formating to a row or column.

GridWWSImg12

These are the ones that come by default when importing a theme. You can create new ones, edit the existent ones or remove them.

Category:

Specifies the cateogory of the format. When yoy creating a row formatting condition you will have to select one category.

Name:

Specifies the name of the format. Then, when creating a row formatting condition you will have to select one of them by name.


Theme class:

Specifes the name of the class that will be assigned to the column of the grid, or to the whole row, when the condition is accomplished. WorkWithPlus displays a preview of how the column of the grid will look like when using these formats.

Excel format:

For each one, you can include more than one format separated by ';'. The possible values are: Italic, Bold, Underline and Color:<COLOR_NUMBER> (i.e: Italic;Bold;Color=RGB(221,75,57). Note: The Color format must be set as the last format.

The conditional formatting options supported for Excel files are row conditional formatting and column conditional formatting.

Report format:

For each one, you can include more than one format separated by ';'. The possible values are: Italic, Bold, Underline, BackColor:<COLOR_HEXA> and Color:<COLOR_HEXA> (i.e: Italic;Bold;Color=#F2DEDE)

The conditional formatting options supported for Report files are row conditional formatting.

Icon Tag Options:

Specifies the possible icon tag options that will be available to use when setting some conditional formating to a row or column.

GridWWSImg14

These are the ones that come by default when importing a theme. You can create new ones, edit the existent ones or remove them.

Is Font Icon?:

Specifies if the icon tag is an icon or not.

Preview:

In this column will be show the preview of the icon tag.

Text Tag Options:

Specifies the possible text tag options that will be available to use when setting some conditional formatting to a row or column.

GridWWSImg15

These are the ones that come by default when importing a theme. You can create new ones, edit the existing ones, or remove them.

Tag Column Tooltip Position:

Specifies the position of the tooltip displayed for the tag column. The options are Automatic, Left, Top, Right, Bottom. Automatic will display the tooltip on the position where it enters (for example, if the column is on the left it will display it to the right, etc.)

Fix Column

FixedColumn Default Value

It specifies if the columns of the grids are going to be fixable or not.