Progress
ADM 2 Reference


Properties Glossary

A
ActionEvent

Returns the event to publish on Default-action of the browse. setActionEvent(pcEvent) defines the persistent trigger that runs defaultAction and also subscribes the source-procedure.

ActionGroups

Returns the action groups selected in the Instance Properties.

AddMode

Sets the ADDMode property. If set to TRUE, the assignFields procedure will create a new record.

AllFieldHandles

The pseudo-function {get} returns the allFieldHandles value.

AllFieldNames

The pseudo-function {get} returns the allFieldNames value.

ApplyActionOnExit

Uses the {get} pseudo-function to return the value of ApplyActionOnExit (true if exiting selects the browse row). Currently used by SmartSelect.

ApplyExitOnAction

Currently used by SmartSelect. The logic is not performed in the trigger, but in the defaultAction procedure that gets defined as a persistent DEFAULT-ACTION event when setActionEvent is defined. Local DEFAULT-ACTION events could be set up to run defaultAction.

AppService

1.) Returns the logical partition name of the AppService to be used to connect to an AppServer. This comes from a property, but there is no xp macro defined so as to avoid returning ‘(None)’.

2.) Returns the name of the stored AppService.

3.) Stores the AppService in which the SmartDataObject is to be started. This routine should be called before startDataObject. If the datasource is valid it must be disconnected it if it is connected to a different partition.

ASBound

Returns TRUE if this object binds the AppServer with a persistently running procedure, usually the server part of this object. The AsHandle property can check this.

AsDivision

The {get} pseudo-function returns the value of the ASDivision property. The value is a string indicating which side of the AppServer this Object is running on; client, server, or the empty string (no AppServer).

ASHandle

Returns the handle to this object’s companion procedure (the copy of itself) running on the AppServer. The handle returned is the handle of the persistent procedure, not of the connection.

ASHasStarted

The {get} pseudo-function returns the value of ASHasStarted. This value is TRUE if the object has done its first call to its server-side object. There is no corresponding set function as this must only be set internally.

ASInfo

The {get} pseudo-function returns the value of ASInfo. That value is the string used as a parameter when this object connects to its partition for the first time. The string will be empty if no parameters were passed.

ASInitializeOnRun

The {get} pseudo-function returns the value of ASInitializeOnRun. That value is TRUE if runServerObject should call initializeServerObject

initializeServerObject is called on the client, but will usually have a call to the server to set/retrieve context.

AssignList

The {get} pseudo-function returns the value of AssignList, the list of updatable columns whose names have been modified in the SmartDataObject. This string takes the form: <RowObjectFieldName>,<DBFieldName>[,...][CHR(1)...] with a comma-separated list of pairs of fields for each db table, and CHR(1) between the lists of pairs.

ASUsePrompt

The {get} pseudo-function returns the value of ASUsePrompt. That value is TRUE if the supporting code should prompt for a Username and Password when connecting to its Application Partition.

AsynchronousSDO

The {get} pseudo-function returns the value of AsynchronousSDO.

Attribute

Returns the value of a standard Web-related attribute. The name of the attribute. Possible names are type, version, web–state, web–timeout, web–timeout–handler, web–time–remaining. In addition, other names can be used, provided that the special–get–attribute procedure to handle them exists in the target procedure. For example:

RUN getAttribute ("web-state"). 
cWebState = RETURN-VALUE. 

AutoCommit

The {get} pseudo-function returns the value of AutoCommit. This value determines whether a Commit happens on every record update. This is FALSE by default, but if set to TRUE will do a Commit automatically after any change.

AutoSort

Returns whether the root node should be auto-sorted.

AvailMenuActions

The {get} pseudo-function returns the value of AvailMenuActions, the actions available in this menu.

AvailToolbarActions

The {get} pseudo-function returns the value of AvailToolbarActions, the list of actions available in the menu of this toolbar. The Instance Properties dialog shows these and AvailMenuActions. The actions selected will be saved as ActionGroups.

AvailToolbarBands

Returns a comma-separated list of the available toolbar bands for this toolbar master. Assembles the list by looping through the temp-table.

B
BaseQueryString

The {get} pseudo-function returns the value of BaseQueryString.

BlockDataAvailable

The {get} pseudo-function returns the value of BlockDataAvailable, true if DataAvailable messages from contained SDOs are to be ignored and not republished

BoxRectangle

The {get} pseudo-function returns the value of BoxRectangle. This is the handle to the rectangle, if any, around the buttons in the Panel used by resizeObject.

BoxRectangle2

The {get} pseudo-function returns the value of BoxRectangle2. Used for bottom rectangle on toolbars where ToolbarAutosize is TRUE.

BrowseFieldDataTypes

The {get} pseudo-function returns the value of BrowseFieldDataTypes.

BrowseFieldFormats

The {get} pseudo-function returns the value of BrowseFieldFormats.

BrowseFields

The {get} pseudo-function returns the value of BrowseFields, the list of fields to display in the browse when the viewAs property is set to "browse".

BrowseHandle

The {get} pseudo-function returns the value of BrowseHandle, the handle of the browse control.

BrowseTitle

The {get} pseudo-function returns the value of BrowseTitle, the title to display in the browse SmartWindowContainer when the ViewAs property is set to "browse".

BuildSequence

The {get} pseudo-function returns the value of BuildSequence. A scoped xp macro is defined and undefined specifically for this {get}.

Buffer

Used to create or assign properties for an action.

Buffers

Sets the Buffers property (see webrprop.i), a comma-separated list of database tables (not SmartDataObject) to be retrieved by this object.

ButtonCount

The {get} pseudo-function returns the value of ButtonCount, the number of buttons in a SmartPanel. Used by resizeObject.

Buttons

Used to set buttons according to the current state. It is called from various link targets when they publish some state. Depending on the caller, valid values can be: onlyRecord, disable-nav, first, last, initial-tableio, update, add-only, disable-commit, enable-commit, enable-filter. The NAVIGATION-TARGET publishes queryPosition, the TABLEIO-TARGET publishes updateState, and the COMMIT-TARGET publishes rowObjectState.

C
CalculatedColumns

The {get} pseudo-function to examine the values of DataColumnsByTable and Tables. Returns a comma-delimited list of the calculated columns for the SmartDataObject.

CalcWidth

The {get} pseudo-function returns the value of CalcWidth. That value is the logical value that determines whether the width of the browse is calculated to the exact amount needed for the fields it contains.

CallerObject

The {get} pseudo-function returns the value of CallerObject.

CallerProcedure

The {get} pseudo-function returns the value of CallerProcedure.

CallerWindow

The {get} pseudo-function returns the value of CallerWindow.

CancelBrowseOnExit

The {get} pseudo-function returns the value of CancelBrowseOnExit, TRUE if the value in the browse is NOT to be selected on Exit.

CascadeOnBrowse

The {get} pseudo-function returns the value of CascadeOnBrowse. This determines whether data will be retrieved from a dependent SDO if the parent SDO has more than one row in its current dataset; if TRUE (the default), data will be retrieved for the first row in the parent dataset, otherwise not.

ChangedEvent

The {get} pseudo-function returns the value of ChangedEvent, an optional event to publish on value-changed.

CheckCurrentChanged

The {get} pseudo-function returns the value of CheckCurrentChanged. This value determines whether the DataObject code should check whether the database rows being updated have been changed since read.

CheckLastOnOpen

The {get} pseudo-function returns the value of CheckLastOnOpen, the flag indicating whether a get-last should be performed on an open in order for fetchNext to detect that we are on the last row. This is necessary to make the QueryPosition attribute reliable. Note:

ChildDataKey

The {get} pseudo-function returns the value of ChildDataKey.

ClientID

The {get} pseudo-function returns the value of clientID.

ClientProxyHandle

Stores the character version of the client-side SDO handle. The string containing the client-side SDO procedure handle.

ClientRect

Returns the client rectangle for the Treeview

Col

Returns the column of the object.

ColumnFormat

The {get} pseudo-function returns the value of ColumnFormat, the browse column format overrides values.

ColumnLabels

The {get} pseudo-function returns the value of ColumnLabels, the browse column label overrides values.

Columns

Sets the DataColumns property (see webprop.i), a comma-separated list of database tables (not SmartDataObject) to be retrieved by this object. A comma-separated list of column names. The set function is named setColumns instead of setDataColumns for backwards compatibility.

ComboDelimiter

The {get} pseudo-function returns the value of ComboDelimiter.

