Characteristics of the columns in a Table control in a window

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

Editors

Controls (window/page/report)

Controls

Table Column control

Characteristics of the columns in a Table control in a window

Overview

Characteristics of the columns in a Table control in a window

Fixed column, anchored column

Progress Bar column

Calculated column and Check Box column (Table control populated programmatically and with in-memory data source)

Related examples

See also

Characteristics of the columns in a Table control in a window

Overview

The columns are used to display information in a Table control. The same type of information is displayed in the same column.

Remark: The columns in the TreeView Table controls have the same characteristics as the columns in the Table controls.

The following types of data can be displayed in a column:


Text Currency Time Combo Box Not available. Image Progress Bar Not available.	Numeric Date Caption Check Box Not available. Duration Not available. Container (not available in Java and in WINDEV Mobile)

Remark: To call gImage in a column, use a Text column.

You have the ability to perform calculations on the content of one or more columns. For more details, see Managing the calculations in the columns of a Table control.

Specific characteristics can be configured for each type of column.

The programming of each type of column corresponds to the programming of the corresponding control.

The following paragraphs present the main characteristics of the Table control columns displayed in a window, available regardless of the column type. For the columns of Table controls displayed in a page, see Characteristics of the columns of a Table control in a page.

Characteristics of the columns in a Table control in a window

Most characteristics of the columns found in a Table control are configured in the "General" tab of the characteristics of each column.

Image of column title

This option allows you to define the image that will be used as the background image of the column title.

Table control columns cannot have an image in the column title.

Resize column

If a column is resizable:

The user can change the size of the columns with the mouse.
This column will be automatically resized with the "Adjust all columns" option in the context menu of the column header.

Programming:

You can resize columns using TableAdjust.
You can make columns resize to fit their content by using AAFExecute with the aafAdjustAllColumns constant.

Sortable column

The user will be able to sort the column via a click performed on its header. This option is available:

for all columns in a Table or TreeView Table control populated programmatically.
for some columns in the Table control based on a data file (only columns based on key items and without filter).

The "Options" button allows you to define the characteristics of the sort on Text columns.

When the "Customize sort" option is checked, you can select the sorting mode or the desired sorting combinations.
Tip: Enable the "gXXX functions" option: This option allows you to sort the column according to the content defined with gLink.
To use this feature, simply call gLink in the display event of a row. For example, to display the dates in fully readable format and sort the column by date, the row display code is:

sSortableDate is string

// Gets the gLink for the sort + value to display
sSortableDate = gLink(dDate) + DateToDayInAlpha(dDate) + " " + ...
dDate.Day + " " + DateToMonthInAlpha(dDate)+ " " + dDate.Year

// Displays the date in a fully readable format and sorts data
TableAddLine(TABLE_Orders, Order.OrderInternalNumber, sSortableDate, ... )

Remark: At runtime, the Ascending sort

and

icons indicate the sort direction of the column. You can customize the images used. For more details, see Configuring the titles of the columns found in a Table control.

Programming: The sort can also be performed through programming via the following functions:


TableSort	Used to sort the content of a Table or TreeView Table control on one or more columns
TableSortChild	Used to sort a branch of a TreeView Table control on one or more columns (lexicographical sort).

The SortOption property allows you to define the sorting options.

An optional event can also be managed: Whenever the column is sorted.

Movable column

The user will be able to move the column in the Table control and to change the order in which the columns are displayed.

The columns of the Table control cannot be moved.

Search (Search icon / Filter)

The user will be able to implement a "Starts with" filter in the column. Only the elements starting with the letters typed for the column will be displayed.

Two methods are available:

The user types the sought word directly. This search is automatically performed in the sorted column.
Clicking a column header with a search icon opens an edit control. The user will only have to type the sought word.

The user clicks the column header to open the context menu.

In the context menu, the user selects the search icon:
In the input area that is displayed at the top of the Table control, the user types the sought word.

The search icon is available:

for all the columns in a Table control populated programmatically.
for the columns of Table controls based on a data file with automatic iteration (only sortable columns based on key items, and without filter).

Caution: The search icon is not available:

for items associated with a multi-file link.
for the Table controls that use a non-proportional scrollbar ("Proportional scrollbar" unchecked in the "Details" tab of the description window of the Table control).

