skip to main content
OpenEdge Development: ADM Reference
Container Objects and Their Methods and Properties : Container object properties
 
Container object properties
Container Object properties provide information about container objects and their classes. This information can include whether an object is enabled, the contents of the object and so on. You can read property values and in many instances you can change property values. To read a property value, you use a get function, and to change a property value, you use a set function.
These functions conform to the following conventions:
*get — Uses the form getpropname and returns the current value of the property.
Note: This function accepts no arguments.
*set — Uses the form setpropname. The set function accepts a single argument—the new value for the property—and returns TRUE/FALSE depending on whether the value change succeeds.
For more information about getting and setting property values, see Chapter 1, “ADM2 SmartObject API Reference”, OpenEdge Development: Progress Dynamics Basic Development, and OpenEdge Development: Progress Dynamics Advanced Development.
BlockDataAvailable
Controls whether or not DataAvailable messages from contained SDOs are to be ignored and not republished. If TRUE, DataAvailable messages are to be ignored and not republished.
Data type: LOGICAL
Note: Read and Write
CallerObject
Value of CallerObject.
Data type: HANDLE
Note: Read and Write
CallerProcedure
Value of CallerProcedure.
Data type: HANDLE
Note: Read and Write
CallerWindow
Value of CallerWindow.
Data type: HANDLE
Note: Read and Write
CascadeOnBrowse
Determines whether data is retrieved from a dependent SDO if the parent SDO has more than one row in its current result set. If TRUE (the default), data is retrieved for the first row in the parent result set, otherwise not.
Data type: LOGICAL
Note: Read and Write
CommitSource
Used for pass-through for regular containers, but also inherited by the SBO, which uses it generally.
Data type: HANDLE
Note: Read and Write
CommitSourceEvents
Represents the list of events to be subscribed to in the Commit Panel or other Commit-Source.
Data type: CHARACTER
Notes:  
*Read and Write.
*Commit is a pass-through link, but the SBO uses it for real.
*This property is here because the link and event properties are kept together.
CommitTarget
List in character format the handles of this object’s Commit-Targets.
Data type: CHARACTER
Note: Read and Write
CommitTargetEvents
List of events to be subscribed to in the Commit Panel or other Commit-Target.
Data type: CHARACTER
Note: Read and Write
ContainedDataColumns
Delimited list of all the DataColumns of all the Data Objects in this SBO.
Data type: CHARACTER
Note: Read and Write
ContainedDataObjects
List of the handles of the Data Objects contained in this container object.
Data type: CHARACTER
Notes:  
*Read and Write
*The container class uses this property to keep track of the data objects for the stateless server side.
*The SmartBusinessObject (SBO) class uses this property on both the client and server for most logic and at design time to get names and column lists from the individual data objects.
ContainerTarget
List of the handles of the object’s contained objects.
Data type: CHARACTER
Note: Read and Write
ContainerTargetEvents
Comma-separated list of the events this object wants to subscribe to in its ContainerTarget.
Data type: CHARACTER
Note: Read only
ContextAndInitialize
Resets context and initializes this server-side object. Called from a stateless client before a request.
Data type: CHARACTER
Note: Write only
CurrentPage
Current page number of the Container.
Data type: INTEGER
Note: Read and Write
DataHandle
Handle of the RowObject query for the SBO.
Data type: HANDLE
Note: Read only
DataObjectNames
Ordered list of ObjectNames of contained SDOs.
Data type: CHARACTER
Notes:  
*Read and Write.
*This property is normally changed through the SBO Instance Property dialog. It should not be changed until after the Objectnames for the SDOs within the SBO have been set.
*Used to check whether the value is still valid, which might not be the case if objects have been removed, added, or replaced since the SBO was last saved.
*If this list no longer matches the list of contained SDOs, then it is blank and a default list is created again.
DataObjectOrdering
Mapping of the order of Update Tables as generated by AppBuilder to the developer-defined update order.
Data type: CHARACTER
Note: Write only
DataQueryBrowsed
DataQueryBrowsed value after mapping the requesting Browser (or other such client object) to the SDO whose query it is browsing.
Data type: LOGICAL
Note: Read and Write
DynamicSDOProcedure
Name of the dynamic SmartDataObject (SDO) procedure. That is adm/dyndata.w by default, but it can be modified if the dynamic SDO is customized.
Data type: CHARACTER
Note: Read and Write
FetchOnOpen
Provides a consistent interface for all Data Objects.
Data type: CHARACTER
Note: Read and Write
FilterSource
Represents the Filter Source for pass-through support.
Data type: HANDLE
Note: Read and Write
InitialPageList
Comma-delimited list of pages to construct at startup, or * to indicate all pages must be initialized at startup.
Data type: CHARACTER
Note: Read and Write
InMessageTarget
Value of InMessageTarget.
Data type: HANDLE
Note: Write only
InstanceNames
Property that provides an ordered list of ObjectNames of ContainerTargets.
Data type: CHARACTER
Notes:  
*Read and Write.
*This property is used to enforce unique instance names in the container and is updated in constructObject and destroyObject along with the container link.
*This property allows containedProperties and assignContainedProperties to work together.
LastCommitErrorKeys
Property that provides information about records that failed during the last data commit. For:
*SmartDataObjects (SDOs) —A comma-delimited list of the key values of the records that failed to be committed. The KeyFields property of the SDO holds the key field names.
*SmartBusinessObjects (SBOs) — A semicolon-delimited list of the values of each individual contained SDO that has failed records.
Data type: CHARACTER
Notes:  
*Read and Write.
*A blank indicates that the last commit was successful.
LastCommitErrorType
Property that identifies the type of error encountered the last time data was committed:
*Blank — The last commit was successful.
*Unknown — A commit was not attempted after run.
*Conflict —A locking conflict occurred.
*Error — An unspecified error occurred.
Data type: CHARACTER
Notes:  
*Read and Write.
*Currently used to identify a Conflict error when using the UpdateData procedure. See Update Data for additional information.
MasterDataObject
Handle of the SmartDataObject (SDO) that has no data source of its own and is the parent to other SDOs.
Data type: HANDLE
Note: Read only
MultiInstanceActivated
Value of MultiInstanceActivated.
Data type: LOGICAL
Note: Read and Write
MultiInstanceSupported
Value of MultiInstanceSupported.
Data type: LOGICAL
Note: Read and Write
NavigationSource
Comma-separated list of strings for Navigation sources. Used for pass-thru for regular containers, but also inherited by the SBO that actually uses it.
Data type: CHARACTER
Note: Read and Write
NavigationSourceEvents
List of events to be subscribed to in the Navigation Panel or other Navigation-Source.
Data type: CHARACTER
Note: Read and Write
NavigationTarget
Value of NavigationTarget.
Data type: HANDLE
Note: Read and Write
ObjectMapping
List of handles of Navigation-Source objects (panels) or other objects that are mapped to contained Data Objects, and the SDOs the SBO has connected them up to, according to their NavigationTargetName property or setCurrentMappedObject request.
Data type: CHARACTER
Note: Read and Write
OutMessageTarget
Out message target for Pass-through support.
Data type: HANDLE
Note: Read and Write
PageNTarget
List of objects that are on some page other than 0. The list items are of the form handle|pagenum. Use addLink rather than editing them by hand.
Data type: CHARACTER
Note: Read and Write
PageSource
Handle of the object’s folder, if any.
Data type: HANDLE
Note: Read and Write
PrimarySdoTarget
Value of PrimarySdoTarget.
Data type: HANDLE
Note: Read and Write
QueryPosition
For SBOs, indicates whether the requester is the target-procedure or the source-procedure, and whether the MasterDataObject is involved, and identifies the SDO to which the caller is mapped.
Data type: CHARACTER
Note: Read and Write
RouterTarget
Value of RouterTarget.
Data type: CHARACTER
Note: Read and Write
RowObjectState
Signals whether there are uncommitted updates in the object. Valid return values are NoUpdates and RowUpdated.
Data type: CHARACTER
Note: Read and Write
RunDataLogicProxy
Property that provides user control over which Data Logic Procedure (DLP) file to run.
Data type: LOGICAL
Notes:  
*Read and Write.
*The default value is Unknown. When the default value is used, which DLP file to run is determined by a search process that depends on the client type and whether the file can be found. The following describes the search process for a DLP file with the name myDLP.p:
*For WebClients, run myDLP_cl.p and automatically download the DLP file if necessary.
*For GUI clients, determine whether any databases are connected. If yes, search for myDLP.r. If found, verify that all required databases are connected and if they are connected, run myDLP.p. If myDLP.p cannot be found and run using this search criteria, then do the following:
Search for myDLP_cl.r. If myDLP_cl.r is found, then run myDLP_cl.p. If myDLP_cl.r is not found, then search for myDLP_cl.p. If myDLP_cl.p is found, run the file. If myDLP_cl.p is not found, a cannot find myDLP_cl.p error message displays.
*For both GUI clients and WebClient, if the selected DLP file fails to run, the SmartDataObject (SDO) does not start and an error message displays.
*If an appropriate DLP file is not found, an error message displays under the following conditions:
*RunDataLogicProxy=TRUE.
*Session:ClientType=WebClient.
*All required databases are not connected.
*A TRUE value forces the DLP proxy to run so that it can be downloaded automatically in a WebClient environment.
*A FALSE value starts the data object without the DLP.
*For related information, see the “RunDOOptions” section.
RunDOOptions
Comma-separated list of options that determine how Data Objects are run from constructObject. The available options are:
*dynamicOnly — Run the Progress Dynamics client proxy SDO specified in the DynamicSDOProcedure property. By default, this is adm2/dyndata.w. When you select this option, no other version of the data object will be run.
*sourceSearch — Search for and run the actual source object. If it is not available or the required databases are not connected, use the clientOnly option.
*clientOnly — Do not locate or run the actual object file (sdo-name.w). Instead, locate the static client file (*_cl.w) and run it. If this file is not available, run the Progress Dynamics client proxy.
*StaticClientOnly — This option is similar to the clientOnly option, except that the Progress Dynamics client proxy (dyndata.w) is not run if the static client (*_cl.w) is not available. This option takes precedence over the dynamicOnly option when there is a conflict.
Data type: CHARACTER
Notes:  
*Read and Write.
*The StaticClientOnly option is useful in a WebClient session when you do not want to run the Progress Dynamics client proxy and the static client does not reside on the client. Under those conditions, selecting the StaticClientOnly option forces an automatic WebClient download of the static client (*_cl).
*If dynamicOnly, clientOnly, or both of these options are specified, the Data Object must have an AppServer partition defined. If an AppServer partition is not defined, and dynamicOnly, clientOnly, or both options are specified, you will experience the same errors that occur when the Data Object is running on an AppServer that has not been started.
*To run source code when no rcode is found, you must customized containr.p by setting RunDOOptions to sourceSearch in constructObject.
SdoForeignFields
Value of SdoForeignFields.
Data type: CHARACTER
Note: Read and Write
TopOnly
Indicates whether or not to get the window top only (toggle).
Data type: LOGICAL
Note: Read and Write
UpdateActive
Indicates whether any contained objects have active updates. TRUE if ANY of the contained objects have active updates.
Data type: LOGICAL
Note: Read and Write
UpdateSource
Used for pass-through links to connect an object inside the container with an object outside the container. It is CHARACTER because at least one type of container (SBO) supports multiple update sources.
Handle of the object’s update-source.
Data type: CHARACTER
Note: Read and Write
WaitForObject
Handle of the object (most likely a SmartConsumer) in the container that contains a wait-for that needs to be started with startWaitFor.
Data type: HANDLE
Notes: Read and Write
WindowFrameHandle
Handle of the optional Frame widget of a Window container.
Data type: HANDLE
Notes:  
*Read and Write.
*This property only identifies the frame of a window container. This is not the same as ContainerHandle, which is the widget handle of the container in all object. In most cases the ContainerHandle is also the Frame handle for a SmartContainer.
*Even if Window containers do not need a frame they often have one and in that case we must include it when, for example, resizing, widget-tree logic, and so on.