ComboFlag

The {get} pseudo-function returns the value of ComboFlag.

ComboFlagValue

The {set} pseudo-function assigns a new value to ComboFlagValue.

ComboHandle

The {get} pseudo-function returns the value of ComboHandle.

ComboQuery

The getComboQuery routine is published from the viewer and is used to pass the query required by this combo back to the viewer for building. Once built, the query will be returned into the procedure displayCombo. Note:

ComboSort

The {set} pseudo-function assigns a new value to ComboSort. That value is the Sort propery for the Combo

CommitSource

The {get} pseudo-function returns the value of CommitSource. Used for pass-through for regular containers, but also inherited by the SBO, which uses it generally. A global xp macro is not defined because the SBO needs logic in override (set AutoCommit). To allow {set}, the function defines a temporary, scoped xp macro.

CommitSourceEvents

The {get} pseudo-function returns the value of CommitSourceEvents. This value represents the list of events to be subscribed to in the Commit Panel or other Commit-Source.

CommitTarget

The {get} pseudo-function returns the value of CommitTarget, the list in character format of the handles of this object’s Commit-Targets.

CommitTargetEvents

The {get} pseudo-function returns the value of CommitTargetEvents. This value is the list of events to be subscribed to in the Commit Panel or other Commit-Target.

ConsumerSchema

Returns the XML Schema filename.

ContainedDataColumns

The {get} pseudo-function returns the value of ContainedDataColumns, a delimited list of all the DataColumns of all the Data Objects in this SBO.

ContainedDataObjects

The {get} pseudo-function returns the value of ContainedDataObjects, a list of the handles of the Data Objects contained in this SBO.

ContainerHandle

The {get} pseudo-function returns the value of ContainerHandle, the widget handle of this object’s Window or Frame container. Returns: HANDLE.

ContainerHidden

The {get} pseudo-function returns the value of ContainerHidden, TRUE if this object’s parent container is hidden.

ContainerMode

The {get} pseudo-function returns the value of ContainerMode.

ContainerSource

The {get} pseudo-function returns the value of ContainerSource, the handle of this object’s Container-Source, if any.

ContainerSourceEvents

The {get} pseudo-function returns the value of ContainerSourceEvents, a comma-separated list of the events to which this object wants to subscribe to in its ContainerSource.

ContainerTarget

The {get} pseudo-function returns the value of ContainerTarget. This value is the list of the handles of the object’s contained objects.

ContainerTargetEvents

The {get} pseudo-function returns the value of ContainerTargetEvents. This value is the comma-separated list of the events this object wants to subscribe to in its ContainerTarget.

ContainerType

The {get} pseudo-function returns the value of ContainerType, the type of container this SmartObject is ("Window" or "Frame"), or the empty string if the object is not a container.

ContextandDestroy

Server-side procedure to run after new data has been requested by the client.

ContextAndInitialize

Resets context and initializes this server-side object. Called from a stateless client before a request.

ContextFields

Retrieves the ContextFields property (see webrprop.i), a comma-separated list of Fields for which URL parameters are needed to keep context for subsequent requests to this object. Note:

ContextForServer

Sets a new value for gcContextForServer.

CreateHandles

The {get} pseudo-function returns the value of CreateHandles. This value is a comma-separated list of the handles, in character form, of the fields in the data visualization object that should be enabled for an Add or Copy operation.

CtrlFrameHandle

Returns the handle of the Treeview’s control frame.

CurrentDescValue

The {get} pseudo-function returns the value of CurrentDescValue.

CurrentKeyValue

The {get} pseudo-function returns the value of CurrentKeyValue.

CurrentMessage

The {get} pseudo-function returns the value of CurrentMessage.

CurrentMessageId

The {get} pseudo-function returns the value of CurrentMessageID, the ID from the previous sendMessage where ReplyRequired.

CurrentPage

The {get} pseudo-function returns the value of CurrentPage. This value is the current page number of the Container.

CurrentRowids

1.) Returns the String of comma-delimited rowids in the CurrentRowid property. (See webrprop.i.). Note:

CurrentRowModified

Returns TRUE if any values in the current RowObject row have been modified. If there is no current RowObject record, then getCurrentRowModified returns "?".

D
DataColumns

The {get} pseudo-function to examine the value of DataColumnsByTable. Returns a comma-delimited list of the columnNames for the SmartDataObject.

DataColumns

The {get} pseudo-function returns the value of DataColumns, a list of all the DataColumns of all the Data Objects in this SBO, each qualified by the SDO ObjectName.

DataFieldDefs

The {get} pseudo-function returns the value of DataFieldDefs, the name of the include file in which the field definitions for this SDO’s RowObject table are stored.

DataHandle

The {get} pseudo-function returns the value of DataHandle, the handle to the temp-table query.

DataHandle

This SBO version of getDataHandle is run from a browser to get the query from the contained Data object. Returns the handle of the RowObject query.

DataIsFetched

The {get} pseudo-function returns the value of DataIsFetched. The SBO sets this to TRUE in the SDO when it has fetched data on the SDO’s behalf in order to prevent the SDO from another server call to fetch the data it already has. This is checked in query.p dataAvailable and openQuery is skipped if its TRUE. It is immediately turned off after it is checked.

DataLinksEnabled

The {get} pseudo-function returns the value of DataLinksEnabled.

DataLogicObject

Returns the global handle ghDataLogicProcedure.

DataModified

The {get} pseudo-function returns the value of DataModified. This value is TRUE if the current RowObject record is modified, or NO if there is no current RowObject.

DataModified

Disables searching while there is an update in progress in the SmartDataBrowser. SmartDataBrowser version of setDataModified.

DataObject

The {get} pseudo-function returns the value of DataObject. This value represents the filter used at design time.

DataObjectHandle

Returns the handle of the design-time DataObject.

DataObjectNames

Returns the ordered list of ObjectNames of contained SDOs. 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. This function must be run to retrieve the value so that it can 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 it no longer matches the list of contained SDOs, then it is blanked out so the default value will be recalculated.

DataObjectOrdering

The {get} pseudo-function returns the value of DataObjectOrdering, the mapping of the order of Update Tables as generated by AppBuilder to the developer-defined update order.

DataQueryBrowsed

Returns the DataQueryBrowsed value after mapping the requesting Browser (or other such client object) to the SDO whose query it is browsing.

Returns TRUE if this SmartDataObject’s Query is being browsed by a SmartDataBrowser.

DataQueryString

The {get} pseudo-function returns the value of DataQueryString.

DataSignature

Returns a character string value, which is a list of integers corresponding to the datatypes of the fields in the object temp-table, for use in comparing objects for equivalence.

DataSignature

A character string value that is a list of integers corresponding to the datatypes of the fields in the RowObject temp-table, for use in comparing objects for equivalence.

1 = CHARACTER 
2 = DATE 
3 = LOGICAL 
4 = INTEGER 
5 = DECIMAL 
6 = Reserved for FLOAT OR DOUBLE in the future 
7 = RECID 
8 = RAW 
9 = Reserved for IMAGE in the future 
10 = HANDLE 
13 = ROWID 

DataSource

The {get} pseudo-function returns the value of DataObjectHandle.

DataSource

Returns the value of DataSource. To allow design-time override, this does not use the {get} syntax.

DataSourceEvents

The {get} pseudo-function returns the value of DataSourceEvents, a comma-separated list of the events this object wants to subscribe to in its data source.

DataSourceFilter

The {get} pseudo-function returns the value of DataSourceFilter, an optional filter expression for the data source.

DataSourceNames

The {get} pseudo-function returns the value of DataSourceNames, the ObjectName of the Data Object that sends data to this visual object. This would be set if the data source is an SBO or other Container with DataObjects.

DataTarget

The {get} pseudo-function returns the value of DataTarget, a handle in character format, or a comma-separated list of handles for the case of multiple data targets.

DataTargetEvents

The {get} pseudo-function returns the value of DataTargetEvents, the list of events this object class should be subscribed to in its data targets.

DataValue

Returns the data value.

The {get} pseudo-function returns the value of a SmartDataField’s DataValue.

Returns the data value that is read by the SmartDataViewer when it calls collectChanges, if it encounters this PROCEDURE in the list of EnabledHandles and the DataModified property of this object equals TRUE.

DBAware

The {get} pseudo-function returns the 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.

DBNames

Returns a comma-delimited list of DBNames that corresponds to the Tables in the Query Objects.