You can customize the search icon. For more details, see Configuring the titles of the columns found in a Table control.

Programming: This feature can be performed through programming via the following functions:


TableSearch	Searches for a value in a column of a Table or TreeView Table control based on a data file or populated programmatically.
TableSearchChild	Searches for a value in a column of a TreeView Table control, in a specified branch.

An optional event can also be managed: Whenever performing a search with the search icon.

Export and print

The table column can be taken into account during the print and in the exports:

Always,
Never,
If the column is visible in the window.

Remark: This option will be taken into account:

when creating a report on Table/TreeView table.
when printing the table content via the "Print" option in the context menu.
when using the export options in the context menu of the table.
when using the export functions (TableToExcel, TableToClipboard, TableToText, TableToWord and TableToXML).

Programming: This option can be configured through programming with the VisibleInExportAndPrint property.

Fixed column, anchored column

Fixed column

A fixed column will always remain displayed during the horizontal scroll of the Table columns. If the column is not fixed, it will move along with the other columns. The fixed columns are always located on the left of the Table control.

You can set the number of fixed columns in the Table control description ("Details" tab, Number of columns fixed to the left). The first x columns will be fixed.

This feature is not available in WINDEV Mobile.

Anchored column

The anchored column is the column onto which the anchoring options will be applied. The column width will change according to the size of the window and the Table control.

You can define:

the number of the anchored column in the "General" tab of the Table control description.
the anchor rate in width of a column in the "UI" tab of the description window of the column.

Progress Bar column

Description

The configuration of the progress bar is performed in the "General" tab of the column description. You can configure:

the initial value of the progress bar,
the maximum value of progress bar,
the active image and the background image.

The "Details" tab of the column description is used to configure the display of the progress percentage, ...

Progress bar with a different upper bound for each row of the Table control

You have the ability to display a progress bar with a different upper bound for each row. In this case, you must:

Assign the MaxValue property to 100 for the column.
Perform the desired calculation in the display code of the row:

<Progress Bar column> = <Value of Progress Bar>*100/<Max Value>

Properties that can be used on a Progress Bar cell

You can use the MaxValue and MinValue properties on the Progress Bar cells using the following syntax:

<Column name>[<Row number>].MaxValue = <Value>
<Column name>[<Row number>].MinValue = <Value>

Calculated column and Check Box column (Table control populated programmatically and with in-memory data source)

Calculated column and Check Box column

You can create calculated columns in a Table control with in-memory data source: these columns are not linked to a data file. These columns can display a calculation, for example, ...

"Check Box" columns in a Table control with in-memory data source are specific calculated columns. When scrolling through the control, checked boxes keep their selected state.

Remark: In Table control with direct access to the data source, calculated Check Box columns (not linked to an item) are lost when scrolling through the rows.

Style of Check Box columns

You can define the style of the check boxes found in the columns: you can choose the image that will be used when the option is selected, for example.

To define the style of Check Box columns:

Open the Table control description window.
In the "Style" tab, select the "Check Box column" element. You can:
- select the checkmark style among one of the preset styles.
- choose a specific image for representing the checkmark ("Checkmark style" option corresponding to "Checkmark image").

Other characteristics of Check Box columns

The Check Box columns also propose the following features:

Context menu used to check/uncheck table rows and to filter them. For more details, see Context menu of Check Box columns (AAF).
Option to hide unchecked boxes in read-only Table controls ("Hide the checkmark if unchecked (read-only)" option in the "Details" tab of the column description window or EmptyIfZero property).

Related Examples:

Unit examples (WINDEV): Style for displaying the table cells

[ + ] Modifying the display style of table cells.
The ..BrushStyle property is used to hatch the cells or to create a color gradient with "tube" effect.

Unit examples (WINDEV): Custom Calculations

[ + ] Using a formula entered by the user in a Table control.
The formula is entered in the column and stored in a .INI file in order to be used whenever the table is displayed. The formula can be modified at any time by the user.

Unit examples (WINDEV): The Table/TreeView Table control (Progress Bar columns)

[ + ] Using a Progress Bar column as well as the ..TextProgressBar property in a Table or TreeView Table control