Top Method Summary
Options Name Purpose
AddEditorButtons (JsonObject, handle) Adds editor buttons to the input settings JSON object
AddStyle (JsonObject, handle) Adds style to the input settings JSON object
CHARACTER ArrayEntry (character[], integer) Returns the entry at the given index of a character array
AttachFormEvents (JsonObject, handle, character) Attaches form-level event handler definitions (such as FormClosing, FormClosed and ModalFormClosed) to the settings JSON object of a Smart Form Notes : Unlike AttachServerEvents (used for viewer / grid components), the raw attribute value is emitted as-is: the "server:" prefix of a server-side event handler is retained and the plain method name of a client-side logic handler is emitted unchanged. This matches the JSON shape consumed by SCLNG, which reads form-level events from settings.events. @param poSettings The JsonObject with the Smart Form settings @param phAttributes The buffer with the Smart Form attributes @param pcEventList The comma-separated list of form event attribute names */
AttachServerEvents (JsonObject, handle, character) Attaches server-side event handlers to the component
CHARACTER EditorButtonEnabledState (character, character, character, character) Returns the enabledState value for a single editor button based on the entries of the EditorButtonAlwaysEnabled, EditorButtonEnabledForUpdate, EditorButtonEnabledForAdd and EditorButtonEnabledOnCopy attributes (SCL-5599)


Method Detail
Top

AddEditorButtons (JsonObject, handle)

Purpose: Adds editor buttons to the input settings JSON object
Notes:

Parameters:
poInputSettings Progress.Json.ObjectModel.JsonObject
The JsonObject with the input settings
phAttributes HANDLE
The buffer with the component attributes
Top

AddStyle (JsonObject, handle)

Purpose: Adds style to the input settings JSON object
Notes:

Parameters:
poInputSettings Progress.Json.ObjectModel.JsonObject
The JsonObject with the input settings
phAttributes HANDLE
The buffer with the component attributes
Top

CHARACTER ArrayEntry (character[], integer)

Purpose: Returns the entry at the given index of a character array
Notes: Returns "" when the array is indeterminate or shorter than the
requested index, so positional attribute lists (one entry per
entry in EditorButtonKeys) can be read without extent checks
at the call site (SCL-5599)

Parameters:
pcValues CHARACTER
The character array to read from
piIndex INTEGER
The index of the entry to return
Returns CHARACTER
The trimmed entry value or "" when not present
Top

AttachFormEvents (JsonObject, handle, character)

Purpose: Attaches form-level event handler definitions (such as
FormClosing, FormClosed and ModalFormClosed) to the settings
JSON object of a Smart Form
Notes : Unlike AttachServerEvents (used for viewer / grid components),
the raw attribute value is emitted as-is: the "server:" prefix
of a server-side event handler is retained and the plain method
name of a client-side logic handler is emitted unchanged. This
matches the JSON shape consumed by SCLNG, which reads form-level
events from settings.events.

Parameters:
poSettings Progress.Json.ObjectModel.JsonObject
The JsonObject with the Smart Form settings
phAttributes HANDLE
The buffer with the Smart Form attributes
pcEventList CHARACTER
The comma-separated list of form event attribute names
Top

AttachServerEvents (JsonObject, handle, character)

Purpose: Attaches server-side event handlers to the component
Notes:

Parameters:
poComponentOptions Progress.Json.ObjectModel.JsonObject
The JsonObject with the component options
phAttributes HANDLE
The buffer with the component attributes
pcEventList CHARACTER
The list of server-side events when defined
Top

CHARACTER EditorButtonEnabledState (character, character, character, character)

Purpose: Returns the enabledState value for a single editor button based
on the entries of the EditorButtonAlwaysEnabled,
EditorButtonEnabledForUpdate, EditorButtonEnabledForAdd and
EditorButtonEnabledOnCopy attributes (SCL-5599)
Notes: Blank or unparsable entries count as not specified. Returns ?
when no entry is specified at all, so the button inherits the
enabledState of its host field. EditorButtonAlwaysEnabled = yes
wins over the other three attributes. When at least one entry is
specified but none of them is yes, "none" is returned, mirroring
the field-level enabledState behaviour

Parameters:
pcAlwaysEnabled CHARACTER
The EditorButtonAlwaysEnabled entry for the button
pcEnabledForUpdate CHARACTER
The EditorButtonEnabledForUpdate entry for the button
pcEnabledForAdd CHARACTER
The EditorButtonEnabledForAdd entry for the button
pcEnabledOnCopy CHARACTER
The EditorButtonEnabledOnCopy entry for the button
Returns CHARACTER
The enabledState value or ? when no entry is specified


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:20:29