DBNames

Returns the value of DBNames, a comma-delimited list of DBNames that corresponds to the tables in the Query Objects

DC

Defined as EXTERNAL "user32"

Allocates a device context for the Treeview

DefaultCharWidth

The {get} pseudo-function returns the value of DefaultCharWidth, the default width of character fields.

DefaultEditorLines

The {get} pseudo-function returns the value of DefaultEditorLines, the default number of inner lines for editors.

DefaultLayout

The {get} pseudo-function returns the value of DefaultLayout.

DefaultLogical

Not currently used. The {get} pseudo-function returns the value of DefaultLogical.

DefaultWidth

The {get} pseudo-function returns the value of DefaultWidth, the default width for noncharacter fields.

DefineAnyKeyTrigger

Returns the DefineAnyKeyTrigger property, TRUE if a persistent trigger is to be defined on ANY-KEY. Does not use the {get} syntax.

DeleteTables

1.) Retrieves a comma-separated list of tables to be deleted.

2.) Stores a comma-separated list of tables to be deleted. Note:

DescSubstitute

The {get} pseudo-function returns the value of DescSubstitute.

DesignDataObject

The {get} pseudo-function returns the value of DesignDataObject, the design time SDO for objects that need SDO data, but cannot be linked.

DesignTimeHideMenu

Returns glDesignTimeHideMenu. This flag is set right before initializeobject for a toolbar if this menu is on the startpage.

Destination

The {get} pseudo-function returns the value of Destination.

DestinationList

The {get} pseudo-function returns the value of DestinationList.

Destinations

The {get} pseudo-function returns the value of Destinations.

DestroyStateless

The {get} pseudo-function returns the value of DestroyStateless, which determines whether the persistent SDO should be destroyed on stateless requests.

DeviceCaps

Defined as EXTERNAL "gdi32"

Returns the device caps for the Treeview

DirectionList

The {get} pseudo-function returns the value of DirectionList.

DisabledActions

Returns the DisabledActions property value, a comma-separated list of disabled actions. Placing actions in this list immediately disables them and calls to enableActions have no effect on them while they are listed. That makes it possible to permanently disable actions regardless of state changes. Removing actions from this list with modifyDisabledActions allows enableActions to enable them again.

DisabledAddModeTabs

The {get} pseudo-function returns the value of DisabledAddModeTabs.

DisableOnInit

The {get} pseudo-function returns the value of DisableOnInit, indicating whether the current object should be left disabled when it is first initialized.

DisconnectAppServer

The {get} pseudo-function returns the value of DisconnectAppServer. This value determines whether the persistent SDO disconnects the AppServer.

DisplayDataType

The {get} pseudo-function returns the value of DisplayDataType.

DisplayedField

The {get} pseudo-function returns the value of DisplayedField, the name of the field to display in the selection.

DisplayedFields

The {get} pseudo-function returns the value of DisplayedFields. Used in such activities as signature matching.

DisplayFieldsSecurity

The {get} pseudo-function returns the value of DisplayFieldsSecurity, a comma-separated list of security types corresponding to AllFieldHandles.

DisplayedTables

The {get} pseudo-function returns the value of DisplayedTables. This is the list of SDO table names used by the visualization. Can be only "RowObject". If the object was built against an SBO, it will be the list of SDO ObjectNames whose fields are used.

DisplayField

The {get} pseudo-function returns the value of DisplayField, which will be TRUE if the SmartDataField is to be displayed along with other fields in its Container, otherwise FALSE.

DisplayFormat

The {get} pseudo-function returns the value of DisplayFormat.

DisplayValue

The {get} pseudo-function returns the saved screen/display value of a SmartDataField.

Returns the DisplayValue based on the DataValue. If the keyfield and displayfield are the same, the keyfield value (datavalue) is returned. If they are not the same, then if a reposition source is set, it returns the displayedfieldvalue that is obtained from the SDO. In all other cases it will search the list-item-pairs (or radio-buttons for radio-sets) given the datavalue and will return the display value.

DocumentElement

Returns the ID of the root element.

DocumentHandle

Returns the handle of the current document.

DocumentInitialized

Determines if the document is initialized. For example, it has a root node.

Domain

The {get} pseudo-function returns the value of Domain.

Down

Sets the down attribute for the browse and resizes the browse appropriately. Called from initializeObject for dynamic SmartDataBrowsers.

DTDPublicId

Returns the DTDPublicId property of the Document.

DTDPublicIdList

The {get} pseudo-function returns the value of DTDPublicIdList. That value is a CHR(1)- separated list of DTD Public Ids for producer.

DTDSystemID

Returns the DTDSystemId property of the Document.

DTDSystemIdList

The {get} pseudo-function returns the value of DTDSystemIdList. That value is a CHR(1)-separated list of DTD System Ids for producer.

DynamicObject

The {get} pseudo-function returns the value of DynamicObject.

DynamicSDOProcedure

The {get} pseudo-function returns the value of DynamicSDOProcedure. This value is the name of the dynamic SDO procedure. That is adm/dyndata.w by default, but it can be modified if the dynamic SDO is customized.

E
EdgePixels

Returns the number of pixels that should be used to draw the rectangle around the buttons on a SmartPanel.

EdgePixels

The {get} pseudo-function returns the value of EdgePixels.

Editable

The {get} pseudo-function returns the value of Editable. This value indicates whether this object can be edited (add/copy/save/update). If the {get} returns undefined, the routine {get}s EnabledFields. If there are some, the function returns TRUE; if none, the routine calls the same function in all the routines in the GroupAssignTarget list.

EnabledFields

The {get} pseudo-function returns the value of EnabledFields. Can be a comma-separated list of the names of enabled fields in this object that map to fields in the SmartDataObject (&ENABLED-FIELDS).

EnabledHandles

The {get} pseudo-function returns the value of EnabledHandles. This is a comma-separated list of the handles, in character format, of the enabled fields in the visualization object.

EnabledObjFlds

The {get} pseudo-function returns the value of EnabledObjFields, a list of the field names of widgets enabled in this object not associated with data fields.

EnabledObjHdls

The {get} pseudo-function returns the value of EnabledObjHandles, the list of the handles of widgets enabled in this object and not associated with data fields.

EnabledTables

Returns a list of the database tables that have enabled fields.

EnableField

The {get} pseudo-function returns the value of EnableField. This value is TRUE if the SmartDataField is to be enabled for user input along with other fields in its Container, otherwise FALSE.

EnableOnAdd

Not in use at present. The {get} pseudo-function returns the value of EnableOnAdd.

ExitBrowseOnAction

The {get} pseudo-function returns the value of ExitBrowseOnAction, TRUE if the selection of a value in the browse also should Exit the browse.

ExpandOnAdd

The {get} pseudo-function returns the value of ExpandOnAdd.

ExternalJoinList

Sets the ExternalJoinList property (see webrprop.i), a comma-separated list of URL parameters that are needed to join an external table (supplied by the ExternalTables URL parameter) to retrieve data for this request. In report and detail Web objects, this is specified on the External Tables and Objects Page in the QueryBuilder. A pipe ( | )-separated list of OF phrases. For example:

/*This example is from a report web object that is looking for an  
  external table of customer, and will present orders, orderlines and 
  items based on the ExternalJoinlist as shown.*/ 
setExternalJoinList(’Order.CustNum = Customer.CustNum,OF Order,OF 
OrderLine’). 

ExternalRefList

Returns External Ref List property value.

ExternalTableList

Sets the ExternalTableList property (see webrprop.i), a pipe-separated list of comma-separated lists of External Tables that might be used to retrieve data for this request. In report and detail Web objects, this is specified on the External Tables and Objects Page in the QueryBuilder. A pipe ( | )-separated list of comma-separated tables. Note: The ExternalJoinList and ExternalWhereList and/or ForeignFieldList have corresponding entries. For example:

/* If you have a report of orders called reord.html you might call that 
   report from any of the following types of objects: 
   objects that provide ExternalTables=customer in the URL, along with 
   information (rowid or foreign fields) that allow this report to 
   retrieve only orders for a particular customer. 
   objects that provide ExternalTables=salesrep,customer in the URL,  
   along with information (rowids or foreign fields) that allow this  
   report to retrieve only orders for a particular customer sold by a  
   particular salesrep. 
   objects that provide ExternalTables=salesrep in the URL, along with  
   information (rowid or foreign fields) that allow this report to  
   retrieve only orders sold by a particular salesrep. 
   To allow external joins from any of these types of web objects, you  
   would use the following call to setExternalTables: */ 
   setExternalTableList(’customer|salesrep,customer|salesrep’). 
