Namespace: Consultingwerk.Integrations.RapidCloud
Class 
RapidCloudGridDefinition Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Integrations.RapidCloud.RapidCloudGridDefinition

Inherits: Progress.Lang.Object


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
AddBufferColumn (handle, character, character, character, character) Adds a generated column for the given buffer field
HANDLE AddColumn (character, character, character, character, integer, logical) Adds a column to the grid definition
AddColumnsFromBuffer (handle, character, character, character, character) Generates grid columns from the fields of the given (schema) buffer
HANDLE AddFilter (character, character, character, character) Adds a grid filter control to the grid definition
HANDLE AddFilter (character, character, character, character, character) Adds a grid filter control fed by a List endpoint to the grid definition
HANDLE AddFilterGroup (character, character, character) Adds a collapsible form group to the filter panel
HANDLE AddFilterTabs (character, character, character) Adds a vertical tab strip to the filter panel
AddIdentityColumn (character) Adds one of the mandatory record identity columns
ApplyQuerySort (character) Applies the QuerySort BY-phrase of a MetaDataSource to the sort settings of the grid columns
HANDLE ColumnBuffer (character) Returns the buffer positioned on the column row of the given column name
CreateResponseDataset (dataset-handle) Creates the dsgriddefinition response ProDataset
EnableFilterLookup (handle, character, character) Enables the lookup dialog of the filter control the given buffer is positioned on
HANDLE GridSettingsBuffer () Returns the buffer positioned on the grid settings row

Top Constructor Summary
Options Name Purpose
RapidCloudGridDefinition () Constructor for the RapidCloudGridDefinition class

Top Property Summary
Options Name Purpose
LOGICAL ReturnInt64AsCharacter


Method Detail
Top

AddBufferColumn (handle, character, character, character, character)
Purpose: Adds a generated column for the given buffer field
Notes:

Parameters:
phField HANDLE
The handle of the buffer field to describe
pcColName CHARACTER
The column name (including the extent suffix for extent fields)
pcForceColumns CHARACTER
The comma-delimited list of columns whose data is always populated
pcVisibleColumns CHARACTER
The comma-delimited list of initially visible columns in display order (empty for all)
pcPrivateColumns CHARACTER
The comma-delimited list of columns that are populated but never displayed
Top

HANDLE AddColumn (character, character, character, character, integer, logical)
Purpose: Adds a column to the grid definition
Notes: The returned buffer stays positioned on the created row,
so callers can assign further column attributes directly

Parameters:
pcColName CHARACTER
The name of the column
pcCaption CHARACTER
The caption of the column
pcDataType CHARACTER
The (lower case) ABL data type of the column
pcDataFormat CHARACTER
The frontend format mask of the column (empty for the data type default)
piPosition INTEGER
The position of the column (0 for the default position)
plHidden LOGICAL
Hide the column initially (available through the field chooser)
Returns HANDLE
The buffer handle positioned on the created column row
Top

AddColumnsFromBuffer (handle, character, character, character, character)
Purpose: Generates grid columns from the fields of the given
(schema) buffer
Notes: Follows the RCD reference conversion rules: lower case
ABL data type names, 0/# numeric masks, per-type default
formats and alignments, checkbox rendering for logical
columns and Name-1 style column names for extent fields.
When a visible column list is given, its order defines
the column positions and all other columns stay hidden
(available through the field chooser); without it every
column is visible in field order

Parameters:
phBuffer HANDLE
The buffer to generate the columns from
pcForceColumns CHARACTER
The comma-delimited list of columns whose data is always populated (lookup return columns)
pcVisibleColumns CHARACTER
The comma-delimited list of initially visible columns in display order (empty for all)
pcPrivateColumns CHARACTER
The comma-delimited list of columns that are populated but never displayed
pcExcludeColumns CHARACTER
The comma-delimited list of fields to skip
Top

HANDLE AddFilter (character, character, character, character)
Purpose: Adds a grid filter control to the grid definition
Notes: The returned buffer stays positioned on the created row,
so callers can assign further filter attributes directly

Parameters:
pcCtrlName CHARACTER
The name of the filter control (the GridData request receives its value under this name)
pcLabel CHARACTER
The label of the filter control
pcCtrlType CHARACTER
The type of the filter control (empty for input)
pcDataType CHARACTER
The (lower case) ABL data type of the filter value
Returns HANDLE
The buffer handle positioned on the created filter row
Top

