Namespace: Consultingwerk.Web2.Services.Rendering.FormComponents
Class 
GridWebRendering Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Web2.Services.Rendering.FormComponents.GridWebRendering

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Web2.Services.Rendering.FormComponents.IFormWebRenderingComponent, Consultingwerk.Web2.Services.Rendering.IWebGridRenderingService

/*&GLOBAL-DEFINE NoUserLobStatistics NoUserLobStatistics

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



Top Method Summary
Options Name Purpose
ApplyDefaultColumnFormat (Column, handle) Applies the default format for DATE, DATETIME and DATETIME-TZ columns
CHARACTER GetDefaultColumnWidth (character) Returns the default width of a grid column based on the format
Progress.Json.ObjectModel.JsonObject GetDetailTemplate (character) Returns the Detail Template
CHARACTER GetMandatoryColumns (character, character) Returns the MandatoryColumns of the Business Entity descriptor of the entity table of the grid
CHARACTER GetTranslation (character, character, character) Returns a translated string
LOGICAL IsFilterMultipleColumn (handle, logical) Returns if the filter row cell of a grid column supports the selection of multiple values
LOGICAL IsFilterRangeColumn (handle, character) Returns if the filter row cell of a grid column is the from/to range filter cell
LOGICAL IsLinkColumn (handle) Returns if a grid column is to be rendered as a link column
LOGICAL IsProgressBarColumn (handle) Returns if a grid column is to be rendered as a progress bar
Progress.Json.ObjectModel.JsonObject RenderColumnEditor (handle, handle, handle, handle, character) Renders an embedded editor
RenderColumnEvents (Column, handle) Renders the server-side event handlers of the field events of a grid column
RenderColumnHeaderButtons (Column, handle) Renders the column header buttons based on comma delimited attribute values
RenderColumnValueList (Column, handle) Renders the value list attributes of a data field column
Progress.Json.ObjectModel.JsonObject RenderComponentToJson (character, handle, handle) Renders a component to JSON
RenderDataSourceColumns (KendoGrid, handle, character, character, character, character, IFieldAuthorizationProvider) Renders the fields of the data source tables that are not part of the grid design as hidden columns
RenderDoubleClickAction (JsonObject, handle, logical) Renders the DoubleClickAction attribute
Progress.Json.ObjectModel.JsonObject RenderDynamicGridToJson (character) Renders the grid template to JSON
Progress.Json.ObjectModel.JsonObject RenderDynamicGridToJson (handle) Renders the grid template
RenderFilterRange (Column, handle, character) Renders the filter mode and the limits of the from/to range filter cell of a grid column
Progress.Json.ObjectModel.JsonObject RenderGridLayout (character, handle, handle) Renders the Grid Layout based on the repository data
RenderProgressBar (Column, handle) Renders the progress bar settings of a grid column

Top Constructor Summary
Options Name Purpose
GridWebRendering () Static constructor for the GridWebRendering class


Method Detail
Top

ApplyDefaultColumnFormat (Column, handle)
Purpose: Applies the default format for DATE, DATETIME and DATETIME-TZ columns
Notes: The formats are provided by the IDateFormatProvider service. Columns
of any other data type are left unchanged

Parameters:
poColumn Consultingwerk.Web.Kendo.Grid.Column
The Column to apply the default format to
phBufferField HANDLE
The handle of the buffer field the column is rendered for
Top

CHARACTER GetDefaultColumnWidth (character)
Purpose: Returns the default width of a grid column based on the format
Notes: The width is derived from the pixel width of the format and is
limited to the range from 100 to 500 pixels

Parameters:
pcFormat CHARACTER
The format to derive the column width from
Returns CHARACTER
The character value with the default width of the column
Top

Progress.Json.ObjectModel.JsonObject GetDetailTemplate (character)
Purpose: Returns the Detail Template
Notes:

Parameters:
pcDetailTemplate CHARACTER
The name of the detail template
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the detail template
Top

CHARACTER GetMandatoryColumns (character, character)
Purpose: Returns the MandatoryColumns of the Business Entity descriptor of
the entity table of the grid
Notes: SCL-6167. Returns an empty string when the Business Entity does
not provide a descriptor for the table

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
pcEntityTable CHARACTER
The name of the entity table
Returns CHARACTER
The comma delimited list of the mandatory columns
Top

CHARACTER GetTranslation (character, character, character)
Purpose: Returns a translated string
Notes:

Parameters:
pcScope CHARACTER
The translation scope
pcKey CHARACTER
The translation key
pcDefault CHARACTER
The default text - when no translation is available
Returns CHARACTER
The Translated text
Top

LOGICAL IsFilterMultipleColumn (handle, logical)
Purpose: Returns if the filter row cell of a grid column supports the
selection of multiple values
Notes: SCL-6037 - requires the FilterMultiple attribute and a list of
values: a combo box or lookup (a component column) or a data
field with a value list. Fields storing a delimited list of
values (MULTIPLE) are not supported.

Parameters:
phColumnAttributes HANDLE
The record buffer with the column attributes
plComponentColumn LOGICAL
Logical value indicating if the column is rendered by a component (combo box, lookup)
Returns LOGICAL
Logical value indicating if the filter row cell supports multiple values
Top

LOGICAL IsFilterRangeColumn (handle, character)
Purpose: Returns if the filter row cell of a grid column is the from/to
range filter cell
Notes: SCL-6049 - requires the FilterMode attribute with the value Range
and a date, datetime or datetime-tz column. On other data types
the column keeps the single value filter cell.

Parameters:
phColumnAttributes HANDLE
The record buffer with the column attributes
pcDataType CHARACTER
The ABL data type of the field of the column
Returns LOGICAL
Logical value indicating if the filter row cell is the range filter cell
Top

LOGICAL IsLinkColumn (handle)
Purpose: Returns if a grid column is to be rendered as a link column
Notes: SCL-5435 - a column is rendered as a link column either based on
the InputType attribute (the "url" value used by the Viewer
rendering, or "link") or based on a VIEW-AS phrase of "link",
following the pattern of the badge column rendering

Parameters:
phColumnAttributes HANDLE
The record buffer with the column attributes
Returns LOGICAL
Logical value indicating if the column is rendered as a link column
Top

LOGICAL IsProgressBarColumn (handle)
Purpose: Returns if a grid column is to be rendered as a progress bar
Notes: SCL-6042 - based on the InputType attribute value "progressbar"

Parameters:
phColumnAttributes HANDLE
The record buffer with the column attributes
Returns LOGICAL
Logical value indicating if the column is rendered as a progress bar
Top

Progress.Json.ObjectModel.JsonObject RenderColumnEditor (handle, handle, handle, handle, character)
Purpose: Renders an embedded editor
Notes:

Parameters:
hColumnInstanceBuffer HANDLE
The handle of the column instance buffer
hColumnAttributes HANDLE
The handle of the attributes buffer
phRepositoryData HANDLE
The handle of the ProDataset with the repository data
phDataset HANDLE
The handle of the dataset of the design time data-source
pcTables CHARACTER
The name of the tables of the design time data-source
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the repository data
Top

RenderColumnEvents (Column, handle)
Purpose: Renders the server-side event handlers of the field events of a grid column
Notes: SCL-6074. Leave, Validating, ValueChanged, EditorButtonClick and the
lookup events AfterPerformLookup, LookupComplete and LookupKeyValueChanged
with a server-side handler (server:<TaskName>:<MethodName>} are
rendered as <TaskName>:<MethodName> into the events object of the
column. The events object is only rendered when the column has at least
one server-side handler

Parameters:
poColumn Consultingwerk.Web.Kendo.Grid.Column
The Column to render the events for
phColumnAttributes HANDLE
The record buffer with the column attributes
Top

RenderColumnHeaderButtons (Column, handle)
Purpose: Renders the column header buttons based on comma delimited attribute values
Notes:

Parameters:
poColumn Consultingwerk.Web.Kendo.Grid.Column
The column instance to attach the headerButtons array to
phColumnAttributes HANDLE
The record buffer with the column attributes
Top

RenderColumnValueList (Column, handle)
Purpose: Renders the value list attributes of a data field column
Notes: SCL-2783 (ValueListKey), SCL-6038 (ValueListItems, ValueListItemPairs
and ValueListDisplayText). The frontend resolves the list in the
order of the desktop grid (DynamicBrowserRenderer): key, items,
pairs. The properties are rendered only when set, so that the
layout of grids without value lists is unchanged; the display
text mode is only rendered together with a value list

Parameters:
poColumn Consultingwerk.Web.Kendo.Grid.Column
The column to render the value list properties into
phColumnAttributes HANDLE
The record buffer with the column attributes
Top

Progress.Json.ObjectModel.JsonObject RenderComponentToJson (character, handle, handle)
Purpose: Renders a component to JSON
Notes:

Parameters:
pcObjectInstanceGuid CHARACTER
The GUID of the current object instance
phAttributesBuffer HANDLE
The record buffer with the object attributes
phRepositoryData HANDLE
The repository data to render (ProDataset)
Returns Progress.Json.ObjectModel.JsonObject
The JSON object describing the component
Top

RenderDataSourceColumns (KendoGrid, handle, character, character, character, character, IFieldAuthorizationProvider)
Purpose: Renders the fields of the data source tables that are not part of
the grid design as hidden columns
Notes: SCL-5784 - the columns are rendered hidden and remain available in
the column chooser of the grid, so that users can bring in columns
beyond the ones placed in the grid design. Fields restricted by
field security, serialize-hidden fields and array fields are not
rendered. The columns are not editable

Parameters:
poGrid Consultingwerk.Web.Kendo.Grid.KendoGrid
The KendoGrid to add the columns to
phDataset HANDLE
The handle of the ProDataset of the Business Entity
pcTables CHARACTER
The comma-delimited list of the tables of the data source (EntityTable and EntityView)
pcEntityTable CHARACTER
The name of the primary table of the data source
pcRenderedFields CHARACTER
The comma-delimited list of the field models already rendered as columns
pcTranslationScope CHARACTER
The translation scope for the column labels, may be empty
poFieldAuthorizationProvider Consultingwerk.Framework.Authorization.IFieldAuthorizationProvider
The reference to the IFieldAuthorizationProvider, may be invalid
Top

RenderDoubleClickAction (JsonObject, handle, logical)
Purpose: Renders the DoubleClickAction attribute
Notes:

Parameters:
poOptions Progress.Json.ObjectModel.JsonObject
The componentsOptions JSON object
phAttributesBuffer HANDLE
The repository attributes buffer
plUpdatableGrid LOGICAL
Logical vale indicating if the grid is updatable
Top

Progress.Json.ObjectModel.JsonObject RenderDynamicGridToJson (character)
Purpose: Renders the grid template to JSON
Notes:

Parameters:
pcObjectName CHARACTER
The repository object name of render
Returns Progress.Json.ObjectModel.JsonObject
The Angular viewer template as a JSON Objet
Top

Progress.Json.ObjectModel.JsonObject RenderDynamicGridToJson (handle)
Purpose: Renders the grid template
Notes:

Parameters:
phRepositoryData HANDLE
The repository data to render (ProDataset)
Returns Progress.Json.ObjectModel.JsonObject
The Angular viewer template
Top

RenderFilterRange (Column, handle, character)
Purpose: Renders the filter mode and the limits of the from/to range filter
cell of a grid column
Notes: SCL-6049 - does nothing for columns without the range filter cell,
so that the JSON of those columns is unchanged. The limits are
rendered as ISO dates, an unset limit as null.

Parameters:
poColumn Consultingwerk.Web.Kendo.Grid.Column
The grid column to render the range filter cell for
phColumnAttributes HANDLE
The record buffer with the column attributes
pcDataType CHARACTER
The ABL data type of the field of the column
Top

Progress.Json.ObjectModel.JsonObject RenderGridLayout (character, handle, handle)
Purpose: Renders the Grid Layout based on the repository data
Notes:

Parameters:
pcObjectInstanceGuid CHARACTER
The GUID of the current object instance
phAttributesBuffer HANDLE
The record buffer with the object attributes
phRepositoryData HANDLE
The repository data to render (ProDataset)
Returns Progress.Json.ObjectModel.JsonObject
The JSON object describing the component
Top

RenderProgressBar (Column, handle)
Purpose: Renders the progress bar settings of a grid column
Notes: SCL-6042 - min, max and label are rendered only when set, so that
the frontend defaults (0 to 100, no label) apply otherwise. A
MinimumValue of 0, a MaximumValue of 0 and the label "none"
count as not set.

Parameters:
poColumn Consultingwerk.Web.Kendo.Grid.Column
The Column to render the progress bar settings for
phColumnAttributes HANDLE
The record buffer with the column attributes


Constructor Detail
Top

STATIC GridWebRendering ()
Purpose: Static constructor for the GridWebRendering class
Notes:



©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2026 08:17:23