/* setForeignFieldList, setExternalJoinList and setExternalWhereList 
have  
   corresponding pipe-delimited entries such as the following: */ 
setExternalJoinList 
   (’OF customer|Order.CustNum = Customer.CustNum AND 
   Order.salesrep = Salesrep|Order.salesrep = Salesrep’). 
   setForeignFieldList (’custnum|salesrep,custnum|salesrep’). 
   setExternalWhereList(’|Order.PromiseDate < 12/12/99|’) 

ExternalTables

Sets the ExternalTables property (see webrprop.i), a comma-separated list of the current List of ExternalTables to use to retrieve data for this request. A comma-separated list of table names.

ExternalWhereList

Sets the ExternalWhereList property (see webrprop.i), which contains an optional pipe-separated list of WHERE clause field expressions that correspond to the ExternalTableList Property. A pipe ( | )-separated list of field expressions. Note:

F
FieldColumn

The {get} pseudo-function returns the value of FieldColumn, the column number of the leftmost field.

FieldEnabled

The {get} pseudo-function returns the value of FieldEnabled, TRUE if the SmartDataField is enabled for user input, otherwise FALSE.

FieldFormats

The {get} pseudo-function returns the value of FieldFormats. Internal override of formats for fields.

FieldHandles

The {get} pseudo-function returns the value of FieldHandles. This value is a comma-separated list of the handles, in character format, of the Data Fields in the visualization object.

FieldHelpIds

The {get} pseudo-function returns the value of FieldHelpIds, the internal list of properties for the fields. Each element consists of a name and a value, separated by CHR(1).

FieldHidden

Hides or unhides a lookup field.

FieldLabel

The {get} pseudo-function returns the value of FieldLabel.

FieldLabel

The {get} pseudo-function returns the value of FieldLabel.

FieldLabels

The {get} pseudo-function returns the value of FieldLabels, the internal list of properties for the fields. Each element consists of a name and a value, separated by CHR(1).

FieldName

The {get} pseudo-function returns the value of FieldName, the name of the SDO field to which this object maps.

FieldOperatorStyles

The {get} pseudo-function returns the value of FieldOperatorStyles, an internal list of properties for the fields. Each element consists of a name and a value, separated by a chr(1).

FieldsEnabled

The {get} pseudo-function returns the value of FieldsEnabled. This logical value indicates whether the fields in this visualization object are enabled.

FieldToolTip

The {get} pseudo-function returns the value of FieldToolTip.

FieldToolTips

The {get} pseudo-function returns the value of FieldToolTips, an internal list of properties for the fields. Each element consists of a name and a value, separated by a CHR(1).

FieldWidths

The {get} pseudo-function returns the value of FieldWidths, an internal list of properties for the fields. Each element consists of a name and a value, separated by a CHR(1).

FillBatchOnRepos

The {get} pseudo-function returns the value of FillBatchOnRepos. This value determines whether fetch RowIdent should retrieve enough rows to fill a batch of records when repositioning to the end or near the end of the dataset where an entire batch would not be retrieved.

FilterActive

Returns TRUE if the DataSource has a logical filter

FilterActive

The {get} pseudo-function to extract the values of FilterActive and QueryColumns. Returns TRUE if a filter is active and QueryColumns is not the empty string.

FilterAvailable

The {get} pseudo-function returns the value of FilterAvailable.

FilterSource

The {get} pseudo-function returns the value of FilterSource. This value represents the Filter Source for pass-through support.

FilterTarget

1.) The {get} pseudo-function returns DataObjectHandle. Returns it in character format.

2.) Returns the value of FilterTarget, the name of the linked filter object. Currently supports only one.

FilterTargetEvents

The {get} pseudo-function returns the value of FilterTargetEvents, the comma-separated list of the events to which this object wants to subscribe to in its FilterTarget.

FilterWindow

The {get} pseudo-function returns the value of FilterWindow, the name of the partition, if any, on which this object will run.

FirstResultRow

The {get} pseudo-function returns the value of FirstResultRow. This will be unknown if the first row has not yet been fetched, otherwise 1 concatenated with the ROWID.

FirstRowNum

The {get} pseudo-function returns the value of FirstRowNum, the temp-table row number of the first row.

FlagValue

The {get} pseudo-function returns the value of FlagValue, the option flag key values for "All" and "None".

FlatButtons

Not in use at present. The {get} pseudo-function returns the value of FlatButtons, TRUE if buttons are shown without obvious borders unless they have the focus.

FolderWindowToLaunch

The {get} pseudo-function returns the value of FolderWindowToLaunch.

ForeignFieldList

1.) Retrieves the alternative list of foreign fields corresponding to the ExternalTableList.

2.) Sets the ForeignFieldList property (see webrprop.i), a pipe (|)-separated list of comma-separated lists of the use to format URL parameters to pass to the next Web object.

ForeignFields

1.) Returns the ForeignFields property. That holds the mapping of fields in another DataSource to fields in this SmartDataObject’s RowObject temp-table, to open a dependent query.

2.) The {get} pseudo-function returns the value of ForeignFields for the SBO.

ForeignValues

1.) The {get} pseudo-function returns ForeignValues.

2.) The values of the most recently received ForeignField values received by dataAvailable. The values are character strings formatted according to the field format specification and they are separated by the CHR(1) character.

Format

The {get} pseudo-function returns the value of Format, an overridden format string.

FrameHandle

1.) Returns the frame handle of the object.

2.) Store the handle of the frame.

FrameMinHeightChars

The {get} pseudo-function returns the value of FrameMinHeightChars, the predetermined character height of a frame.

FrameMinWidthChars

The {get} pseudo-function returns the value of FrameMinWidthChars, the predetermined character width of a frame.

FullRowSelect

Returns the FullRowSelect property of the tree. If TRUE, the entire node (text and icon) is highlighted.

FuncLibHandle

PRIVATE function. Returns the handle of the AppBuilder function library.

G
GroupAssignSource

The {get} pseudo-function returns the value of GroupAssignSource. This value is the handle of the object’s GroupAssign source.

GroupAssignSourceEvents

The {get} pseudo-function returns the value of GroupAssignSourceEvents. This value is a comma-separated list of the events this object wants to subscribe to in its GroupAssign source.

GroupAssignTarget

The {get} pseudo-function returns the value of GroupAssignTarget. This is the handle, in character format, of the object’s GroupAssign target.

GroupAssignTargetEvents

The {get} pseudo-function returns the value of GroupAssignTargetEvents. This is a comma-separated list of the events this object wants to subscribe to in its GroupAssign target.

H
Height)

Returns the height of the object.

HelpId

The {get} pseudo-function returns the value of the optional HelpId of the selection.

HiddenActions

The {get} pseudo-function returns the value of HiddenActions, a comma separated list.

HiddenMenuBands

The {get} pseudo-function returns the value of HiddenMenuBands, a comma-separated list.

HiddenToolbarBands

The {get} pseudo-function returns the value of HiddenToolbarBands, a comma-separated list.

HideOnInit

The {get} pseudo-function returns the value of HideOnInit. This value indicates whether the current object should be left hidden when it is first initialized.

HideSelection

Returns the value of HideSelection, TRUE if the current node in the TreeView will not remain highlighted when focus leaves the TreeView.

I
ILComHandle

Returns the com-handle of the ImageList ActiveX object

Image

Loops through the buttons loading their images, if any. The name of the button of interest. The button-image number.

ImageHeight

Returns the ImageHeight property, the height of images in the image list associated with the TreeView.

ImagePath

The {get} pseudo-function returns the value of ImagePath, the path to the images in the filesystem.

ImageWidth

Returns the ImageWidth property, the width of images in the image list associated with the TreeView.

Indentation

Returns the Indentation property of the tree, the number of pixels of indentation between two generations of nodes.

IndexInformation

Returns IndexInormation formatted as the 4 GL index-information attribute, but with RowObject column names, CHR(1) as index separator, and CHR(2) as table separator.

InitialPageList

The {get} pseudo-function returns the value of InitialPageList. This value is the comma-delimited list of pages to construct at startup, or "*" to indicate all pages must be initialized at startup.

InMessageSource

The {get} pseudo-function returns the value of InMessageSource, a handle.

InMessageTarget