HANDLE AddFilter (character, character, character, character, character)
Purpose: Adds a grid filter control fed by a List endpoint to the
grid definition
Notes: The returned buffer stays positioned on the created row,
so callers can assign further filter attributes directly

Parameters:
pcCtrlName CHARACTER
The name of the filter control (the GridData request receives its value under this name)
pcLabel CHARACTER
The label of the filter control
pcCtrlType CHARACTER
The type of the filter control (empty for input)
pcDataType CHARACTER
The (lower case) ABL data type of the filter value
pcItemsDataSource CHARACTER
The name of the List endpoint providing the filter items (may be empty)
Returns HANDLE
The buffer handle positioned on the created filter row
Top

HANDLE AddFilterGroup (character, character, character)
Purpose: Adds a collapsible form group to the filter panel
Notes: Follows the GridFilterFactory conventions of the RCD
reference implementation. Filters are placed inside the
group through their ParentCtrlName

Parameters:
pcCtrlName CHARACTER
The name of the form group control
pcCaption CHARACTER
The caption of the form group
pcParentCtrlName CHARACTER
The parent control (e.g. FilterTabs.1 for the first tab), empty for the panel root
Returns HANDLE
The buffer handle positioned on the created filter row
Top

HANDLE AddFilterTabs (character, character, character)
Purpose: Adds a vertical tab strip to the filter panel
Notes: Follows the GridFilterFactory conventions of the RCD
reference implementation. Controls are placed on a tab
through the ParentCtrlName <pcCtrlName>.<tab number>

Parameters:
pcCtrlName CHARACTER
The name of the tab strip control
pcTabCaptions CHARACTER
The comma-delimited list of tab captions
pcTabIcons CHARACTER
The comma-delimited list of tab icons (empty entries default to the filter icon)
Returns HANDLE
The buffer handle positioned on the created filter row
Top

AddIdentityColumn (character)
Purpose: Adds one of the mandatory record identity columns
Notes: ttColumnSettings always contains the RowIdData and
RowIdDataParent columns (RCD wire contract) - populated,
never displayed

Parameters:
pcColName CHARACTER
The name of the identity column
Top

ApplyQuerySort (character)
Purpose: Applies the QuerySort BY-phrase of a MetaDataSource to
the sort settings of the grid columns
Notes: SCL-5724 decision: the initial grid sort comes from the
QuerySort attribute of the data source (as in the
SmartComponent Library UI, where the SmartDataBrowser
parses the adapter's BY-phrase for its sort indicators).
Buffer qualifiers are stripped; columns not part of the
grid are ignored

Parameters:
pcQuerySort CHARACTER
The QuerySort BY-phrase (e.g. "by eCustomer.Name descending by CustNum")
Top

HANDLE ColumnBuffer (character)
Purpose: Returns the buffer positioned on the column row of the
given column name
Notes: Used to refine generated columns (e.g. set BoldYN or an
EditCtrl). Returns ? when the grid definition holds no
such column

Parameters:
pcColName CHARACTER
The name of the column
Returns HANDLE
The buffer handle positioned on the column row or ?
Top

CreateResponseDataset (dataset-handle)
Purpose: Creates the dsgriddefinition response ProDataset
Notes: The created dataset is fully dynamic and independent of
this instance

Parameters:
phDataset DATASET-HANDLE
OUTPUT The created response ProDataset
Top

EnableFilterLookup (handle, character, character)
Purpose: Enables the lookup dialog of the filter control the given
buffer is positioned on
Notes: Follows the GridFilterFactory EnableLookup convention of
the RCD reference implementation: the lookup opens the
given app as a modal dialog and returns the value of the
given field into the filter

Parameters:
phFilterBuffer HANDLE
The buffer positioned on the filter row (as returned by AddFilter)
pcAppName CHARACTER
The name of the lookup app to open
pcReturnFieldName CHARACTER
The name of the field returned into the filter
Top

HANDLE GridSettingsBuffer ()
Purpose: Returns the buffer positioned on the grid settings row
Notes: Used to refine the grid level settings (e.g.
AllowRowMultiSelectYN, RowHeight)

Returns HANDLE
The buffer handle positioned on the grid settings row


Constructor Detail
Top

RapidCloudGridDefinition ()
Purpose: Constructor for the RapidCloudGridDefinition class
Notes: Creates the grid settings row with its default values and
the mandatory RowIdData / RowIdDataParent identity
columns



Property Detail
Top

LOGICAL ReturnInt64AsCharacter

Returns LOGICAL


Temp-Table Detail


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       10.10.2026 15:23:22