skip to main content
OpenEdge Development: ADM Reference
SmartObjects and Their Methods and Properties : SmartObject properties
 
SmartObject properties
SmartObject properties provide information about SmartObject 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 value for a property, you use a get function, and to change a value for a property, 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.”
This section lists and describes the SmartObject properties that you can use with the get and set functions. The description also identifies the properties for which you can read and write (change) a value and the properties for which you can only read the value.
AppService
Logical partition name of the stored AppService used to connect to an AppServer. This value identifies the AppService in which the SmartDataObject is to be started.
Data type: CHARACTER
Note: Read and Write
ASBound
Indicates whether this object binds the AppServer with a persistently running procedure: usually the server part of this object. If the object binds the AppServer with a persistently running procedure, the value for this property is TRUE.
Data type: LOGICAL
Note: Read only
AsDivision
A string indicating whether the object is running on the client side or the server side of the AppServer. If this value is an empty string, there is no AppServer.
Data type: CHARACTER
Note: Read and Write
ASHandle
Handle of the persistent procedure to this object’s companion procedure (the copy of itself) running on the AppServer.
Data type: HANDLE
Note: Read and Write
ASHasStarted
Indicates where the object has completed its first call to its server-side object. This value is TRUE if the object has completed its first call.
Data type: LOGICAL
Note: Read only
ASInitializeOnRun
Indicates whether runServerObject should call initializeServerObject. initializeServerObject is called on the client, but usually has a call to the server for context. This value is TRUE if runServerObject should call initializeServerObject.
Data type: LOGICAL
Note: Read and Write
ChildDataKey
When a program is run for a specific record, that is a specific customer, ChildDataKey would record that this instance of the object is for this specific piece of child data, and the key would represent the key passed into the object.
Then, when selecting a record in an object controller, you can use this key to determine if an object containing data for the selected key is already open. If that is the case, that window can be brought to the top.
Data type: CHARACTER
Notes:  
*Read and Write.
*Used in a Progress Dynamics environment by the Session Manager when it is keeping track of the running instance of programs.
*Use this property when multiple windows are supported, and you do not want to bring up two windows containing the same child data.
*ChildDataKey is an input parameter to the launch container API.
ContainerHandle
Though available for all SmartObjects, this property is most meaningful for SmartObjects that have a window or frame. For a frame-based object, such as a Browser or Viewer, this property returns frame. For a window-based objects such as a SmartWindow, this property returns the window handle. You can use this information when you need to query or manipulate the properties of the container widget itself.
Data type: HANDLE
Note: Read only
ContainerHidden
Indicates whether or not an object’s SmartContainer: SmartWindow, SmartFrame and so on, is hidden. Returns TRUE if the container is hidden.
Data type: LOGICAL
Note: Read and Write
ContainerSource
Handle of the object that should become the Container-Source.
Data type: HANDLE
Note: Read and Write
ContainerSourceEvents
Comma-separated list of the events to which this object wants to subscribe to in its ContainerSource.
Data type: CHARACTER
Note: Read and Write
ContainerType
Type of container this SmartObject is (Window or Frame), or the empty string if the object is not a container.
Data type: CHARACTER
Note: Read only
DataLinksEnabled
Indicates whether or not data links are enabled.
Data type: LOGICAL
Note: Read and Write
DataSource
Object's data source, if any.
Data type: HANDLE
Note: Read and Write
DataSourceEvents
Comma-separated list of the events this object wants to subscribe to in its data source.
Data type: CHARACTER
Note: Read and Write
DataSourceNames
ObjectName of the Data Object that sends data to this visual object. This would be set if the data source is an SmartBusinessObject (SBO) or other Container with DataObjects.
Data type: CHARACTER
Note: Read and Write
DataTarget
Handle in character format, or a comma-separated list of handles for the case of multiple data targets.
Data type: CHARACTER
Note: Read and Write
DataTargetEvents
List of events this object class should be subscribed to in its data targets.
Data type: CHARACTER
Note: Read and Write
DBAware
Value of DBAware. TRUE if this object is dependent on being connected to a database. This allows some code, for example in data objects, to execute two different ways.
Data type: LOGICAL
Note: Read and Write
inactiveLinks
Comma-separated paired list of inactive links. The second entry of each pair is a semicolon- separated list of object handles.
Data type: Logical
Notes:  
*Read and Write.
*modifyInactiveLinks should be used to maintain this property.
*isLinklnactive should be used to check if an actual link is inactive.
InstanceProperties
A list of the ADM instance properties of the SmartObject. Instance properties are those properties that can be set at design time for initialization as part of startup.
Data type: CHARACTER
Note: Read and Write
LogicalObjectName
Value of LogicalObjectName.
Data type: CHARACTER
Note: Read and Write
LogicalVersion
Version number of the object name as stored in the Progress Dynamics Repository. This value is read from the rym_data_version table which keeps a record of all repository object versions for version managed data, for example, ryc_smartobject objects.
Data type: CHARACTER
Note: Read and Write
ObjectHidden
Flag indicating whether or not the current object is hidden. Before checking ObjectHidden, the routine examines the parent state in ContainerHidden. If ContainerHidden is TRUE, there is no need to examine ObjectHidden, and the function immediately returns TRUE. Note that hidden is a logical concept in the ADM. A nonvisual object can be hidden to indicate that it is not currently active in some way, because it is a Container-Target of some visual object that is hidden.
Data type: LOGICAL
Note: Read and Write
ObjectInitialized
Flag indicating whether this object has been initialized. TRUE if this object has been initialized.
Data type: LOGICAL
Note: Read only
ObjectName
Name of the object that can be the filename or some other designation meaningful to the repository and other objects.
Data type: CHARACTER
Note: Read and Write
ObjectPage
Logical page on which this object has been placed.
Data type: INTEGER
Note: Read only
ObjectParent
Widget handle of this object's Window or Frame parent, that is, the handle of the visual container of its CONTAINER-SOURCE.
Data type: HANDLE
Note: Read and Write
ObjectType
Type of the SmartObject, such as SmartDataObject and so on. If this is a super procedure, SUPER is returned.
Data type: CHARACTER
Note: Read only
ObjectVersion
ADM version of the SmartObject.
Data type: CHARACTER
Note: Read and Write
ParentDataKey
ParentData Key.
Data type: CHARACTER
Note: Read and Write
PassThroughLinks
List of link types that can be pass-through links. Used by addLink. This property is shared by all objects should normally be modified using modifyListProperty.
Data type: CHARACTER
Note: Read and Write
PhysicalObjectName
The name of the physical file run to instantiate either a static or Progress Dynamics object.
Static objects have only a physical object name. Progress Dynamics objects have a logical object name which is the name of the repository object, and a physical object name which is the name of the rendering object used to build the Progress Dynamics object. For example, a dynamic browser could have a logical object name of customerbrowse and a physical object name of rydynbrowb.w.
Data type: CHARACTER
Notes:  
*Read and Write.
*This property includes the file extension but does not include the path for the file name.
*This property is set internally and should not be changed by application code.
PhysicalVersion
Version number of the physical object. This number is displayed in the Help About message dialog box. The version number for all Progress Dynamics objects are created using the standard templates.
If Roundtable is being used, this version number is automatically updated to match the version number that is in Roundtable for the object. If Roundtable is not being used, you must manually update this version number.
Data type: CHARACTER
Note: Read and Write
PropertyDialog
Name of the dialog procedure that sets InstanceProperties.
Data type: CHARACTER
Note: Read only
QueryObject
Flag that indicates whether this object manages its own database query.
Data type: LOGICAL
Note: Read only
RunAttribute
Property that maps to attributes set up in the gsc_instance_attribute table in the Progress Dynamics Repository. Use this property to change the behavior of generic objects. For example, If you have a generic object that you want to behave differently for a creditors system and a debtors system. you can use this property to determine the functionality for the specific instance of the generic object. That is, is the object being used in the creditors system or the debtors system.
Data type: CHARACTER
Notes:  
*Read and Write.
*The mapped value is used for the container and all contained objects.
*The property is posted to the program using either the menu option the program was run from or coded in a program if the program was run from a button and so on. As a result, some of these properties are owned by the system and cannot be maintained or deleted by users.
*When security is applied, for example field-level security, they can be defined globally, for a specific product, product module or to an individual program level. The RunAttribute property is a level below the program level that permits security settings per instance of a program.
ServerFileName
Property representing the actual server-side SDO filename to run on the AppServer. This value might not be the ObjectName if that has been modified.
Data type: CHARACTER
Note: Read and Write
ServerOperatingMode
A string representing the connection state. Valid values are stateless, state-reset, state-aware, or none (no AppServer connection).
Data type: CHARACTER
Note: Read and Write
SupportedLinks
Comma-separated list of the SmartObject links supported by this object.
Data type: CHARACTER
Note: Read and Write
TranslatableProperties
List of properties that should not have a :U following their literal values when code is generated in adm-create-objects. Because this is a comma-separated list, it should normally be invoked indirectly through modifyListAttribute.
Data type: CHARACTER
Note: Read and Write
UIBMode
Indicates whether an object is in Design mode in AppBuilder (AppBuilder was originally called User-interface Builder). This value is blank if the object is not in design mode, that is, not running in an AppBuilder design window. This value is Design if the object is in design mode, or Design-Child if it is contained in another SmartObject that is in design mode, such as a SmartFrame. This value is the Unknown value (?) if the object is not a SmartObject and does not have a valid handle in ADM-DATA.
Data type: CHARACTER
Note: Read and Write
UseRepository
Indicates whether the repository is running and available. If this value is TRUE, then Progress Dynamics is running and the Repository is available.
Data type: LOGICAL
Note: Read only
UserProperty
Dynamically defined property.
Data type:  
Notes:  
*Write only.
*You cannot set or get user-defined properties in an application running in n-tier (client and AppServer) mode.