The {get} pseudo-function returns the value of InMessageTarget.

InnerLines

The {get} pseudo-function returns the value of Inner-Lines, the option flag key values for ‘all’ and ‘none’.

InstanceProperties

The {get} pseudo-function returns the value of InstanceProperties, a list of the ADM instance properties of the SmartObject. Instance properties are those properties that can be set at design time to be initialized as part of startup.

InternalEntries

Returns internal entries of SDO as internal entries cannot be accessed for remote proxy procedures.

InternalRefList

The {get} pseudo-function returns the value of InternalRefList.

J
JMSpartition

The {get} pseudo-function returns the value of JMSpartition.

JMSpassword

The {get} pseudo-function returns the value of JMSpassword.

JMSsession

Returns the handle of the JMS session this instance is using.

JMSuser

The {get} pseudo-function returns the value of JMSuser.

K
KeyDataType

The {get} pseudo-function returns the value of KeyDataType.

KeyField

1. The {get} pseudo-function returns the value of KeyField, which is the name of the key field.

2.) That is the name of the field whose value is:

KeyFields

The {get} pseudo-function returns the value of KeyFields. This value is a comma-separated list.

KeyFieldValue

The {set} pseudo-function assigns a new value to KeyFieldValue. Enables the {set} using a temporary scoped macro.

KeyFormat

The {set} pseudo-function assigns a new value to KeyFormat.

L
Label

The {get} pseudo-function returns the value of Label, the label defined for the selection. If the value is undefined, it is converted to a string. Because no global xp macro is defined, this function defines a temporary, scoped xp macro.

LabelEdit

Returns the LabelEdit property of the tree. If TRUE, the user can click on the node to edit it.

LabelHandle

The {get} pseudo-function returns the value of LabelHandle.

LastDbRowIdent

The {set} pseudo-function sets a new value for LastDbRowIdent. This value will be unknown if the last row has not been fetched, otherwise it will be the database rowid(s) for the last row.

LastResultRow

The {get} pseudo-function returns the value of LastResultRow. This value will be unknown if the last row has not yet been fetched, otherwise RowNum is concatenated with ROWID.

LastRowNum

The {get} pseudo-function returns the value of LastRowNum, the temp-table row number of the last row.

LayoutOptions

The {get} pseudo-function returns the value of LayoutOptions, the list of multi-layout options for the object.

LayoutVariable

The {get} pseudo-function returns the value of LayoutVariable, the name of the &LAYOUT-VARIABLE preprocessor for the object, which is used as a prefix to the name of the procedure that resets it.

LineStyle

Gets the LineStyle property of the tree:

LinkColumns

Stores the columns that have hyperlinks as a comma-separated list in the LinkURLs property (see wbtaprop.i). The comma-separated list of columns. For example:

setLinkColumns ("custnum,salesrep") 

LinkedFieldDataTypes

The {get} pseudo-function returns the value of LinkedFieldDataTypes.

LinkedFieldFormats

The {get} pseudo-function returns the value of LinkedFieldFormats.

ListItemPairs

The {get} pseudo-function returns the value of ListItemPairs.

LoadedByRouter

The {get} pseudo-function returns the value of LoadedByRouter. That value is true if the XML and Schema have already been loaded by the router.

LogFile

The {get} pseudo-function returns the value of LogFile.

LogicalObjectName

The {get} pseudo-function returns the value of LogicalObjectName. Defines a temporary, scoped xp macro for the purpose.

LogicalVersion

The {get} pseudo-function returns the value of LogicalVersion. Defines a temporary, scoped xp macro for the purpose.

LogicBuffer

Returns the handle of the data-logic table, if possible.

LogicalObjectName

Calls SUPER with the argument, and then uses {get} to check ObjectInitialized. If that value is true, this routine clears it and runs initializeObject. This routine always returns TRUE.

LookupFilterValue

Returns gcLookupFilterValue, the filter value set.

LookupHandle

The {get} pseudo-function returns the value of LookupHandle.

LookupImage

The {get} pseudo-function returns the value of LookupImage.

LookupQuery

This routine is published from the viewer and is used to pass the query required by this lookup back to the viewer for building. Once built, the query will be returned into the procedure displayLookup.

M
MaintenanceObject

The {get} pseudo-function returns the value of MaintenanceObject.

MaintenanceSDO

The {get} pseudo-function returns the value of MaintenanceSDO.

ManualAddQueryWhere

The {get} pseudo-function returns the value of ManualAddQueryWhere. This value is reapplied by the filter when needed to ensure the original query remains intact.

ManualAssignQuerySelection

The {get} pseudo-function returns the value of ManualAssignQuerySelection. This value is reapplied by the filter when needed to preserve the original query.

ManualSetQuerySort

The {get} pseudo-function returns the value of ManualSetQuerySort. This value is reapplied by the filter when needed to preserve the original query.

MapNameProducer

The {get} pseudo-function returns the value of MapNameProducer.

MapObjectProducer

The {get} pseudo-function returns the value of MapObjectProducer.

MapTypeProducer

The {get} pseudo-function returns the value of MapTypeProducer.

MarginPixels

The {get} pseudo-function returns the value of MarginPixels, the number of pixels to reserve for the Panel margin used by resizeObject.

MasterDataObject

The {get} pseudo-function returns the value of MasterDataObject, the handle of the SDO that has no data source of its own and is the parent to other SDOs.

MaxWidth

The {get} pseudo-function returns the value of MaxWidth. That value is the maximum width of the browse when CalcWidth is TRUE.

Menu

The {get} pseudo-function returns the value of Menu, TRUE if a menu is to be generated.

MenuMergeOrder

The {get} pseudo-function returns the value of MenuMergeOrder. This value decides the order in which menus will be merged with other toolbar instances.

MessageType

The {get} pseudo-function returns the value of MessageType.

MinHeight

The {get} pseudo-function returns the value of MinHeight.

MinWidth

The {get} pseudo-function returns the value of MinWidth.

MultiInstanceActivated

The {get} pseudo-function returns the value of MultiInstanceActivated.

MultiInstanceSupported

The {get} pseudo-function returns the value of MultiInstanceSupported.

N
NameList

The {get} pseudo-function returns the value of NameList.

NameSpaceHandle

The {get} pseudo-function returns the value of NameSpaceHandle. That value is the handle of the loaded XML mapping schema namespaces.

NavigationSource

1.) The {get} pseudo-function returns the value of NavigationSOurce, the handle of the query object’s Navigation source.

2.) This value is used for pass-through for regular containers, and by the SBO generally.

NavigationSourceEvents

The {get} pseudo-function returns the value of NavigationSourceEvents. This is the list of events to be subscribed to in the Navigation Panel or other Navigation-Source.

NavigationTarget

The {get} pseudo-function returns the value of NavigationTarget.

NavigationTargetEvents

The {get} pseudo-function returns the value of NavigationTargetEvents, a comma-separated list of the events this object wants to subscribe to in its NavigationTarget.

NavigationTargetName

The {get} pseudo-function returns the value of NavigationTargetName. This is the ObjectName of the Data Object to be navigated by this panel. This would be set if the Navigation-Target is an SBO or other Container with DataObjects.

NewNode

1.) Returns TRUE if the current RowObject record is in new mode. Returns "?" if there is no current RowObject.

2.) Returns TRUE if the matching contained SDO is in NewMode. This is the SBO version of getNewMode.

3.) Returns the next unused node number in sequence.

NewRecord

The {get} pseudo-function returns the value of NewRecord. This is a character value that indicates whether the current record in the visualization object is newly created. Valid values are: "Add", "Copy", and "No".

NewRow

1.) Returns TRUE if the current RowObject record is new (an added record or a copy of an existing record has never been written to the database). Returns "?" if there is no current RowObject.

2.) his SBO version of getDataHandle is run from a browser to get the query from the contained Data object.

NextNodeKey

Returns a unique code to be used for the Key attribute of the Treeview.

NodeExpanded

Expands or collapse a node according to the argument passed.

NumDown

The {get} pseudo-function returns the value of NumDown. That value is the number of rows that are displayed DOWN in the browse.

NumRows

The {get} pseudo-function returns the value of NumRows, the number of rows to display in the selection widget.

O
ObjectEnabled

Returns a flag to indicate whether the current object is enabled.

ObjectHidden

The {get} pseudo-function returns the value of ContainerHidden or ObjectHidden, indicating whether 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.

ObjectInitialized

