Quick Reference |
Object Properties List |
This section lists the properties that are accessible at runtime. For descriptions of properties (listed alphabetically), including their values and constraints, refer to Table 1-3. Properties can be categorized as follows:
Property Descriptions |
Table 1-3 Property definitions, valid values, and constraints
Accessing Properties |
objectName
->propertySpec
or
@objectModifier(objectIdentifier
)->propertySpec
The object modifiers and their arguments are described in the table below. Values for the object identifiers are either integers or strings, and can be in the form of variables, expressions, or quoted text for string values.
In JPL, access the properties via:
objectSpec->propertySpec
where propertySpec
is specified as either:
@screen("@current")->title
myscreen->title
or, similarly:
@screen("myscreen")->@property("title")
myscreen->@property("title")
If the property is an array, specify the occurrence:
In widget arrays, subscripted references return the value of the specified occurrence To get portions of an object's value, append substring specifiers to the object's reference. For example, this statement gets the first eight characters from customer's second occurrence:
In C, access the properties via:
Arrays
pkey2 = tapes->primary_key[2]
[
n
]
or array element [[
n
]]
; non-subscripted references return the first element. Thus, these two statements put the same data into variable cust
cust = @widget("customer")[[1]]
cust = @widget("customer")cust = @widget("customer")[2](1, 8)
C Functions
The property constants used in the C functions are derived by converting the property name to upper case and prepending The following example returns the value of the hidden property for the For more information on accessing properties, refer to "Setting Properties Using the Property API," in Application Development Guide.
Properties marked with §, as in sm_prop_id
is not needed for the application or for the current screen. Use PR_APPLICATION
as the object ID for the application; PR_CURSCREEN
for the current screen.
PR_
. For example, the equivalent constant for max_occurrences
is PR_MAX_OCCURRENCES
. There are a few exceptions; those properties are marked with a § in the property categories.
cust_id
widget on the custlist
screen:
int objid, val;
objid = sm_prop_id ("@screen('custlist')!@widget('cust_id')");
val = sm_prop_get_int(objid, PR_HIDDEN);poll_frequency
§, have a different C constant. See the main section.
Application Properties |
@app()->property
Screen and Frameset Properties |
screenName
->property
@screen("screenName
")->property
@screen("@current")->property
@screen_num(windowStackPosition
)->property
@ldb("ldbName
")->property
XML Properties |
Service Component Properties |
Service Request Properties |
@tp_req(callid
)->property
@tp_req("@current")->property
Widget Properties |
widgetName
->property
If the widget's name is not unique in the current namespace:
@widget("widgetName
")->property
@widget("@current")->property
@field_num(widgetFieldNum
)->property
Splitter Properties |
widgetName
->property
@widget("widgetName
")->property
@widget("@current")->property
Pane Properties |
widgetName
->property
@widget("widgetName")->property
@widget("@current")->property
ActiveX Control Properties |
widgetName
->property
@widget("widgetName
")->property
@widget("@current")->property
@widget("widgetName
")->ax_ActiveX_property
@widget("@current")->ax_ActiveX_property
In the Editor, the Control Props category (under ActiveX) shows the ActiveX control's properties.
Selection Group Properties |
widgetName
->property
@widget("widgetName
")->property
@widget("@current")->property
Synchronized Scrolling Group Properties |
widgetName
->property
@widget("widgetName
")->property
@widget("@current")->property
Table View Properties |
widgetName
->
property
@widget(
"widgetName
")->
property
@widget("@current")->
property
Link Widget Properties |
widgetName
->property
@widget("widgetName
")->property
@widget("@current")->property
Reports Properties |
nodeName
->property
@widget("nodeName
")->property
root§
area§
Properties marked with §, as in poll_frequency
§, have a different C constant. See the main section.
Mail Properties |
@id(PR_MAIL_SYSTEM)->property
@id(messageObjectID)->property
mailName->property