Namespace: Consultingwerk.CommonUi
Class 
UiControl Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.JsonSerializable
Consultingwerk.ParameterObject
Consultingwerk.CommonUi.UiControl

Inherits: Consultingwerk.ParameterObject
Implements: Consultingwerk.IJsonSerializable


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



Top Method Summary
Options Name Purpose
DeserializeProperty (JsonObject, character, character, character) Deserializes a single property value from the JsonObject
Consultingwerk.CommonUi.FieldControl FieldControl (character) Returns the FieldControl instance for the given field name
SerializeProperty (JsonObject, character, character, character) Serializes a single property value into the JsonObject

Top Constructor Summary
Options Name Purpose
UiControl () Constructor for the UiControl class
UiControl (EventHandlerParameter) Constructor for the UiControl class
UiControl (IEventHandlerParameter) Constructor for the UiControl class accepting any of the event-specific EventHandlerParameter interfaces.
UiControl (ListInputPrompt) Constructor for the UiControl class
UiControl (ListQuestion) Constructor for the UiControl class
UiControl (ListQuestion, ListInputPrompt) Constructor for the UiControl class

Top Property Summary
Options Name Purpose
LOGICAL Cancel
Consultingwerk.CommonUi.ListFieldControl FieldControls
CHARACTER FocusFieldName
Progress.Lang.Object FormContext
Consultingwerk.Framework.MessageInteraction.ListInputPrompt InputPrompts
Consultingwerk.OERA.ValidationMessages.ListValidationMessage Messages
Consultingwerk.CommonUi.MethodCallParameter MethodCall
Consultingwerk.CommonUi.ListNotification Notifications
Consultingwerk.Framework.MessageInteraction.ListQuestion Questions
Consultingwerk.CommonUi.ListUiAction UiActions
Consultingwerk.CommonUi.UnboundValues UnboundValues


Method Detail
Top

DeserializeProperty (JsonObject, character, character, character)
Purpose: Deserializes a single property value from the JsonObject
Notes: SCL-5618 - counterpart of the SerializeProperty override

Parameters:
poJsonObject Progress.Json.ObjectModel.JsonObject
The reference to the source JsonObject
pcProperty CHARACTER
The name of the property in this class
pcJsonProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
Top

Consultingwerk.CommonUi.FieldControl FieldControl (character)
Purpose: Returns the FieldControl instance for the given field name
Notes: Either creates a new instance in the list or returns the existing one

Parameters:
pcFieldName CHARACTER
The name of the field
Returns Consultingwerk.CommonUi.FieldControl
The FieldControl instance
Top

SerializeProperty (JsonObject, character, character, character)
Purpose: Serializes a single property value into the JsonObject
Notes: SCL-5618 - the generic serializer treats the UnboundValues
dictionary as a plain IEnumerable and would emit an array of
holder objects, losing the keys. The dictionary emits itself as
a JsonObject with one plain JSON value per entry instead.

Parameters:
poJsonObject Progress.Json.ObjectModel.JsonObject
The reference to the target JsonObject
pcProperty CHARACTER
The name of the property in this class
pcJsonProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property


Constructor Detail
Top

UiControl ()
Purpose: Constructor for the UiControl class
Notes:

Top

UiControl (EventHandlerParameter)
Purpose: Constructor for the UiControl class
Notes:

Parameters:
poEventHandlerParameter Consultingwerk.CommonUi.EventHandlerParameter
The EventHandlerParameter instance
Top

UiControl (IEventHandlerParameter)
Purpose: Constructor for the UiControl class accepting any of the
event-specific EventHandlerParameter interfaces.
Notes: SCL-5263 - allows SSEH backend methods that declare their
parameter as an I<EventName>EventHandlerParameter (e.g.
IClickEventHandlerParameter, IFormClosingEventHandlerParameter)
to still build the UiControl directly from the parameter,
carrying any unanswered Questions / InputPrompts across the
round-trip.

Parameters:
poEventHandlerParameter Consultingwerk.CommonUi.IEventHandlerParameter
The IEventHandlerParameter instance
Top

UiControl (ListInputPrompt)
Purpose: Constructor for the UiControl class
Notes:

Parameters:
poInputPrompts Consultingwerk.Framework.MessageInteraction.ListInputPrompt
The List of input prompts
Top

UiControl (ListQuestion)
Purpose: Constructor for the UiControl class
Notes:

Parameters:
poQuestions Consultingwerk.Framework.MessageInteraction.ListQuestion
The List of questions
Top

UiControl (ListQuestion, ListInputPrompt)
Purpose: Constructor for the UiControl class
Notes:

Parameters:
poQuestions Consultingwerk.Framework.MessageInteraction.ListQuestion
The List of questions
poInputPrompts Consultingwerk.Framework.MessageInteraction.ListInputPrompt
The List of input prompts


Property Detail
Top

LOGICAL Cancel

Returns LOGICAL
Top

Consultingwerk.CommonUi.ListFieldControl FieldControls

Returns Consultingwerk.CommonUi.ListFieldControl
Top

CHARACTER FocusFieldName

Returns CHARACTER
Top

Progress.Lang.Object FormContext

Returns Progress.Lang.Object
Top

Consultingwerk.Framework.MessageInteraction.ListInputPrompt InputPrompts

Returns Consultingwerk.Framework.MessageInteraction.ListInputPrompt
Top

Consultingwerk.OERA.ValidationMessages.ListValidationMessage Messages

Returns Consultingwerk.OERA.ValidationMessages.ListValidationMessage
Top

Consultingwerk.CommonUi.MethodCallParameter MethodCall

Returns Consultingwerk.CommonUi.MethodCallParameter
Top

Consultingwerk.CommonUi.ListNotification Notifications

Returns Consultingwerk.CommonUi.ListNotification
Top

Consultingwerk.Framework.MessageInteraction.ListQuestion Questions

Returns Consultingwerk.Framework.MessageInteraction.ListQuestion
Top

Consultingwerk.CommonUi.ListUiAction UiActions

Returns Consultingwerk.CommonUi.ListUiAction
Top

Consultingwerk.CommonUi.UnboundValues UnboundValues

Returns Consultingwerk.CommonUi.UnboundValues


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       16.08.2026 16:55:41