The {get} pseudo-function returns the value of ObjectInitialized, TRUE if this object has been initialized.

ObjectLayout

The {get} pseudo-function returns the value of ObjectLayout, the current Layout Name for the object.

ObjectMapping

The {get} pseudo-function returns the value of ObjectMapping. This value is a 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.

ObjectMode

Returns the mode of the object. Valid values are:

ObjectName

The {get} pseudo-function returns the value of ObjectName. This value is the name of the object, which can be the filename or some other designation meaningful to the repository and other objects.

ObjectPage

The {get} pseudo-function returns the value of ObjectPage, the logical page on which this object has been placed.

ObjectParent

1.) Returns a handle value of the Progress parent container handle for the current visualization object.

2.) Returns the widget handle of the caller’s parent’s parent (that is: the container that is the caller’s logical grandparent), if any.

ObjectType

The {get} pseudo-function returns the value of ObjectType, unless {&ADMSuper} is nonempty. This value is the type of the SmartObject, such as "SmartDataObject", etc. "SUPER" is returned in the case of a super procedure.

ObjectVersion

The {get} pseudo-function returns the value of ObjectVersion, the ADM version of the SmartObject.

OLEDrag

Returns the value of OLEDrag, TRUE if drag is supported.

OLEDrop

Returns the value of OLEDrop, TRUE if drop is supported.

OpenOnInit

The {get} pseudo-function returns the value of OpenOnInit, which determines whether queries should be opened at initialization.

OpenQuery

1.) Returns the original design WHERE clause for the database query.

2.) Returns the value of OpenQuery, to allow it to be manipulated by setQueryWhere, for example.

Operator

The {get} pseudo-function returns the value of Operator, the default when OperatorStyle is "Implicit".

OperatorLongValues

The {get} pseudo-function returns the value of OperatorLongValues, a list of operators and long text.

OperatorStyle

The {get} pseudo-function returns the value of OperatorStyle. There are four valid values:

OperatorViewAs

The {get} pseudo-function returns the value of OperatorViewAs. This value is the view-as type used to define the operator when OperatorStyle equals "Explicit".

Optional

The {get} pseudo-function returns the value of Optional. The value will be TRUE if the selection is optional, and in that case the property OptionalString holds the value to display.

OptionalBlank

The {get} pseudo-function returns the value of OptionalBlank, TRUE if the optional value is a blank value. Applies to character fields only.

OptionalString

The {get} pseudo-function returns the value of OptionalString. This is displayed as an optional value when the Optional property is set to TRUE.

OutMessageSource

The {get} pseudo-function returns the value of OutMessageSource.

OutMessageTarget

The {get} pseudo-function returns the value of OutMessageTarget.

P
PageNTarget

The {get} pseudo-function returns the value of PageNTarget. This is the 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.

PageSource

The {get} pseudo-function returns the value of PageSource. This is the handle of the object’s folder, if any.

PanelFrame

The {get} pseudo-function returns the value of PanelFrame. This is the Frame handle of the SmartPanel, for resizeObject.

PanelLabel

The {get} pseudo-function returns the value of PanelLabel. This is the handle of the Panel’s Label, if any.

PanelState

Returns the value of PanelState, the current state of the SmartPanel. The {get} syntax is not used here.

PanelType

The {get} pseudo-function returns the value of PanelType, the type of SmartPanel (’Update’, ’Navigation’)

Parent

Returns some parent

ParentDataKey

The {get} pseudo-function returns the value of ParentDataKey.

ParentField

The {get} pseudo-function returns the value of ParentField.

ParentFilterQuery

The {get} pseudo-function returns the value of ParentFilterQuery.

PassThroughLinks

Returns the list of link types that can be pass-through links. Used by addLink. This property value is stored in smart.p for all SmartObjects.

Persistency

The {get} pseudo-function returns the value of Persistency.

PhysicalObjectName

The {get} pseudo-function returns the value of PhysicalObjectName.

PhysicalVersion

The {get} pseudo-function returns the value of PhysicalVersion.

PingInterval

The {get} pseudo-function returns the value of PingInterval.

PrimarySdoTarget

The {get} pseudo-function returns the value of PrimarySdoTarget.

Priority

The {get} pseudo-function returns the value of Priority.

PromptLogin

The {get} pseudo-function returns the value of PromptLogin.

Property

Returns the specified property for some node:

PropertyDialog

The {get} pseudo-function returns the value of PropertyDialog, the name of the dialog procedure that sets InstanceProperties.

PropertyList

Sets a list of properties taken from a CHR(3)-delimited list of prop CHR(4) value pairs.

Q
QueryColumns

The {get} pseudo-function returns the value of QueryColumns.

QueryContainer

The {get} pseudo-function returns the value of QueryContainer. This value indicates whether the Container is itself a QueryObject. This routine is used to determine if an SBO handles the transaction for.

QueryContext

Internal function, developed for use in generic calls. The {get} pseudo-function returns the value of QueryContext on the client.

QueryEmpty

Checks if the data source or query is empty.

QueryHandle

The {get} pseudo-function returns the value of QueryHandle.

QueryObject

Returns a flag that indicates whether this object manages its own database query.

QueryOpen

Returns TRUE if the Query Object’s database query is currently open.

QueryPosition

1.) The QueryPosition property, valid values for which are "FirstRecord", "LastRecord", "NotFirstOrLast", and "NoRecordAvailable".

2.0) The SBO version of the {get} pseudo-function returns the value of QueryPosition. It uses {get} to determine whether the requester is the target-procedure or the source-procedure, {get}s ObjectMapping value, checks whether the MasterDataObject is involved, and finally returns the value of QueryPosition from the SDO to which the caller is mapped.

QueryRowIden

The {get} pseudo-function returns the value of QueryRowIdent, a RowIdent to be used to position an SDO query when it is first opened.

QueryRowObject

The {get} pseudo-function returns the value of QueryRowObject. That value is the handle of the RowObject temp-table associated with the Browse’s query.

QuerySort

Returns the sort phrase.

QueryString

The {get} pseudo-function returns the value of QueryString, the attribute used as working storage for all query manipulation methods.

QueryTables

The {get} pseudo-function returns the value of QueryTables.

QueryWhere

1.) The current query string, returns "?" if the query handle is undefined.

2.) Gets the current WHERE clause for the query.

3.) Prepares the query with a new OPEN QUERY statement or a new expression. The new WHERE clause or expression.

R
RebuildOnRepos

The {get} pseudo-function returns the value of RebuildOnRepos, the flag indicating whether the RowObject temp-table should be rebuilt if a fetchLast or other reposition is done s outside the bounds of the current dataset.

RecordState

The {get} pseudo-function returns the value of RecordState. This is a string indicating whether a record is available or not. Valid values are "RecordAvailable" and "NoRecordAvailable".

ReEnableDataLinks

The {get} pseudo-function returns the value of GetReEnableDataLinks.

Refresh

Refreshes the treeview.

RefreshList

Returns a comma-separated list of the names of the Dynamic Combos to be refreshed for the parent Combo named in the argument.

ReplyReqList

The {get} pseudo-function returns the value of ReplyReqList.

ReplyRequired

The {get} pseudo-function returns the value of ReplyRequired.

ReplySelector

The {get} pseudo-function returns the value of ReplySelector.

ReplySelectorList

The {get} pseudo-function returns the value of ReplySelectorList.

RepositionDataSource

The {get} pseudo-function returns the value of RepositionDataSource, TRUE if the data-source is to be repositioned on VALUE-CHANGED of the select. This is not needed for the view-as browse option. This must be set to TRUE if, for example, the data-source also is a data-source for other objects, and those objects need to be refreshed when a value is changed in the combo-box.

ResizeHorizontal

The {get} pseudo-function returns the value of ResizeHorizontal, TRUE if the object can be resized in X.

ResizeVertical

The {get} pseudo-function returns the value of ResizeVertical, TRUE of the object can be resized in Y.

RootNodeParentKey

Returns the value (from xcRootNodeParentKey) to use as the ParentKey for root nodes on the tree. By searching for nodes with this value as the parent all the root nodes can be found.

RouterSource

The {get} pseudo-function returns the value of RouterSource.

RouterTarget

The {get} pseudo-function returns the value of RouterTarget. The {set} pseudo-function sets a new value for RouterTarget.

Row

Returns the height of the object. Use repositionObject to set the Row.

RowIdent

1.) The value of RowIdent.

