Progress
ADM 2 Reference
Properties Glossary
AActionEventReturns 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.
ActionGroupsReturns the action groups selected in the Instance Properties.
AddModeSets the ADDMode property. If set to TRUE, the assignFields procedure will create a new record.
AllFieldHandlesThe pseudo-function {get} returns the allFieldHandles value.
AllFieldNamesThe pseudo-function {get} returns the allFieldNames value.
ApplyActionOnExitUses the {get} pseudo-function to return the value of ApplyActionOnExit (true if exiting selects the browse row). Currently used by SmartSelect.
ApplyExitOnActionCurrently 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.
AppService1.) 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.
ASBoundReturns 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.
AsDivisionThe {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).
ASHandleReturns 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.
ASHasStartedThe {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.
ASInfoThe {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.
ASInitializeOnRunThe {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.
AssignListThe {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.
ASUsePromptThe {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.
AsynchronousSDOThe {get} pseudo-function returns the value of AsynchronousSDO.
AttributeReturns 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:
AutoCommitThe {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.
AutoSortReturns whether the root node should be auto-sorted.
AvailMenuActionsThe {get} pseudo-function returns the value of AvailMenuActions, the actions available in this menu.
AvailToolbarActionsThe {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.
AvailToolbarBandsReturns a comma-separated list of the available toolbar bands for this toolbar master. Assembles the list by looping through the temp-table.
BBaseQueryStringThe {get} pseudo-function returns the value of BaseQueryString.
BlockDataAvailableThe {get} pseudo-function returns the value of BlockDataAvailable, true if DataAvailable messages from contained SDOs are to be ignored and not republished
BoxRectangleThe {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.
BoxRectangle2The {get} pseudo-function returns the value of BoxRectangle2. Used for bottom rectangle on toolbars where ToolbarAutosize is TRUE.
BrowseFieldDataTypesThe {get} pseudo-function returns the value of BrowseFieldDataTypes.
BrowseFieldFormatsThe {get} pseudo-function returns the value of BrowseFieldFormats.
BrowseFieldsThe {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"
.BrowseHandleThe {get} pseudo-function returns the value of BrowseHandle, the handle of the browse control.
BrowseTitleThe {get} pseudo-function returns the value of BrowseTitle, the title to display in the browse SmartWindowContainer when the ViewAs property is set to
"
browse"
.BuildSequenceThe {get} pseudo-function returns the value of BuildSequence. A scoped xp macro is defined and undefined specifically for this {get}.
BufferUsed to create or assign properties for an action.
BuffersSets the Buffers property (see
webrprop.i
), a comma-separated list of database tables (not SmartDataObject) to be retrieved by this object.ButtonCountThe {get} pseudo-function returns the value of ButtonCount, the number of buttons in a SmartPanel. Used by resizeObject.
ButtonsUsed 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.
CCalculatedColumnsThe {get} pseudo-function to examine the values of DataColumnsByTable and Tables. Returns a comma-delimited list of the calculated columns for the SmartDataObject.
CalcWidthThe {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.
CallerObjectThe {get} pseudo-function returns the value of CallerObject.
CallerProcedureThe {get} pseudo-function returns the value of CallerProcedure.
CallerWindowThe {get} pseudo-function returns the value of CallerWindow.
CancelBrowseOnExitThe {get} pseudo-function returns the value of CancelBrowseOnExit, TRUE if the value in the browse is NOT to be selected on Exit.
CascadeOnBrowseThe {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.
ChangedEventThe {get} pseudo-function returns the value of ChangedEvent, an optional event to publish on value-changed.
CheckCurrentChangedThe {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.
CheckLastOnOpenThe {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:
- The DataColumsByTable property that stores in different tables delimited by CHR(1) instead of a comma in order to identify which columns are from which table in the event of a join. For example, if the query is a join of customer and order and the Name field from customer and the OrderNum and OrderData field from Order are selected, then the property value will be equal to
"
Name<CHR(1)>OrderNum,OrderDate"
.- This function replaces CHR(1) with
"
,"
returns just a comma-delimited list.ChildDataKeyThe {get} pseudo-function returns the value of ChildDataKey.
ClientIDThe {get} pseudo-function returns the value of clientID.
ClientProxyHandleStores the character version of the client-side SDO handle. The string containing the client-side SDO procedure handle.
ClientRectReturns the client rectangle for the Treeview
ColReturns the column of the object.
ColumnFormatThe {get} pseudo-function returns the value of ColumnFormat, the browse column format overrides values.
ColumnLabelsThe {get} pseudo-function returns the value of ColumnLabels, the browse column label overrides values.
ColumnsSets 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.ComboDelimiterThe {get} pseudo-function returns the value of ComboDelimiter.
ComboFlagThe {get} pseudo-function returns the value of ComboFlag.
ComboFlagValueThe {set} pseudo-function assigns a new value to ComboFlagValue.
ComboHandleThe {get} pseudo-function returns the value of ComboHandle.
ComboQueryThe 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:
ComboSortThe {set} pseudo-function assigns a new value to ComboSort. That value is the Sort propery for the Combo
CommitSourceThe {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.
CommitSourceEventsThe {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.
CommitTargetThe {get} pseudo-function returns the value of CommitTarget, the list in character format of the handles of this object’s Commit-Targets.
CommitTargetEventsThe {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.
ConsumerSchemaReturns the XML Schema filename.
ContainedDataColumnsThe {get} pseudo-function returns the value of ContainedDataColumns, a delimited list of all the DataColumns of all the Data Objects in this SBO.
ContainedDataObjectsThe {get} pseudo-function returns the value of ContainedDataObjects, a list of the handles of the Data Objects contained in this SBO.
ContainerHandleThe {get} pseudo-function returns the value of ContainerHandle, the widget handle of this object’s Window or Frame container. Returns: HANDLE.
ContainerHiddenThe {get} pseudo-function returns the value of ContainerHidden, TRUE if this object’s parent container is hidden.
ContainerModeThe {get} pseudo-function returns the value of ContainerMode.
ContainerSourceThe {get} pseudo-function returns the value of ContainerSource, the handle of this object’s Container-Source, if any.
ContainerSourceEventsThe {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.
ContainerTargetThe {get} pseudo-function returns the value of ContainerTarget. This value is the list of the handles of the object’s contained objects.
ContainerTargetEventsThe {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.
ContainerTypeThe {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.ContextandDestroyServer-side procedure to run after new data has been requested by the client.
ContextAndInitializeResets context and initializes this server-side object. Called from a stateless client before a request.
ContextFieldsRetrieves 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:
- The Property should be used whenever the HTML page needs to append the context information to the URL being sent out as URL parameters. This can be seen in a Web report generated using the Report wizard in the following line:
- The Embedded SpeedScript templates for both Report and Detail Web objects use this function. ExternalTables, ExternalRowIds, and Columns that are used as Foreignfields are examples of context fields.
ContextForServerSets a new value for gcContextForServer.
CreateHandlesThe {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.
CtrlFrameHandleReturns the handle of the Treeview’s control frame.
CurrentDescValueThe {get} pseudo-function returns the value of CurrentDescValue.
CurrentKeyValueThe {get} pseudo-function returns the value of CurrentKeyValue.
CurrentMessageThe {get} pseudo-function returns the value of CurrentMessage.
CurrentMessageIdThe {get} pseudo-function returns the value of CurrentMessageID, the ID from the previous sendMessage where ReplyRequired.
CurrentPageThe {get} pseudo-function returns the value of CurrentPage. This value is the current page number of the Container.
CurrentRowids1.) Returns the String of comma-delimited rowids in the CurrentRowid property. (See
webrprop.i
.). Note:
- The rowids stored in this property come from the URL parameter list and are requested in fetchCurrent.
- Rowids for the external tables are also stored in the CurrentRowid property. The function getTableRowids will return the rowids for the query’s original tables.
2.) Sets the String of comma-delimited rowids in the CurrentRowid property that will be used by fetchCurrent. (See
webrprop.i
.) A list of ROWIDS. Note:- Typically this would be set from a URL parameter or hidden field.
- The purpose of this property is to store the context of the current record received from the Web once, so that it only needs to RUN fetchCurrent whenever it is needed.
CurrentRowModifiedReturns TRUE if any values in the current RowObject row have been modified. If there is no current RowObject record, then getCurrentRowModified returns "?".
DDataColumnsThe {get} pseudo-function to examine the value of DataColumnsByTable. Returns a comma-delimited list of the columnNames for the SmartDataObject.
- The DataColumsByTable property that stores in different tables delimited by CHR(1) instead of a comma in order to identify which columns are from which table in the event of a join. For example, if the query is a join of customer and order and the Name field from customer and the OrderNum and OrderData field from Order are selected, then the property value will be equal to "Name<CHR(1)>OrderNum,OrderDate".
- This function replaces CHR(1) with "," returns just a comma-delimited list.
DataColumnsThe {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.
DataFieldDefsThe {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.
DataHandleThe {get} pseudo-function returns the value of DataHandle, the handle to the temp-table query.
DataHandleThis 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.
DataIsFetchedThe {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.DataLinksEnabledThe {get} pseudo-function returns the value of DataLinksEnabled.
DataLogicObjectReturns the global handle ghDataLogicProcedure.
DataModifiedThe {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.
- The difference from getNewRow is that it also returns true for saved and uncommitted new record and thus cannot be used to check the object’s state. This uses the RowMod field in the temp-table to see if the row is new (just as getNewRow) and in addition checks to see if the RowObjUpd is not available, which indicates that this has not been committed. Do some double checking if a rowObjUpd is available to ensure that this is the right one.
- This routine defines a temporary, scoped xp macro in order to allow the {get} to be used.
Returns the value of DataModified, indicating whether the current SCREEN-VALUES have been modified but not saved.
Returns DataModified, which will be TRUE if the SmartDataField value has been changed but not saved, otherwise FALSE.
DataModifiedDisables searching while there is an update in progress in the SmartDataBrowser. SmartDataBrowser version of setDataModified.
DataObjectThe {get} pseudo-function returns the value of DataObject. This value represents the filter used at design time.
DataObjectHandleReturns the handle of the design-time DataObject.
DataObjectNamesReturns 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.
DataObjectOrderingThe {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.
DataQueryBrowsedReturns 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.
DataQueryStringThe {get} pseudo-function returns the value of DataQueryString.
DataSignatureReturns 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.
DataSignatureA 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.
DataSourceThe {get} pseudo-function returns the value of DataObjectHandle.
DataSourceReturns the value of DataSource. To allow design-time override, this does not use the {get} syntax.
DataSourceEventsThe {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.
DataSourceFilterThe {get} pseudo-function returns the value of DataSourceFilter, an optional filter expression for the data source.
DataSourceNamesThe {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.
DataTargetThe {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.
DataTargetEventsThe {get} pseudo-function returns the value of DataTargetEvents, the list of events this object class should be subscribed to in its data targets.
DataValueReturns 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.
DBAwareThe {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.
DBNamesReturns a comma-delimited list of DBNames that corresponds to the Tables in the Query Objects.
DBNamesReturns the value of DBNames, a comma-delimited list of DBNames that corresponds to the tables in the Query Objects
DCDefined as EXTERNAL "user32"
Allocates a device context for the Treeview
DefaultCharWidthThe {get} pseudo-function returns the value of DefaultCharWidth, the default width of character fields.
DefaultEditorLinesThe {get} pseudo-function returns the value of DefaultEditorLines, the default number of inner lines for editors.
DefaultLayoutThe {get} pseudo-function returns the value of DefaultLayout.
DefaultLogicalNot currently used. The {get} pseudo-function returns the value of DefaultLogical.
DefaultWidthThe {get} pseudo-function returns the value of DefaultWidth, the default width for noncharacter fields.
DefineAnyKeyTriggerReturns the DefineAnyKeyTrigger property, TRUE if a persistent trigger is to be defined on ANY-KEY. Does not use the {get} syntax.
DeleteTables1.) Retrieves a comma-separated list of tables to be deleted.
2.) Stores a comma-separated list of tables to be deleted. Note:
DescSubstituteThe {get} pseudo-function returns the value of DescSubstitute.
DesignDataObjectThe {get} pseudo-function returns the value of DesignDataObject, the design time SDO for objects that need SDO data, but cannot be linked.
DesignTimeHideMenuReturns glDesignTimeHideMenu. This flag is set right before initializeobject for a toolbar if this menu is on the startpage.
DestinationThe {get} pseudo-function returns the value of Destination.
DestinationListThe {get} pseudo-function returns the value of DestinationList.
DestinationsThe {get} pseudo-function returns the value of Destinations.
DestroyStatelessThe {get} pseudo-function returns the value of DestroyStateless, which determines whether the persistent SDO should be destroyed on stateless requests.
DeviceCapsDefined as EXTERNAL "gdi32"
Returns the device caps for the Treeview
DirectionListThe {get} pseudo-function returns the value of DirectionList.
DisabledActionsReturns 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.
DisabledAddModeTabsThe {get} pseudo-function returns the value of DisabledAddModeTabs.
DisableOnInitThe {get} pseudo-function returns the value of DisableOnInit, indicating whether the current object should be left disabled when it is first initialized.
DisconnectAppServerThe {get} pseudo-function returns the value of DisconnectAppServer. This value determines whether the persistent SDO disconnects the AppServer.
DisplayDataTypeThe {get} pseudo-function returns the value of DisplayDataType.
DisplayedFieldThe {get} pseudo-function returns the value of DisplayedField, the name of the field to display in the selection.
DisplayedFieldsThe {get} pseudo-function returns the value of DisplayedFields. Used in such activities as signature matching.
DisplayFieldsSecurityThe {get} pseudo-function returns the value of DisplayFieldsSecurity, a comma-separated list of security types corresponding to AllFieldHandles.
DisplayedTablesThe {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.DisplayFieldThe {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.
DisplayFormatThe {get} pseudo-function returns the value of DisplayFormat.
DisplayValueThe {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.
DocumentElementReturns the ID of the root element.
DocumentHandleReturns the handle of the current document.
DocumentInitializedDetermines if the document is initialized. For example, it has a root node.
DomainThe {get} pseudo-function returns the value of Domain.
DownSets the down attribute for the browse and resizes the browse appropriately. Called from initializeObject for dynamic SmartDataBrowsers.
DTDPublicIdReturns the DTDPublicId property of the Document.
DTDPublicIdListThe {get} pseudo-function returns the value of DTDPublicIdList. That value is a CHR(1)- separated list of DTD Public Ids for producer.
DTDSystemIDReturns the DTDSystemId property of the Document.
DTDSystemIdListThe {get} pseudo-function returns the value of DTDSystemIdList. That value is a CHR(1)-separated list of DTD System Ids for producer.
DynamicObjectThe {get} pseudo-function returns the value of DynamicObject.
DynamicSDOProcedureThe {get} pseudo-function returns the value of DynamicSDOProcedure. This value is the name of the dynamic SDO procedure. That is
Eadm/dyndata.w
by default, but it can be modified if the dynamic SDO is customized.EdgePixelsReturns the number of pixels that should be used to draw the rectangle around the buttons on a SmartPanel.
EdgePixelsThe {get} pseudo-function returns the value of EdgePixels.
EditableThe {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.
EnabledFieldsThe {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).
EnabledHandlesThe {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.
EnabledObjFldsThe {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.
EnabledObjHdlsThe {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.
EnabledTablesReturns a list of the database tables that have enabled fields.
EnableFieldThe {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.
EnableOnAddNot in use at present. The {get} pseudo-function returns the value of EnableOnAdd.
ExitBrowseOnActionThe {get} pseudo-function returns the value of ExitBrowseOnAction, TRUE if the selection of a value in the browse also should Exit the browse.
ExpandOnAddThe {get} pseudo-function returns the value of ExpandOnAdd.
ExternalJoinListSets 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:
ExternalRefListReturns External Ref List property value.
ExternalTableListSets 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:
ExternalTablesSets 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.ExternalWhereListSets 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
- The expressions are defined when the QueryBuilder is called from the External Tables and Object page of Wizards for Embedded SpeedScript objects (report and detail objects).
- WHERE clauses that are set with the
“
Where” r
adio-set in the“
Edit Join”
query builder page on the External Tables and Objects Page of the Report and Detail Wizard are stored in this property.- WHERE clauses that are in the ExternalJoinList are merged with the clauses in the ExternalWhereList Property. This is useful in cases in which WHERE clauses that reference more than one table need to be built, such as the following:
FieldColumnThe {get} pseudo-function returns the value of FieldColumn, the column number of the leftmost field.
FieldEnabledThe {get} pseudo-function returns the value of FieldEnabled, TRUE if the SmartDataField is enabled for user input, otherwise FALSE.
FieldFormatsThe {get} pseudo-function returns the value of FieldFormats. Internal override of formats for fields.
FieldHandlesThe {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.
FieldHelpIdsThe {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).
FieldHiddenHides or unhides a lookup field.
FieldLabelThe {get} pseudo-function returns the value of FieldLabel.
FieldLabelThe {get} pseudo-function returns the value of FieldLabel.
FieldLabelsThe {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).
FieldNameThe {get} pseudo-function returns the value of FieldName, the name of the SDO field to which this object maps.
FieldOperatorStylesThe {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).
FieldsEnabledThe {get} pseudo-function returns the value of FieldsEnabled. This logical value indicates whether the fields in this visualization object are enabled.
FieldToolTipThe {get} pseudo-function returns the value of FieldToolTip.
FieldToolTipsThe {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).
FieldWidthsThe {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).
FillBatchOnReposThe {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.
FilterActiveReturns TRUE if the DataSource has a logical filter
FilterActiveThe {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.
FilterAvailableThe {get} pseudo-function returns the value of FilterAvailable.
FilterSourceThe {get} pseudo-function returns the value of FilterSource. This value represents the Filter Source for pass-through support.
FilterTarget1.) 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.
FilterTargetEventsThe {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.
FilterWindowThe {get} pseudo-function returns the value of FilterWindow, the name of the partition, if any, on which this object will run.
FirstResultRowThe {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.
FirstRowNumThe {get} pseudo-function returns the value of FirstRowNum, the temp-table row number of the first row.
FlagValueThe {get} pseudo-function returns the value of FlagValue, the option flag key values for "All" and "None".
FlatButtonsNot 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.
FolderWindowToLaunchThe {get} pseudo-function returns the value of FolderWindowToLaunch.
ForeignFieldList1.) 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.ForeignFields1.) 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.
ForeignValues1.) 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.
FormatThe {get} pseudo-function returns the value of Format, an overridden format string.
FrameHandle1.) Returns the frame handle of the object.
2.) Store the handle of the frame.
FrameMinHeightCharsThe {get} pseudo-function returns the value of FrameMinHeightChars, the predetermined character height of a frame.
FrameMinWidthCharsThe {get} pseudo-function returns the value of FrameMinWidthChars, the predetermined character width of a frame.
FullRowSelectReturns the FullRowSelect property of the tree. If TRUE, the entire node (text and icon) is highlighted.
FuncLibHandlePRIVATE function. Returns the handle of the AppBuilder function library.
GGroupAssignSourceThe {get} pseudo-function returns the value of GroupAssignSource. This value is the handle of the object’s GroupAssign source.
GroupAssignSourceEventsThe {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.
GroupAssignTargetThe {get} pseudo-function returns the value of GroupAssignTarget. This is the handle, in character format, of the object’s GroupAssign target.
GroupAssignTargetEventsThe {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.
HHeight)Returns the height of the object.
HelpIdThe {get} pseudo-function returns the value of the optional HelpId of the selection.
HiddenActionsThe {get} pseudo-function returns the value of HiddenActions, a comma separated list.
HiddenMenuBandsThe {get} pseudo-function returns the value of HiddenMenuBands, a comma-separated list.
HiddenToolbarBandsThe {get} pseudo-function returns the value of HiddenToolbarBands, a comma-separated list.
HideOnInitThe {get} pseudo-function returns the value of HideOnInit. This value indicates whether the current object should be left hidden when it is first initialized.
HideSelectionReturns the value of HideSelection, TRUE if the current node in the TreeView will not remain highlighted when focus leaves the TreeView.
IILComHandleReturns the com-handle of the ImageList ActiveX object
ImageLoops through the buttons loading their images, if any. The name of the button of interest. The button-image number.
ImageHeightReturns the ImageHeight property, the height of images in the image list associated with the TreeView.
ImagePathThe {get} pseudo-function returns the value of ImagePath, the path to the images in the filesystem.
ImageWidthReturns the ImageWidth property, the width of images in the image list associated with the TreeView.
IndentationReturns the Indentation property of the tree, the number of pixels of indentation between two generations of nodes.
IndexInformationReturns 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.
- Intended for internal use by other index info functions, which use this as input to indexInformation(). (Unmapped columns are returned fully qualifed!) This property can be used as input parameter to indexInformation() for further refinement. - If the property is "?", it calls the indexInformation() in query.p and stores the returned value for future calls.
- If a similar list with database fields are needed, use indexInformation() directly (if connected).
InitialPageListThe {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.InMessageSourceThe {get} pseudo-function returns the value of InMessageSource, a handle.
InMessageTargetThe {get} pseudo-function returns the value of InMessageTarget.
InnerLinesThe {get} pseudo-function returns the value of Inner-Lines, the option flag key values for ‘all’ and ‘none’.
InstancePropertiesThe {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.
InternalEntriesReturns internal entries of SDO as internal entries cannot be accessed for remote proxy procedures.
InternalRefListThe {get} pseudo-function returns the value of InternalRefList.
JJMSpartitionThe {get} pseudo-function returns the value of JMSpartition.
JMSpasswordThe {get} pseudo-function returns the value of JMSpassword.
JMSsessionReturns the handle of the JMS session this instance is using.
JMSuserThe {get} pseudo-function returns the value of JMSuser.
KKeyDataTypeThe {get} pseudo-function returns the value of KeyDataType.
KeyField1. 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:
KeyFieldsThe {get} pseudo-function returns the value of KeyFields. This value is a comma-separated list.
KeyFieldValueThe {set} pseudo-function assigns a new value to KeyFieldValue. Enables the {set} using a temporary scoped macro.
KeyFormatThe {set} pseudo-function assigns a new value to KeyFormat.
LLabelThe {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.
LabelEditReturns the LabelEdit property of the tree. If TRUE, the user can click on the node to edit it.
LabelHandleThe {get} pseudo-function returns the value of LabelHandle.
LastDbRowIdentThe {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.
LastResultRowThe {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.
LastRowNumThe {get} pseudo-function returns the value of LastRowNum, the temp-table row number of the last row.
LayoutOptionsThe {get} pseudo-function returns the value of LayoutOptions, the list of multi-layout options for the object.
LayoutVariableThe {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.
LineStyleGets the LineStyle property of the tree:
LinkColumnsStores 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:
LinkedFieldDataTypesThe {get} pseudo-function returns the value of LinkedFieldDataTypes.
LinkedFieldFormatsThe {get} pseudo-function returns the value of LinkedFieldFormats.
ListItemPairsThe {get} pseudo-function returns the value of ListItemPairs.
LoadedByRouterThe {get} pseudo-function returns the value of LoadedByRouter. That value is true if the XML and Schema have already been loaded by the router.
LogFileThe {get} pseudo-function returns the value of LogFile.
LogicalObjectNameThe {get} pseudo-function returns the value of LogicalObjectName. Defines a temporary, scoped xp macro for the purpose.
LogicalVersionThe {get} pseudo-function returns the value of LogicalVersion. Defines a temporary, scoped xp macro for the purpose.
LogicBufferReturns the handle of the data-logic table, if possible.
LogicalObjectNameCalls 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.
LookupFilterValueReturns gcLookupFilterValue, the filter value set.
LookupHandleThe {get} pseudo-function returns the value of LookupHandle.
LookupImageThe {get} pseudo-function returns the value of LookupImage.
LookupQueryThis 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
MaintenanceObjectThe {get} pseudo-function returns the value of MaintenanceObject.
MaintenanceSDOThe {get} pseudo-function returns the value of MaintenanceSDO.
ManualAddQueryWhereThe {get} pseudo-function returns the value of ManualAddQueryWhere. This value is reapplied by the filter when needed to ensure the original query remains intact.
ManualAssignQuerySelectionThe {get} pseudo-function returns the value of ManualAssignQuerySelection. This value is reapplied by the filter when needed to preserve the original query.
ManualSetQuerySortThe {get} pseudo-function returns the value of ManualSetQuerySort. This value is reapplied by the filter when needed to preserve the original query.
MapNameProducerThe {get} pseudo-function returns the value of MapNameProducer.
MapObjectProducerThe {get} pseudo-function returns the value of MapObjectProducer.
MapTypeProducerThe {get} pseudo-function returns the value of MapTypeProducer.
MarginPixelsThe {get} pseudo-function returns the value of MarginPixels, the number of pixels to reserve for the Panel margin used by resizeObject.
MasterDataObjectThe {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.
MaxWidthThe {get} pseudo-function returns the value of MaxWidth. That value is the maximum width of the browse when CalcWidth is TRUE.
MenuThe {get} pseudo-function returns the value of Menu, TRUE if a menu is to be generated.
MenuMergeOrderThe {get} pseudo-function returns the value of MenuMergeOrder. This value decides the order in which menus will be merged with other toolbar instances.
MessageTypeThe {get} pseudo-function returns the value of MessageType.
MinHeightThe {get} pseudo-function returns the value of MinHeight.
MinWidthThe {get} pseudo-function returns the value of MinWidth.
MultiInstanceActivatedThe {get} pseudo-function returns the value of MultiInstanceActivated.
MultiInstanceSupportedThe {get} pseudo-function returns the value of MultiInstanceSupported.
NNameListThe {get} pseudo-function returns the value of NameList.
NameSpaceHandleThe {get} pseudo-function returns the value of NameSpaceHandle. That value is the handle of the loaded XML mapping schema namespaces.
NavigationSource1.) 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.
NavigationSourceEventsThe {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.
NavigationTargetThe {get} pseudo-function returns the value of NavigationTarget.
NavigationTargetEventsThe {get} pseudo-function returns the value of NavigationTargetEvents, a comma-separated list of the events this object wants to subscribe to in its NavigationTarget.
NavigationTargetNameThe {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.
NewNode1.) 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.
NewRecordThe {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"
.NewRow1.) 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.
NextNodeKeyReturns a unique code to be used for the Key attribute of the Treeview.
NodeExpandedExpands or collapse a node according to the argument passed.
NumDownThe {get} pseudo-function returns the value of NumDown. That value is the number of rows that are displayed DOWN in the browse.
NumRowsThe {get} pseudo-function returns the value of NumRows, the number of rows to display in the selection widget.
OObjectEnabledReturns a flag to indicate whether the current object is enabled.
ObjectHiddenThe {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.ObjectInitializedThe {get} pseudo-function returns the value of ObjectInitialized, TRUE if this object has been initialized.
ObjectLayoutThe {get} pseudo-function returns the value of ObjectLayout, the current Layout Name for the object.
ObjectMappingThe {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.
ObjectModeReturns the mode of the object. Valid values are:
ObjectNameThe {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.
ObjectPageThe {get} pseudo-function returns the value of ObjectPage, the logical page on which this object has been placed.
ObjectParent1.) 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.
ObjectTypeThe {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.ObjectVersionThe {get} pseudo-function returns the value of ObjectVersion, the ADM version of the SmartObject.
OLEDragReturns the value of OLEDrag, TRUE if drag is supported.
OLEDropReturns the value of OLEDrop, TRUE if drop is supported.
OpenOnInitThe {get} pseudo-function returns the value of OpenOnInit, which determines whether queries should be opened at initialization.
OpenQuery1.) 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.
OperatorThe {get} pseudo-function returns the value of Operator, the default when OperatorStyle is
"
Implicit"
.OperatorLongValuesThe {get} pseudo-function returns the value of OperatorLongValues, a list of operators and long text.
OperatorStyleThe {get} pseudo-function returns the value of OperatorStyle. There are four valid values:
OperatorViewAsThe {get} pseudo-function returns the value of OperatorViewAs. This value is the view-as type used to define the operator when OperatorStyle equals "Explicit".
OptionalThe {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.
OptionalBlankThe {get} pseudo-function returns the value of OptionalBlank, TRUE if the optional value is a blank value. Applies to character fields only.
OptionalStringThe {get} pseudo-function returns the value of OptionalString. This is displayed as an optional value when the Optional property is set to TRUE.
OutMessageSourceThe {get} pseudo-function returns the value of OutMessageSource.
OutMessageTargetThe {get} pseudo-function returns the value of OutMessageTarget.
PPageNTargetThe {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.
PageSourceThe {get} pseudo-function returns the value of PageSource. This is the handle of the object’s folder, if any.
PanelFrameThe {get} pseudo-function returns the value of PanelFrame. This is the Frame handle of the SmartPanel, for resizeObject.
PanelLabelThe {get} pseudo-function returns the value of PanelLabel. This is the handle of the Panel’s Label, if any.
PanelStateReturns the value of PanelState, the current state of the SmartPanel. The {get} syntax is not used here.
PanelTypeThe {get} pseudo-function returns the value of PanelType, the type of SmartPanel (’Update’, ’Navigation’)
ParentReturns some parent
ParentDataKeyThe {get} pseudo-function returns the value of ParentDataKey.
ParentFieldThe {get} pseudo-function returns the value of ParentField.
ParentFilterQueryThe {get} pseudo-function returns the value of ParentFilterQuery.
PassThroughLinksReturns 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.PersistencyThe {get} pseudo-function returns the value of Persistency.
PhysicalObjectNameThe {get} pseudo-function returns the value of PhysicalObjectName.
PhysicalVersionThe {get} pseudo-function returns the value of PhysicalVersion.
PingIntervalThe {get} pseudo-function returns the value of PingInterval.
PrimarySdoTargetThe {get} pseudo-function returns the value of PrimarySdoTarget.
PriorityThe {get} pseudo-function returns the value of Priority.
PromptLoginThe {get} pseudo-function returns the value of PromptLogin.
PropertyReturns the specified property for some node:
- BACKCOLOR — The background color of the node
- BOLD — Whether the node is bold
- CHECKED — Whether the node is checked
- CHILD — The first child node
- CHILDREN — The number of children of the node
- COUNT — The number of nodes in the tree
- EXPANDED — Whether the node is expanded or collapsed
- FIRSTSIBLING — The first sibling of the node
- FORECOLOR — The foreground color of the note
- FULLPATH — The full path of the node
- GETVISIBLECOUNT — The number of visible nodes
- IMAGE — The image (contained in imagelist) for the node
- INDEX — The index of the node
- KEY — The unique key of the node
- LASTSIBLING — The last sibling of the node
- PARENT — The parent of the node
- NEXT — The next node key
- PATHSEPARATOR — The delimiter returned by the FullPath property
- PREVIOUS — The previous node key
- ROOT — The root of the node
- SELECTEDITEM — The selected node
- SORTED — Whether the children of the node are sorted
- TAG — The tag of the specified node.
- TEXT — The label text of the specified node
- VISIBLE — Whether the entire tree is visible/invisible
PropertyDialogThe {get} pseudo-function returns the value of PropertyDialog, the name of the dialog procedure that sets InstanceProperties.
PropertyListSets a list of properties taken from a CHR(3)-delimited list of
Q“
prop CHR(4) value”
pairs.QueryColumnsThe {get} pseudo-function returns the value of QueryColumns.
QueryContainerThe {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.
QueryContextInternal function, developed for use in generic calls. The {get} pseudo-function returns the value of QueryContext on the client.
QueryEmptyChecks if the data source or query is empty.
QueryHandleThe {get} pseudo-function returns the value of QueryHandle.
QueryObjectReturns a flag that indicates whether this object manages its own database query.
QueryOpenReturns TRUE if the Query Object’s database query is currently open.
QueryPosition1.) 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.
QueryRowIdenThe {get} pseudo-function returns the value of QueryRowIdent, a RowIdent to be used to position an SDO query when it is first opened.
QueryRowObjectThe {get} pseudo-function returns the value of QueryRowObject. That value is the handle of the RowObject temp-table associated with the Browse’s query.
QuerySortReturns the sort phrase.
QueryStringThe {get} pseudo-function returns the value of QueryString, the attribute used as working storage for all query manipulation methods.
QueryTablesThe {get} pseudo-function returns the value of QueryTables.
QueryWhere1.) 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.
RRebuildOnReposThe {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.
RecordStateThe {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"
.ReEnableDataLinksThe {get} pseudo-function returns the value of GetReEnableDataLinks.
RefreshRefreshes the treeview.
RefreshListReturns a comma-separated list of the names of the Dynamic Combos to be refreshed for the parent Combo named in the argument.
ReplyReqListThe {get} pseudo-function returns the value of ReplyReqList.
ReplyRequiredThe {get} pseudo-function returns the value of ReplyRequired.
ReplySelectorThe {get} pseudo-function returns the value of ReplySelector.
ReplySelectorListThe {get} pseudo-function returns the value of ReplySelectorList.
RepositionDataSourceThe {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.
ResizeHorizontalThe {get} pseudo-function returns the value of ResizeHorizontal, TRUE if the object can be resized in X.
ResizeVerticalThe {get} pseudo-function returns the value of ResizeVertical, TRUE of the object can be resized in Y.
RootNodeParentKeyReturns 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.
RouterSourceThe {get} pseudo-function returns the value of RouterSource.
RouterTargetThe {get} pseudo-function returns the value of RouterTarget. The {set} pseudo-function sets a new value for RouterTarget.
RowReturns the height of the object. Use repositionObject to set the Row.
RowIdent1.) 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
“
one”
side 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.RowidsGets the ROWID(s) of the current row or rows.
RowObject1.) The value of RowObject, the handle of the RowObject Temp-Table buffer.
2.) The handle to the Browser’s temp-table definition.
RowObjectState1.) 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.
RowObjectTableThe temp-table handle of the RowObject table. Note:
RowObjUpdThe {get} pseudo-function returns the value of the RowObjUpd property. This value is the handle of the temp-table buffer where updates are stored.
RowObjUpdTableThe {get} pseudo-function returns the value of RowObjUpdTable property. This value is the handle of the RowObjUpd temp-table.
RowsToBatchThe value of RowsToBatch, the number of rows to be transferred from the database query into the RowObject temp-table in a single operation.
RunAttributeThe {get} pseudo-function returns the value of RunAttribute.
RunDOOptionsThe {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:
- dynamicOnly – Runs dynamic data objects only and supersedes all other options.
- sourceSearch – Searches for source code if r-code is not found.
- clientOnly – Runs proxy (_cl) code only (for both r-code and source code).
If dynamicOnly and/or clientOnly options are used, the container assumes that the Data Object has an AppServer partition defined. If an AppServer partition is not defined and dynamicOnly and/or clientOnly options are used, errors will occur as if the Data Object was being run on an AppServer that had not been started.
RunMultipleThe {get} pseudo-function returns the value of RunMultiple.
SSavedContainerModeThe {get} pseudo-function returns the value of SavedContainerNode.
SavedScreenValueObsolete function replaced by getDisplayValue (which it calls). Otherwise, kept for backwards compatibility.
SaveSourceThe {get} pseudo-function returns the value of SaveSource. This value is TRUE if the TableIO-Source is ‘Save’ but FALSE if (modal) ‘Update’.
SchemaHandleThe {get} pseudo-function returns the value of SchemaHandle, the handle of the loaded XML mapping schema
SchemaListThe {get} pseudo-function returns the value of SchemaList.
SchemaManagerStarts the schema manager, if necessary, and returns its procedure handle.
ScrollGets the Scroll property of the tree. If TRUE, scrollbars appear.
ScrollRemoteThe {get} pseudo-function returns the value of ScrollRemote.
SDFFileNameThe {get} pseudo-function returns the value of SDFFileName.
SDFTemplateThe {get} pseudo-function returns the value of SDFTemplate.
SdoForeignFieldsThe {get} pseudo-function returns the value of SdoForeignFields.
SearchColumns1.) 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.
SearchFieldThe {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.
SecuredThe {get} pseudo-function returns the value of Secured, TRUE if the combo’s security is set to HIDDEN.
SecuredTokensThe {get} pseudo-function returns the value of SecuredTokens, a comma-separated list.
SelectedNodeReturns the key of the selected node.
SelectorsThe {get} pseudo-function returns the value of Selectors.
ServerConnection1.) Returns SESSION:SERVER-CONNECTION-ID through ServerConnection property.
2.) Sets SERVER_CONNECTION_ID property from SESSION:SERVER-CONNECTION-ID.
ServerFileNameReturns 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.
ServerOperatingModeThe {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).ServerSubmitValidationReturns 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.
ShowBorderThe {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.ShowCheckBoxesReturns the value of ShowCheckBoxes, TRUE if there will be check boxes beside each node on the TreeView.
ShowRootLinesReturns the value of ShowRootLines, TRUE if there should be lines leading to the roots of the tree or not.
ShutDownDestThe {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.
SingleSelReturns the value of SingleSel, TRUE if the node is to be expanded when selected or clicked.
SortThe {get} pseudo-function returns the value of Sort, TRUE if the selection is to be sorted.
StartBrowseKeysThe {get} pseudo-function returns the value of StartBrowseKeys, the list of Keylabels or KeyFunctions that starts the browse.
StaticPrefixReturns the prefix used before the action name in static definitions
SubModulesThe {get} pseudo-function returns the value of SubModules.
SubscriptionsThe {get} pseudo-function returns the value of Subscriptions.
SupportedLinksThe {get} pseudo-function returns the value of SupportedLinks, a comma-separated list of the SmartObject links supported by this object.
SupportedMessageTypesThe {get} pseudo-function returns the value of SupportedMessageTypes.
TTableIOButtonsConvert a tableIO recordState to setButton.
TableIOSourceThe {get} pseudo-function returns the value of TableIOSource.
TableIOSourceEventsThe {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.
TableIOTargetThe {get} pseudo-function returns the value of TableIOTarget, a list of the handles, in character format, of the object’s TableIO Targets.
TableiOTargetEventsThe {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.
TableIOType1.) 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.
TableModifierStores 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:
TableRowidsRetrieves 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.TableRows1.) 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:
Tables1.) Returns the value of Tables, a comma delimited list of tables in the Query Objects
- Qualified with database name if the query is defined with dbname.
- From Version 9.1B, this property is a design time property while it earlier was resolved from the actual query. This was very expensive as the function then always needed to be resolved on the server and it is rather extensively used.
- There is currently no way to change the order of the tables at run time. But it would be even more important to have this as a property if the order of the tables were changed dynamically, because several other properties have table delimiters and are totally dependent on the design time order of this property.
- This does not have an xpTables preprocessor because some web2 objects override getTables().
2.) Overrides to use the property for HTML mapping with no data-source.
3.) Returns a comma-delimited list of tables from which data will be retrieved, either from a SmartDataObject or database.
TargetNameSpaceReturns the XML Schema TargetNameSpace. This defines the XMLNS attribute of the document instance.
TargetProcedureUsed 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 canTimeToLiveTimeToLive represents the time during which the message is considered current and not stale.
ToolbarThe value of Toolbar is TRUE if the toolbar is to be created.
ToolbarAutoSizeThe value of ToolbarAutoSize is TRUE if the toolbar should be auto-sized to the width of the window at runtime.
ToolbarBandsThe {get} pseudo-function returns the value of ToolbarBands, the list of the toolbar bands selected in the Instance Properties.
ToolbarDrawDirectionThe {get} pseudo-function returns the value of ToolbarDirection, the draw direction (
“
horizontal”
or“
vertical”)
of the toolbar.ToolbarHeightPxlCalculates and returns the toolbar height in pixels from the three properties: ToolHeightPXL, ToolbarMarginPxl, and ShowBorder.
ToolbarInitialStateThe {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.
ToolbarParentMenuThe {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.
ToolbarSourceThe value of ToolbarSource, a handle or list of handles.
ToolbarSourceEventsThe {get} pseudo-function returns the value of ToolbarSourceEvents. This value is the list of events to be subscribed to in the Toolbar-Source.
ToolbarTargetThe {get} pseudo-function returns the value of ToolbarTarget, a handle.
ToolbarTargetEventsThe {get} pseudo-function returns the value of ToolbarTargetEvents, the list of events to which this object wishes to subscribe in the Toolbar-Target.
ToolbarWidthPxlThe {get} pseudo-function to obtain the values of ToolMarginPxl, ToolWidthPxl, and ToolMaxWidthPxl. Calculates and returns the toolbar width.
ToolMarginPxlReturns a constant zero at present.
ToolTipThe {get} pseudo-function returns the value of tooltip, the optional tooltip for the selection.
TopOnlyReturns the value of the TOP-ONLY attribute.
TranslatablePropertiesThe {get} pseudo-function returns the value of TranslatableProperties, a comma-separated list.
TreeDataTable1.) 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.
TreeStyleValid values are:
TVControllerSourceThe {get} pseudo-function returns the value of TVControllerSource, the handle of the procedure controlling this TreeView.
TVControllerTargetThe {get} pseudo-function returns the value of TVControllerTarget.
TVControllerTargetEventsThe {get} pseudo-function returns the value of TVControllerTargetEvents. This is the list of target events to which this controller will subscribe.
TypeNameThe {get} pseudo-function returns the value of TypeName.
UUIBModeReturns 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.UpdatableColumns1.) 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.
UpdateActiveThe {get} pseudo-function returns the value of UpdateActive, TRUE if ANY of the contained objects have active updates.
UpdateFromSourceThe {get} pseudo-function returns the value of UpdateFromSource, TRUE if this object should be updated as one-to-one of the datasource updates.
UpdateMode1.) 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.UpdateSource1.) 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.
UpdateTargetThe {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.
UpdateTargetNamesThe {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.
UseBeginsThe {get} pseudo-function returns the value of UseBegins. This value is true when BEGINS is supposed to be used for character tests.
UseColumnLabelsStores 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:
UseContainsThe {get} pseudo-function returns the value of UseContains. This value is true when Contains is supposed to be used as operator for character values.
UseDBQualifierReturns TRUE if table references are qualified with database.
UseDTDReturns TRUE if DTD is to be used.
UsePairedListChecks 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.
UserPropertyRetrieves the value of a dynamically defined property.
- In addition to properties for which storage in the property temp-table is defined, in addition to specific get and set functions, it is possible for application code to define a property at run time simply by giving it a name and a value. This function returns the value of such a property.
- LIMITATION: You cannot set or get user-defined properties in an application running in n-tier (client and AppServer) mode.
- Dynamically defined properties are currently stored in a list in the ADM–DATA procedure attribute, delimited by CHR(3), with CHR(4) between property name and value. However, it should not be necessary for developers to be aware of the specific storage mechanism for dynamically defined properties, which could be subject to change in the future.
UseRepositoryReturns TRUE iff Dynamics is running and the Repository is therefore available.
UserNameAReturns some parent
VValidateOnLoadThe {get} pseudo-function returns the value of ValidateOnLoad: whether the document should be validated on load.
ValidKeyReturns TRUE if some key is valid
ViewAsThe {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’.
ViewAsFieldsNot currently used. The {get} pseudo-function returns the value of ViewAsFields.
ViewerLinkedFieldsThe {get} pseudo-function returns the value of ViewerLinkedFields.
ViewerLinkedWidgetsThe {get} pseudo-function returns the value of ViewerLinkedWidgets.
VisibleRowidsThe {get} pseudo-function returns the value of VisibleRowids.
VisibleRowResetThe {get} pseudo-function returns the value of VisibleRowReset.
VisualBlankThe {get} pseudo-function returns the value of VisualBlank. This value is used to visualize searching for BLANK values.
WWaitForObjectThe {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.
WaitingThe {get} pseudo-function returns the value of Waiting. That value determines when waitForMessages is satisfied.
WebState1.) Returns a Web object’s Web state. Possible values are state–aware, state–less, timed–out. For example:
2.) Sets the Web object’s Web state to state–aware and its timeout. The number of minutes to remain state–aware. For example:
WebTimeoutReturns a state–aware Web object’s timeout in minutes. For example:
WebTimeRemainingReturns the time remaining for a state–aware Web object. For example:
WebToHdlr1.) 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:
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:
WidthReturns the width of the object.
WindowReturns the handle of the toolbar’s parent Window.
WindowFrameHandleThe {get} pseudo-function returns the value of WindowFrameHandle. This value is the handle of the optional Frame widget of a Window container.
- This property ONLY identifies the frame of a window container. It must not be confused with the important ContainerHandle, which is the widget handle of the container in all object. In most cases the ContainerHandle will be the Frame handle also for a SmartContainer.
- Even if Window containers do not need a frame they often have one and in that case we must include it when, for example, resizing, widget-tree logic, etc.
WindowTitleFieldThe {get} pseudo-function returns the value of WindowTitleField.
WindowTitleViewerThe {get} pseudo-function returns the value of WindowTitleViewer.
WordIndexedFields1.) 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 |