Progress
ADM 2 Reference
List Of Public Properties By Name
Except as noted, these properties can all be read/written using either the corresponding get/set function or the {get}/{set} pseudo-function syntax.
NOTE: At present, the filesactiprop.i
andviewprop.i
have no Progress-defined properties in them. The filedesiprop.i
is a template properties file, supplied as a convenience to you; you can use it when defining a new type of object.The last four columns in each table are described as follows:
- X — If marked, an xppropname token has been defined, allowing use of the {get}/{set} pseudo-functions. This syntax should be used from within SmartObjects.
- G — If marked, a conventional getpropname function has been defined. Use these functions in non-Smart code.
- S — If marked, a conventional setpropname function has been defined. Use these functions in non-Smart code.
- I — If checked, this is an instance property.
- Initial value "One-Record".
- The set function is defined in
pupdsav.w
.- Because the SBO (SmartBusinessObject) is designed to integrate many SDOs (SmartDataObjects), most SDO properties have counterparts in the SBO.
- The Division property. Possible values are
"
Client"
,"
Server"
,"
Both"
, or the empty string.- Identifies where the caller is running. Possible values are
"
Client"
,"
Server"
, or the empty string meaning the application is not distributed.- The handle of the copy running on the AppServer. This is the persistent procedure handle, used when invoking procedures and functions.
- The string, if any, used as a parameter during connection to the AppService.
- The list of updatable columns whose names have been modified in the SDO.
- TRUE if the supporting code should prompt for a username/password when connecting to the AppService.
- TRUE if updates automatically commit. If the SDO is in an SBO, this property is set to FALSE.
- A set function exists in
query.p
also, though the property is not declared inqryprop.i
. That set function is overridden by the set function indataext.p
.- Defaults to FALSE. When set to TRUE, updates automatically commit.
- Property declared, but not currently in use.
- Actions available in the calling Toolbar object. This list and the list in the AvailToobarActions property are displayed in the instance-properties dialog box. The selected actions are saved as ActionGroups.
Table 3: Public Properties By Name: B PropertyName DataType Declaredin X G S I BoxRectangle 1 BrowseFields 2 BrowseTitle 2- The handle of the rectangle, if any, that provides the visual border of a SmartPanel.
- Information to be displayed when the ViewAs property is BROWSE.
Table 4: Public Properties By Name: C PropertyName DataType Declaredin X G S I CancelBrowseOnExit 1 CascadeOnBrowse 2 ChangedEvent 3 CheckCurrentChanged 4 CheckLastOnOpen 5 ClientID 6 CommitSourceEvents 7 CommitSourceEvents 7 CommitTarget 8 CommitTargetEvents 7 ContainedDataColumns 9 ContainedDataObjects 10 ContainerHandle 11 ContainerType 12 CreateHandles 13 CurrentMessageId 14- Set to TRUE if the value in the browse is not to be selected on exit. Should be TRUE when ExitBrowseOnAction is TRUE because if the user exits the browse with a value selected, the Close button can function as a Cancel.
- Determines whether data will be retrieved from a dependent SDO when the parent SDO has more than one row in its current dataset. Defaults to TRUE.
- Optional event to publish on value-changed. Be sure to define the corresponding SUBSCRIBE in the container.
- TRUE if the SDO should determine whether the record being updated has changed by some other object.
- TRUE if a get-last should be performed. See the code for detailed information.
- Declared in
messprop.i
; defined as an instance property inconsprop.i
andprodprop.i
.- The list of events in the respective SOURCE or TARGET object to which this object subscribes.
- Separate get and set functions are defined in
pcommit.w
and intoolbar.p
. None are defined inpanel.p
.- An inclusive list of all the columns being served by all the SDOs in this SBO. Columns for an SDO are comma-delimited. Columns belonging to different SDOs are separated by a semicolon. The groups of columns are in the same order as the SDOs listed in the ContainedDataObjects property.
- A list of handles to all SDOs in this SBO.
- Handle of the caller’s parent container widget (window or frame).
- Identifies the caller’s container type. Possible values are
"
Window"
,"
Frame"
, or the empty string if the caller is not a container.- A list of handles to the fields that should be enabled for an Add or Copy operation on a record.
- The ID from the last sendMessage with ReplyRequired set.
Table 5: Public Properties By Name: D PropertyName DataType Declaredin X G S I DataColumns 1 DataColumnsByTable2 DataModified 4 DataObjectNames 5 DataObjectOrdering 6 DataQueryBrowsed 7 DataSourceEvents 8 DataSourceFilter 9 DataTarget 10 DataTargetEvents 8 DBAware 11 DefineAnyKeyTrigger 12 DisplayedField 13 DisplayedFields 14 DisplayValue 15 Domain 16- An inclusive list of all the columns being served by all the SDOs in this SBO, each qualified by the ObjectName of its SDO. Columns are comma-delimited. This is the same information stored in the ContainedDataColumns property, but organized differently.
- Comma-delimited list of all column names in the SDO. The get/set functions have truncated names: getDataColumns/setDataColumns.
- Returns the handle of the appropriate RowObject query.
- Indicates whether there is an unsaved modification to some SCREEN-VALUE. A set function is also defined in
browser.p
.- The ordered list of ObjectNames of contained SDOs. This property is not normally changed under program control.
- The mapping of the programmer-defined update order onto the AppBuilder-defined Update Tables.
- TRUE if this SDO’s data stream is already assigned to a browser. Essentially a lock to prevent conflicts.
- A list of the events in the respective SOURCE or TARGET to which this object subscribes. See notes in the code header for additional details.
- Optional filter expression to be applied to the DATA-SOURCE.
- Typically used in connection with pass-through links.
- TRUE if the object requires a local database connection.
- TRUE if a persistent trigger defined on ANY-KEY. Only used for a fill-in generated for the view-as-browse option.
- Field being displayed in the selection
- Comma-separated list of the columns being displayed by the data-display object.
- Returns the value displayed by the SmartSelect. This is not necessarily the same as the value to be stored.
- Storage declared, xp token, and get/set defined in
messprop.i
, but defined as instance property inconsprop.i
andprodprop.i
.
Table 6: Public Properties By Name: E PropertyName DataType Declaredin X G S I EnabledFields1 EnabledHandles2 EnabledObjFlds3 EnabledObjHdls4 ExitBrowseOnAction5- Returns the list of enabled fields in the display object that have counterparts in the SDO’s data stream.
- The handles are to the enabled fields in the display object.
- The fields in this list are not associated with data fields.
- The handles are to widgets not associated with data fields.
- TRUE if selecting a value in the browse exits the browse. Triggered by DEFAULT-ACTION (RETURN or double-click).
Table 7: Public Properties By Name: F PropertyName DataType Declaredin X G S I FirstRowNum1 FlatButtons2 ForeignFields3 ForeignValues4 Format5- Temp-table first-row number.
- Not currently in use.
- Comma-separated list of pairs: local database field name, source temp-table field name, local database field name, source.... Used for opening dependent queries.
- CHR(1)-separated, formatted strings representing the most received foreign-field values.
- Overridden format, used when view-as is BROWSE and data displayed as fill-in.
Table 8: Public Properties By Name: G PropertyName DataType Declaredin X G S I GroupAssignSourceEvents1 GroupAssignTargetEvents1- Comma-separated list of events to which this object subscribes in the respective source/target.
Table 10: Public Properties By Name: I PropertyName DataType Declaredin X G S I ImagePath1
- Path to the image within the file system.
Table 13: Public Properties By Name: L PropertyName DataType Declaredin X G S I Label1- The label string if defined locally, "?" if defined in the data source, or the empty string if not defined.
Table 14: Public Properties By Name: M PropertyName DataType Declaredin X G S I MasterDataObject1 Menu2- The master data object is the SDO whose changes control behavior in other SDOs.
- TRUE if the menu component is active.
Table 15: Public Properties By Name: N PropertyName DataType Declaredin X G S I NavigationSourceEvents1 NavigationSourceEvents1 NavigationTargetEvents1 NewRecord2- Comma-separated list of the events to which this object subscribes in the respective source/target.
- Possible values:
"
Add"
,"
Copy"
, and"
No"
.
Table 16: Public Properties By Name: O PropertyName DataType Declaredin X G S I ObjectHidden1 ObjectMapping2 ObjectVersion3 OpenQuery4 OptionalBlank5- The state HIDDEN is a logical rather than visual state; it can be applied to a nonvisible object to indicate it is, for example, inactive.
- Intended for internal-use only. Comma-separated list of handle pairs in the form sourceA,targetA,sourceB,targetB,.... The source is an SDO inside the SBO; the target is the object that serves as its DATA-TARGET and, possibly, its UPDATE-SOURCE.
- A string representing the ADM version. For Version 9 and later objects, the string will be
"
ADM2.0"
or later.- Original WHERE clause set at design time, set as the value of the OPEN-QUERY macro. By using this value as the argument to Query-Prepare, run-time modifications made under program control can be discarded.
- TRUE if the character field evaluates to BLANK.
Table 17: Public Properties By Name: P PropertyName DataType Declaredin X G S I PageNTarget1 PanelType2 PropertyDialog3- The list of all objects not assigned to Page 0. Do not manipulate this property by hand, as it has a special format. Call addLink instead.
- Valid values:
"
UPDATE"
,"
NAVIGATION"
.- Identifies the dialog procedure that sets instance properties. Normally only used internally.
Table 18: Public Properties By Name: Q PropertyName DataType Declaredin X G S I QueryObject1 QueryPosition2- TRUE if the object manages a local query. Note that local queries are deprecated except in objects, such as the SDO, dedicated to data access.
- Valid values are "FirstRecord",
"
LastRecord"
,"
NotFirstOrLast"
,"
OnlyRecord"
, and"
NoRecordAvailable"
.
Table 19: Public Properties By Name: R PropertyName DataType Declaredin X G S I RebuildOnRepos1 RepositionDataSource2 RowIdent3 RowObject4 RowObjectState5 RowObjectState5 RowObjUpdTable6- TRUE if the RowObject temp-table should be rebuilt whenever an attempt is made to point at a record outside the current dataset.
- TRUE if the data-source is to be repositioned whenever the object experiences the VALUE-CHANGED event. Not needed for the view-as-browse option. Set this to true when the data-source also serves other objects, if they need to be refreshed when this object experiences VALUE-CHANGED.
- RowIdent for current record in RowObject temp-table. Takes the form of a comma-delimited string composed of the ROWID of the temp-table record followed by the ROWIDs of the records from which the temp-table record was made.
- Handle of the RowObject buffer.
- TRUE if uncommitted updates present. Valid values are
"
NoUpdates"
and"
RowUpdated"
- Handle of buffer where updates are stored.
Table 20: Public Properties By Name: S PropertyName DataType Declaredin X G S I ShowBorder1 StartBrowseKeys2- TRUE if a 3D border should be displayed around buttons and as RULE delimiters.
- List of KeyLabels/KeyFunctions that start the browse if DefineAnyKeyTrigger is TRUE.
Table 21: Public Properties By Name: T PropertyName DataType Declaredin X G S I TableIOSourceEvents1 TableIOTarget2 TableIOTargetEvents1 TableIOType3 Tables4 Toolbar5- Comma-delimited list of events in the respective source/target to which this object subscribes.
- List of handles to this object’s TableIO-Targets.
- List of handles to the object’s TableIO-Targets.
- List of database tables in the QueryObject. Get function defined in both
query.p
anddata.p
.- TRUE if toolbar is to be created.
Table 22: Public Properties By Name: U PropertyName DataType Declaredin X G S I UIBMode1- TRUE if application is under control of AppBuilder (UIB—User-Interface Builder—was an earlier name for AppBuilder). Valid values are
"
Design"
,"
Design-Child"
, and the empty string.
Table 23: Public Properties By Name: V PropertyName DataType Declaredin X G S I ViewAs1- String defining how the SmartSelect is to display. Valid values are
"
Browse"
,"
Selection-list"
,"
Radio-set:H"
,"
Radio-set:V"
,"
Combo-box:Drop-down-List"
(the default), and"
Combo-box:Simple"
.
Copyright © 2004 Progress Software Corporation www.progress.com Voice: (781) 280-4000 Fax: (781) 280-4095 |