2.) The comma-delimited character string containing the ROWIDs of the database records that are the source of the RowObject record.

3.) The ROWID, in character format, of the current row of the visualization. If the update-target is an SDO, the database ROWIDs can be stored as the second entry of the list. If connected to an SBO, the value is a semicolon-separated list corresponding to the SBO’s DataObjectNames list. If the SBO is a valid UpdateTarget, then the ROWIDs are for the UpdateTargetNames; otherwise the DataSourceNames. Note: Return only the ROWIDs that uniquely identify this object’s connection to the dataSource/updateTarget and remove unnecessary ROWIDs so the property can be used directly as input to update methods in the SBO. The assumption is that all tables that are displayed only in the visual object are on the oneside of a one-to-many or many-to-one relation of the table that is updated, so that they are uniquely identified through the updatable table and their ROWIDs are not part of this object ‘Ident’. However, return more than one ROWID is returned for the case where more than one SDO is updated as one-to-one in the SBO.

Rowids

Gets the ROWID(s) of the current row or rows.

RowObject

1.) The value of RowObject, the handle of the RowObject Temp-Table buffer.

2.) The handle to the Browser’s temp-table definition.

RowObjectState

1.) Signals whether there are uncommitted updates in the object.

2.) The value of RowObjectState, which signals whether there are uncommitted updates in the object. Valid return values are ‘NoUpdates’ and ‘RowUpdated’. Does not use the {get} syntax.

RowObjectTable

The temp-table handle of the RowObject table. Note:

RowObjUpd

The {get} pseudo-function returns the value of the RowObjUpd property. This value is the handle of the temp-table buffer where updates are stored.

RowObjUpdTable

The {get} pseudo-function returns the value of RowObjUpdTable property. This value is the handle of the RowObjUpd temp-table.

RowsToBatch

The value of RowsToBatch, the number of rows to be transferred from the database query into the RowObject temp-table in a single operation.

RunAttribute

The {get} pseudo-function returns the value of RunAttribute.

RunDOOptions

The {get} pseudo-function returns the value of RunDOOptions. This is a comma-separated list with options that determine how Data Objects are run from constructObject The options available are:

RunMultiple

The {get} pseudo-function returns the value of RunMultiple.

S
SavedContainerMode

The {get} pseudo-function returns the value of SavedContainerNode.

SavedScreenValue

Obsolete function replaced by getDisplayValue (which it calls). Otherwise, kept for backwards compatibility.

SaveSource

The {get} pseudo-function returns the value of SaveSource. This value is TRUE if the TableIO-Source is ‘Save’ but FALSE if (modal) ‘Update’.

SchemaHandle

The {get} pseudo-function returns the value of SchemaHandle, the handle of the loaded XML mapping schema

SchemaList

The {get} pseudo-function returns the value of SchemaList.

SchemaManager

Starts the schema manager, if necessary, and returns its procedure handle.

Scroll

Gets the Scroll property of the tree. If TRUE, scrollbars appear.

ScrollRemote

The {get} pseudo-function returns the value of ScrollRemote.

SDFFileName

The {get} pseudo-function returns the value of SDFFileName.

SDFTemplate

The {get} pseudo-function returns the value of SDFTemplate.

SdoForeignFields

The {get} pseudo-function returns the value of SdoForeignFields.

SearchColumns

1.) Contains a comma-delimited list of columns that are used to search in the current data-source. Currently supports only one column.

2.) Stores the SearchColumns value. (Currently one.) A column name in the data-source.

SearchField

The {get} pseudo-function returns the value of SearchField. That value is the name of a field where searching is enabled. If set, space is allocated for a fill-in to accept a value to be repositioned to.

Secured

The {get} pseudo-function returns the value of Secured, TRUE if the combo’s security is set to HIDDEN.

SecuredTokens

The {get} pseudo-function returns the value of SecuredTokens, a comma-separated list.

SelectedNode

Returns the key of the selected node.

Selectors

The {get} pseudo-function returns the value of Selectors.

ServerConnection

1.) Returns SESSION:SERVER-CONNECTION-ID through ServerConnection property.

2.) Sets SERVER_CONNECTION_ID property from SESSION:SERVER-CONNECTION-ID.

ServerFileName

Returns the property value representing the actual server-side SDO filename to run on the AppServer. That value might not be the ObjectName if that has been modified.

ServerOperatingMode

The {get} pseudo-function returns the value of ServerOperatingMode. This value is a string representing the connection state. Valid values are "stateless", "state-reset", "state-aware", or "none" (no AppServer connection).

ServerSubmitValidation

Returns the value of ServerSubmitValidation, which signals whether the column and RowObject Validation procedures done as part of client validation are to be executed on the server side. If * yes * , normally when the SDO is being run through the open client interface, then serverCommit will execute SubmitValidation itself.

ShowBorder

The {get} pseudo-function returns the value of ShowBorder, TRUE if a three-dimensional border is to be used around the buttons and as a delimiter when "RULE" is specified in createToolbar.

ShowCheckBoxes

Returns the value of ShowCheckBoxes, TRUE if there will be check boxes beside each node on the TreeView.

ShowRootLines

Returns the value of ShowRootLines, TRUE if there should be lines leading to the roots of the tree or not.

ShutDownDest

The {get} pseudo-function returns the value of ShutDownDest. This value is the queue to which a message can be sent to shut down a SmartConsumer running unattended.

SingleSel

Returns the value of SingleSel, TRUE if the node is to be expanded when selected or clicked.

Sort

The {get} pseudo-function returns the value of Sort, TRUE if the selection is to be sorted.

StartBrowseKeys

The {get} pseudo-function returns the value of StartBrowseKeys, the list of Keylabels or KeyFunctions that starts the browse.

StaticPrefix

Returns the prefix used before the action name in static definitions

SubModules

The {get} pseudo-function returns the value of SubModules.

Subscriptions

The {get} pseudo-function returns the value of Subscriptions.

SupportedLinks

The {get} pseudo-function returns the value of SupportedLinks, a comma-separated list of the SmartObject links supported by this object.

SupportedMessageTypes

The {get} pseudo-function returns the value of SupportedMessageTypes.

T
TableIOButtons

Convert a tableIO recordState to setButton.

TableIOSource

The {get} pseudo-function returns the value of TableIOSource.

TableIOSourceEvents

The {get} pseudo-function returns the value of TableIOSourceEvents. This is a comma-separated list of the events to which this object wants to subscribe to in its TableIO source.

TableIOTarget

The {get} pseudo-function returns the value of TableIOTarget, a list of the handles, in character format, of the object’s TableIO Targets.

TableiOTargetEvents

The {get} pseudo-function returns the value of TableIOTargetEvents, a comma-separated list of the events to which this object wants to subscribe to in its TableIO Target.

TableIOType

1.) The value of TableIOType. A comma-separated list in CHARACTER format of the object’s TableIO-Target handles.

2.) tableio-specific values of PanelType, if any, so that resetTabelio can handle panels similar to toolbar.

TableModifier

Stores the Specified HTML attributes for the <table> tag in TableModifier property (see wbtaprop.i). One or more HTML attributes that will be used in the TABLE tag. The Embedded SpeedScript (.htm) files created by the Report wizard show examples of this function call in use. For example:

setTableModifier(’  border="2" cellspacing=10’) 

TableRowids

Retrieves a list of current rowids by using getRowids, and then uses the ExternalTables property (see webrprop.i) to remove the External Tables from the list, returning a list of rowids for only the records requested by the current object. Used to pass as external rowids to a called object.

TableRows

1.) Returns the number of rows in the table.

2.) Stores the specified number of rows for the HTML table in TableRows property (see wbtaprop.i). Number of rows to display in the HTML page. The Embedded SpeedScript (.htm) files created by the Report wizard show examples of this function call in use. For example:

setTableRows(10) 

Tables

1.) Returns the value of Tables, a comma delimited list of tables in the Query Objects

TargetNameSpace

Returns the XML Schema TargetNameSpace. This defines the XMLNS attribute of the document instance.

TargetProcedure

Used in many SmartObjects to return the source-procedure’s target-procedure to a function, such as addRow, in an SBO that needs to know who the "real" caller object is., it can

TimeToLive

TimeToLive represents the time during which the message is considered current and not stale.

Toolbar

The value of Toolbar is TRUE if the toolbar is to be created.

ToolbarAutoSize

The value of ToolbarAutoSize is TRUE if the toolbar should be auto-sized to the width of the window at runtime.

