string Grid.GridColor

Grid lines color in RRGGBB format.

Default="BBBBBB" (light grey)

string Grid.SelectedColor

Color of selected cell in RRGGBB format, default is Application.RGBSelectColor with some transparency.

string Grid.Textcolor

Text color, in RRGGBB format.

Default is "000000" (black)

string Grid.OddBackgroundColor

Background color for odd lines, in RRGGBB format.

Default is "FEFFFF" (white)

string Grid.EvenBackgroundColor

Background color for even lines, in RRGGBB format.

Default is "EDF2FF" (light grey)

string Grid.OddFolderBackgroundColor

Background color for odd folder lines, in RRGGBB format.

Default is "FFCC90" (yellow)

string Grid.EvenFolderBackgroundColor

Background color for even folder lines, in RRGGBB format.

Default is "FFC060" (yellow)

string Grid.HeadersGridColor

Grid line color in headers, in RRGGBB format.

Default is "000000" (black)

string Grid.HeadersTextColor

Text color in headers, in RRGGBB format.

Default is "000000" (black)

string Grid.HeadersBackColor

Background color for headers, in RRGGBB format.

Default is "BBBBBB" (light grey)

string Grid.HeadersSelectedColor

Color in headers to locate selected cell, in RRGGBBAA format.

Default is Application.RGBSelectColor.."80".

boolean Grid.IsShowHeader

Show header row?

Default is true.

boolean Grid.IsShowColumnCaptions

Show caption in headers?

If true (default), show column caption, else, show Excel-like alpha "A", "B", ... "Z", "AA"...

boolean Grid.IsShowRowNumbers

Show row numbers (default is true)?

If true an extra column is visible on the le left with row numbers.

boolean Grid.IsShowColSeparators

Show column separator lines?

Default is true

boolean Grid.IsShowRowSeperators

Show row separator lines?

Default is true

number Grid.RowHeight

Row height in pixels.

Default is calculated.

boolean Grid.IsHighlightFullRow

Always highlight the entire selected row?

False by default, means only highlight the cell at selected column of selected row.

boolean Grid.IsFolderView

Display as a folder view, like File>New, Staff>Add...

? First column is like a folder/subfolder name (separated with a slash), this will then create folder view, open/close folder on click...

boolean Grid.IsFolderSort

If folder view, force the sort of folders, true by default.

Turn it to false if datas are already sorted, to speed up display.

string Grid.FolderSeparator

In folder view, separator between sub-folders, default is "/"

Map Grid.Columns

Map of column definitions.

Keys are the ID (alpha "A", "B", ... "Z", "AA"), values are GridColumn table.

See

Grid.AddColumn

Grid.GetColumn

GridColumn

table Grid.Rows

Data in rows of the grid.

Array (table) of Map.
Rows[1] is the first row.
Rows[1].get("columnName") returns value in column having columnName as header for the first row

See

Grid.AddRow

Grid.GetSelectedRow

Grid.SetSelectedRow

table Grid.SortCriteria

Criteria for sorting data in the Grid.

2D table in the form {{"ColumnName 1", n}, {"ColumnName 2", n}} where n = 1 for ascending order, n = -1 for descending order.
nil or empty table means no sorting. This is lighter and faster, so if inserted rows can be sorted before insertion, do this. If rows content may change, then it's easier to use SortCriteria.

Grid.OnRowSelect(Dialog dlg, Grid grid, int rowIndex, Map rowMap)

Function fired when row selection changes..

Grid.AddColumn(Dialog dlg, Grid grid, string caption, string defaultValue, string valueType, table possibleValues, number width, int horizontalAlign, boolean visible, boolean autoTranslate)

Adds a column to the grid

Return

GridColumn: The created grid column as table object with properties and functions. You can add event, see GridColumn.

Errors

if type of defaultValue is not equal to valueType

in case of duplicate captions

See

Grid.Columns

Grid.GetColumn

GridColumn

Grid.GetColumn(Grid grid, string idOrCaption)

Return the requested column from its caption or ID (excel like letter "A", "B"...).

Grid.Columns can easily find column by ID, but not by caption. This function helps you.

Return

GridColumn: Found column.

Errors

If idOrCaption is not a string or an empty one.

If column is not found

See

Grid.Columns

Grid.AddColumn

GridColumn

Grid.AddRow(Dialog dlg, Grid grid, map, int pos)

Insert a map of columnName=>value into a new row of the grid.

If pos is not nil, this will insert at position pos, else this will insert after the last row

Return

Map: Map of column names to values

See

Grid.GetSelectedRow

Grid.SetSelectedRow

Grid.RemoveAllRows

Grid.Rows

Grid.RemoveAllRows(Dialog dlg, Grid grid)

Remove all rows from the grid

Grid.GetSelectedRow(Grid grid)

Return the select row's Map of columnName to value.

Return

Map: The row's Map, or nil if no row is selected

See

Grid.SetSelectedRow

Grid.Rows

Grid.SetSelectedRow(Dialog dlg, Grid grid, int rowIndex)

Select a row of the grid.

This function doesn't fire the OnRowSelect event, if implemented, but it'll be fired as soon as possible on idle.

See

Grid.GetSelectedRow

Grid.Rows

Grid.GetVisibleRows(Dialog dlg, Grid grid)

Return all visible rows after applying filter and sort.

Ignore folder, consider all folder as open.

Return

table: Listof rows, each one is a Map.

See

Grid.Filter

Grid.SortCriteria

Grid.OpenFolder(Dialog dlg, Grid grid, string folderName)

Opens a folder, if IsFolderView is true All parents folders are open.

Grid.CloseFolder(Dialog dlg, Grid grid, string folderName)

Closes a folder, if IsFolderView is true Sub-folders are shadowed, it means they will show again once folder is open.

Grid.WriteCSVFile(Dialog dlg, Grid grid, string csvFileName)

Save grid data in CSV file.

Not fully tested, export all rows, even hidden ones.

Grid.SearchRow(Dialog dlg, Grid grid, term, function evalFunc)

Search first row from the top where evalFunction returns true and select the row.

Return

boolean: Returns true if a row was found, false if not. If no row was found, the selection is not moved.

Example

 local func = function(dlg, grid, rowMap, term)
      return rowMap:get("My column name")==term
    end
  local myTerm = tostring(123) -- if number, convert it to string once
  myGrid.SearchRow(dlg, myGrid, myTerm, func)

Grid.Filter(Dialog dialot, Grid grid, int rowIndex, Map rowMap)

Filter the rows to show in the grid.

For each row, this function may return true to show it, or false to hide it.

Return

boolean: true to show the row, false or nil to hide it.

Grid.MoveToFirstRow(Dialog dlg, Grid grid)

Move selection to first row if exists.

Grid.MoveToLastRow(Dialog dlg, Grid grid)

Move selection to last row if exists.

Grid.MoveToNextRow(Dialog dlg, Grid grid, int amount)

Move selection to next row, if exists.

If no row is selected, move to first row, if exists.

Grid.MoveToPreviousRow(Dialog dlg, Grid grid, int amount)

Move selection to previous row, if exists.

If no row is selected, move to first row, if exists.

Grid.MoveToFirstColumn(Dialog, Grid grid)

Move selection to first column

Grid.MoveToLastColumn(Dialog dlg, Grid grid)

Move selection to last column.

Grid.MoveToNextColumn(Dialog dlg, Grid grid)

Move selection to next column.

If no column is selected, move to first column.

Grid.MoveToPreviousColumn(Dialog dlg, Grid grid)

Move selection to previous column.

If no column is selected, move to first column.