ToolbarBands

The {get} pseudo-function returns the value of ToolbarBands, the list of the toolbar bands selected in the Instance Properties.

ToolbarDrawDirection

The {get} pseudo-function returns the value of ToolbarDirection, the draw direction (horizontal or vertical”) of the toolbar.

ToolbarHeightPxl

Calculates and returns the toolbar height in pixels from the three properties: ToolHeightPXL, ToolbarMarginPxl, and ShowBorder.

ToolbarInitialState

The {get} pseudo-function returns the value of ToolbarInitialState, the state selected in the Instance Properties. Used to view or hide buttons and menus according to state.

ToolbarParentMenu

The {get} pseudo-function returns the value of ToolbarParentMenu, the menu selected in the Instance Properties. Required only if one or more toolbar menus need to be added under a specific submenu. If the submenu does not exist, it is created.

ToolbarSource

The value of ToolbarSource, a handle or list of handles.

ToolbarSourceEvents

The {get} pseudo-function returns the value of ToolbarSourceEvents. This value is the list of events to be subscribed to in the Toolbar-Source.

ToolbarTarget

The {get} pseudo-function returns the value of ToolbarTarget, a handle.

ToolbarTargetEvents

The {get} pseudo-function returns the value of ToolbarTargetEvents, the list of events to which this object wishes to subscribe in the Toolbar-Target.

ToolbarWidthPxl

The {get} pseudo-function to obtain the values of ToolMarginPxl, ToolWidthPxl, and ToolMaxWidthPxl. Calculates and returns the toolbar width.

ToolMarginPxl

Returns a constant zero at present.

ToolTip

The {get} pseudo-function returns the value of tooltip, the optional tooltip for the selection.

TopOnly

Returns the value of the TOP-ONLY attribute.

TranslatableProperties

The {get} pseudo-function returns the value of TranslatableProperties, a comma-separated list.

TreeDataTable

1.) The handle of a dynamic temp-table populated with property fields for a Treeview.

2.) The value of TreeDataTable, the handle of the temp-table into which tree-population data will be stored.

TreeStyle

Valid values are:

TVControllerSource

The {get} pseudo-function returns the value of TVControllerSource, the handle of the procedure controlling this TreeView.

TVControllerTarget

The {get} pseudo-function returns the value of TVControllerTarget.

TVControllerTargetEvents

The {get} pseudo-function returns the value of TVControllerTargetEvents. This is the list of target events to which this controller will subscribe.

TypeName

The {get} pseudo-function returns the value of TypeName.

U
UIBMode

Returns the UIBMode property to indicate whether this object is in Design mode in AppBuilder (AppBuilder was originally called User-interface Builder). This will return blank if the object is not in design mode, that is, not running in an AppBuilder design window. It will return "Design" if in design mode, or "Design-Child" if it is contained in another SmartObject that is in design mode, such as a SmartFrame. It will return "?" if the object is not a SmartObject and does not have a valid handle in ADM-DATA.

UpdatableColumns

1.) A comma-delimited list of the Updatable Columns for this SmartDataObject.

2.) A list of all Updatable Columns of contained DataObjects, qualified by their ObjectNames.

UpdateActive

The {get} pseudo-function returns the value of UpdateActive, TRUE if ANY of the contained objects have active updates.

UpdateFromSource

The {get} pseudo-function returns the value of UpdateFromSource, TRUE if this object should be updated as one-to-one of the datasource updates.

UpdateMode

1.) Returns the value of the updateMode flag, which governs the behavior of ColumnStringValue. If updateMode is set to Add, ColumnStringValue returns initial values of a column. If updateMode is not set to Add, ColumnStringValue returns the current value of the column.

2.) Sets the value of the updateMode flag. Either yes or no. This call is used in processWebRequest in web objects created using the report and detail wizards. In these objects, the hidden field AddMode is set to the value of UpdateMode when a page is sent to the WebBrowser, which is detected when the WebPage is returned.

UpdateSource

1.) The {get} pseudo-function returns the value of UpdateSource. This is 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.

2.) The value of UpdateSource, the handle of the object’s update-source.

UpdateTarget

The {get} pseudo-function returns the value of UpdateTarget. This is used for pass-through links, to connect an object inside the container with an object outside the container.

UpdateTargetNames

The {get} pseudo-function returns the value of UpdateTargetNames. This is the ObjectName of the Data Object to be updated by this visual object. This is set if the Update-Target is an SBO or other Container with DataObjects.

UseBegins

The {get} pseudo-function returns the value of UseBegins. This value is true when BEGINS is supposed to be used for character tests.

UseColumnLabels

Stores a logical specifying whether to use column labels for the HTML table in UseColumnLabels property (see wbtaprop.i). This is using the LABEL and not the COLUMN–LABEL of the field. (There is no logic to take care of the ! in column–labels). For example:

setUseColumnLabels(no) 

UseContains

The {get} pseudo-function returns the value of UseContains. This value is true when Contains is supposed to be used as operator for character values.

UseDBQualifier

Returns TRUE if table references are qualified with database.

UseDTD

Returns TRUE if DTD is to be used.

UsePairedList

Checks to see if an object is an editable combo-box. If getUsePairedList determines the object is an editable combo-box, it returns FALSE, indicating a paired list cannot be used.

UserProperty

Retrieves the value of a dynamically defined property.

UseRepository

Returns TRUE iff Dynamics is running and the Repository is therefore available.

UserNameA

Returns some parent

V
ValidateOnLoad

The {get} pseudo-function returns the value of ValidateOnLoad: whether the document should be validated on load.

ValidKey

Returns TRUE if some key is valid

ViewAs

The {get} pseudo-function returns the value of ViewAs, the ViewAs definition of the selection: combo-box, radio-set, selection-list, or browse. Uses a colon as a separator to define SUB-TYPE for combo-box or horizontal/vertical radio-set. For example: ’radio-set:vertical’.

ViewAsFields

Not currently used. The {get} pseudo-function returns the value of ViewAsFields.

ViewerLinkedFields

The {get} pseudo-function returns the value of ViewerLinkedFields.

ViewerLinkedWidgets

The {get} pseudo-function returns the value of ViewerLinkedWidgets.

VisibleRowids

The {get} pseudo-function returns the value of VisibleRowids.

VisibleRowReset

The {get} pseudo-function returns the value of VisibleRowReset.

VisualBlank

The {get} pseudo-function returns the value of VisualBlank. This value is used to visualize searching for BLANK values.

W
WaitForObject

The {get} pseudo-function returns the value of WaitForObject. This value is the handle of the object (most likely a SmartConsumer) in the container that contains a wait-for that needs to be started with startWaitFor.

Waiting

The {get} pseudo-function returns the value of Waiting. That value determines when waitForMessages is satisfied.

WebState

1.) Returns a Web object’s Web state. Possible values are state–aware, state–less, timed–out. For example:

cWebState = getWebState(). 

2.) Sets the Web object’s Web state to state–aware and its timeout. The number of minutes to remain state–aware. For example:

lReturn = setWebState(5.0). 

WebTimeout

Returns a state–aware Web object’s timeout in minutes. For example:

dWebTimeout = getWebTimeout(). 

WebTimeRemaining

Returns the time remaining for a state–aware Web object. For example:

dWebTimeout = getWebTimeRemaining(). 

WebToHdlr

1.) Returns the name of the Web object/procedure to run when the state–aware Web object that is currently running times out. The name of the object/procedure to run. For example:

cWebToHdlr = getWebToHdlr(). 

2.) Sets the name of the Web object/procedure to run when the state–aware Web object that is currently running times out. The Web-object name.Web object must be on the Agent’s PROPATH. For example:

lReturn = setWebToHdlr("mytohdlr.w"). 

Width

Returns the width of the object.

Window

Returns the handle of the toolbar’s parent Window.

WindowFrameHandle

The {get} pseudo-function returns the value of WindowFrameHandle. This value is the handle of the optional Frame widget of a Window container.

WindowTitleField

The {get} pseudo-function returns the value of WindowTitleField.

WindowTitleViewer

The {get} pseudo-function returns the value of WindowTitleViewer.

WordIndexedFields

1.) A comma-separated list of RowObject fields that are mapped to database fields that have a word indexed.

2.) A comma-separated list of word indexed fields.


Copyright © 2004 Progress Software Corporation
www.progress.com
Voice: (781) 280-4000
Fax: (781) 280-4095