Quick Reference


Chapter 1. Runtime Properties


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-1 Objects legend

Abbreviation Object

App

Application

Fset

Frameset

Link

Link widget

Mail

Mail object

Menu

Menu/toolbar

Pane

Pane

Rpt

Report

Scr

Screen

Sel

Selection group

Spl

Splitter

SrvCom

Service component

SrvReq

Service request

Sync

Synchronized scrolling group

TV

Table view widget

Wdg

Widget

Table 1-2 Constraints Legend

Constraint Description

RT

Runtime only; not accessible in the editor

RO

Read only; cannot be changed

Svr

Server only

ClntAgnt

Client agent only (client or server that has made a service call)

JN

Applies only to JetNet applications

Tux

Applies only to Oracle Tuxedo applications

WAS

Applies only to Panther/WebSphere applications

CM

Applies only to character-mode applications

GUI

Applies only to GUI applications

RT

Runtime only; not accessible in the editor

RO

Read only; cannot be changed

Svr

Server only

Table 1-3 Property definitions, valid values, and constraints

Property Description Object Value Constraint

active

Widget state: active, so it can respond to user interaction, or inactive.

Wdg

PV_YES

PV_NO

widget_type = PV_DYNAMIC_LABEL |

PV_PUSH_BUTTON |

PV_RADIO_BUTTON |

PV_CHECK_BOX |

PV_TOGGLE_BUTTON

active_pixmap

Name of image file to display on widget.

Wdg

str

GUI, Web,

widget_type =

PV_PUSH_BUTTON |

PV_RADIO_BUTTON |

PV_CHECK_BOX |

PV_TOGGLE_BUTTON |

PV_STATIC_LABEL |

PV_DYNAMIC_LABEL

agent_type

Three-tier client, server, or two-tier client.

App

PV_CLIENT

PV_SERVER

PV_STANDALONE

RT, RO

all_protect

Set or unset all protection properties: clearing_protect, input_protection, focus_protection, no_validation.

Wdg

PV_YES

PV_NO

RT

If these properties have been set individually to different settings, all_protect returns PV_NO. Changing all properties to PV_NO with all_protect only occurs if they were previously all set to PV_YES.

alt_next_tab_stop

Name of widget or group that should be accessed if the object named in next_tab_stop does not exist at runtime.

Wdg

SelGrp

str

No Web, next_tab_stop = widgetName

alt_prev_tab_stop

Name of widget or group that should be accessed if the object named in prev_tab_stop does not exist at runtime.

Wdg

SelGrp

str

No Web, prev_tab_stop = widgetName

alt_scroll_func

Name of function to invoke custom scroll function for an array.

Wdg

str

application_font

Change Application Font from the [Prolifics Fonts] section of the Windows initialization file.

App

str

Windows

area

Name of report's layout area. (C constant PR_RW_ACTION_STRING)

Wdg
(Rpt)

str

argc

Number of program arguments not including internal arguments like -ini and -debug.

App

int

prorun and prodev

argv[int]

Program arguments; argv[1] is the program name.

App

str

prorun and prodev

armed_pixmap

Name of image file to display on widget when it is armed (pushed, selected, or checked).

Wdg

str

GUI, Web, active_pixmap=filena me and widget_type = PV_PUSH_BUTTON | PV_RADIO_BUTTON | PV_CHECK_BOX | PV_TOGGLE_BUTTON

array_size

Wdg: Number of visible onscreen rows

Wdg

int

widget_type = PV_DYNAMIC_LABEL | PV_SINGLE_LINE_TEXT | PV_PUSH_BUTTON | PV_TOGGLE_BUTTON | PV_RADIO_BUTTON | PV_CHECK_BOX

See onscreen_rows property

Sync: Number of onscreen rows for synchronized scrolling group.

Sync

int

attributes

HTML attributes to add to the <INPUT> tag.

Wdg

str

Web

auto_expand

Whether or not grid widget expands to include all rows.

Wdg

PV_YES

PV_NO

Web, widget_type = PV_GRID_FRAME

auto_help

Whether or not a help screen displays on widget entry or by user request (choose Help).

Wdg

PV_YES

PV_NO

No Web, help_screen = screenName

auto_horiz_resize

Whether or not widget resizes horizontally when screen (resizeable = PV_YES) is resized at runtime.

Wdg

PV_YES

PV_NO

GUI, widget_type = PV_LIST_BOX | PV_GRID_FRAME | PV_SINGLE_LINE_TEXT | PV_MULTILINE_TEXT | PV_HORIZONTAL_LINE | PV_GRAPH

auto_item

Whether or not a selection screen is displayed on widget entry or by user request (press ITSEL key or choose Help).

Wdg

PV_YES

PV_NO

No Web, selection_screen = screenName

auto_vert_resize

Whether or not widget resizes vertically when screen (resizeable = PV_YES) is resized at runtime.

Wdg

PV_YES

PV_NO

GUI, widget_type = PV_LIST_BOX | PV_MULTILINE_TEXT | PV_GRID_FRAME | PV_VERTICAL_LINE | PV_GRAPH

auto_resize_ex_paths

When set to PV_YES, autoresize will allow widgets of different heights to resize together when they are on the same path. See General Rules for Resizing at Runtime for more information about how autoresize works.

App

PV_YES

PV_NO

GUI New in Panther 5.51.

auto_resize_no_touch

When set to PV_YES, changing the height or width of a screen programmatically will cause automatically resizable widgets on that screen to get resized.

App

PV_YES

PV_NO

GUI New in Panther 5.51.

autotab

Force focus to move to next widget when user enters the required data or makes a selection.

Wdg

PV_YES

PV_NO

widget_type = PV_SINGLE_LINE_TEXT | PV_MULTILINE TEXT | PV_OPTION MENU | PV_COMBO_BOX | PV_GROUP

bar_chart_type

Type of bar chart graph.

Wdg

PV_ABSOLUTE

PV_STACK

PV_STEP

PV_100

V_OVERLAP

GUI, Web, chart_type = PV_BAR

bar_style

Graphical style for displaying data values in bar chart graph.

Wdg

PV_BAR, PV_LINE, PV_CURVE, PV_POINT, PV_TREND, PV_AREA

GUI, Web, chart_type = PV_BAR and y_value_source[int] = str

bg_color_name

Background extended color (platform-specific) name.

Scr Wdg

str; Can be name, RGB value, or alias name defined in cmap file.

bg_color_type = PV_EXTENDED

bg_color_num

Numeric designation of background color corresponding to a Panther basic color.

Scr

int; corresponds to Panther basic color: B_BLACK, B_BLUE, B_GREEN, B_CYAN, B_RED, B_MAGENTA, B_YELLOW, B_WHITE

bg_color_type = PV_BASIC

bg_color_type

Background color type: basic, GUI-specific, or scheme as defined in cmap file.

Scr Wdg

PV_BASIC

PV_EXTENDED

PV_SCHEME

bi_status[int]

Get before-image status of specified row(s). Can indicate if row was fetched from database, if row was empty (indicating occurrence was inserted by user), or if row was edited.

TV

PV_BI_FETCHED

PV_BI_EMPTY

PV_BI_CHANGED

RT, RO

bi_string

Widget's before-image occurrence. Specify for a widget occurrence, i.e., widget[occ]->bi_string.

Wdg

str

RT, RO

blink

Object's blink attribute. For widget, applies to text or label.

Scr

Wdg

PV_YES, PV_NO

CM, (Scr) border_fg_color_type = PV_BASIC

(Wdg) bg_color_type = PV_BASIC

body_attributes

Modify HTML by specifying HTML attributes to add to the <BODY> tag.

Scr

SrvCom

str

Web

bold

Bold font style attribute.

App

Scr

Wdg

PV_DEFAULT

PV_YES

PV_NO

Has no effect if font_name does not have a bold qualifier or if it is only available in a bold style.

border

Whether or not object has border. For Web screens, PV_NO allows widgets to position next to the browser window's borders (see also title_bar and system_menu properties).

Scr

Wdg

PV_YES

PV_NO

CM, Motif, Web only, widget_type = PV_LIST_BOX | PV_MULTILINE_TEXT

border_bg_color_name

Background color name (platform-specific) for screen border.

Scr

str

CM, border_bg_color_type = PV_EXTENDED

border_bg_color_num

Panther basic background color for screen border.

Scr

int; corresponds to Panther basic color

CM, border_bg_color_type = PV_BASIC

border_bg_color_type

Background color type: Panther basic, GUI-specific, or scheme (defined in cmap file).

Scr

PV_BASIC

PV_EXTENDED

PV_SCHEME

CM, border = PV_YES

border_fg_color_name

Foreground color name (platform-specific) for screen border.

Scr

str

CM, border_fg_color_type = PV_EXTENDED

border_fg_color_num

Panther basic foreground color for screen border.

Scr

int; corresponds to Panther basic color

CM, border_fg_color_type = PV_BASIC

border_fg_color_type

Foreground color type for screen border: Panther basic, GUI-specific, or scheme (defined in cmap file).

Scr

PV_BASIC

PV_EXTENDED

PV_SCHEME

CM, border = PV_YES

border_style

Screen border style.

Scr

PV_STYLE_0 ... PV_STYLE_9; corresponds to Panther line styles.

CM, border = PV_YES

break_on

Name of report\Qs break field (begin new grouping when this field changes). (C constant PR_RW_GROUP_FIELD)

Rpt

str

c_type

Object's data type for use by database drivers.

SelGrp Wdg

PV_DEFAULT

PV_OMIT

PV_CHAR_STRING

PV_INT

PV_UNSIGNED_INT

PV_SHORT_INT

PV_LONG_INT

PV_FLOAT

PV_DOUBLE

PV_ZONED_DEC

PV_PACKED_DEC

PV_HEX_DEC

calculation

Math expressions, separated by a semicolon.

Wdg

str

No Web

call_client

Unique client ID associated with service request; accessible from servers, and only for service call made directly by client.

SrvReq

str

JN/Tux Svr; RO

call_in_transaction

Whether or not service is within a transaction; accessible from servers, and only for service call made directly by a client.

SrvReq

PV_YES

PV_NO

Tux Svr; RO

call_initial_text

Command text which initiated this service request.

SrvReq

str

JN/Tux ClntAgnt; RO

call_no_reply

Whether or not client expects a reply; accessible from servers, and only for service call made directly by a client.

SrvReq

PV_YES

PV_NO

JN/Tux Svr; RO

call_origin

Screen name from which request was initiated.

SrvReq

str

JN/Tux ClntAgnt; RO

call_priority

Priority of service request; accessible from servers, and only for service call made directly by a client.

SrvReq

int (1 .. 100); higher value has increased priority.

JN/Tux Svr; RO

call_security_key

Client authentication key if authentication server is used in the application; accessible from servers, and only for service call made directly by a client.

SrvReq

long; higher value has increased priority.

Tux Svr; RO

call_svc_alias

Service alias associated with request.

SrvReq

str

JN/Tux; RO

call_svc_name

Service name associated with request.

SrvReq

str

JN/Tux; RO

call_text

Command text of most recent middleware command that operated on this request.

SrvReq

str; initial value is same as call_initial_text property

JN/Tux ClntAgnt; RO

card

Identify widget's tab card, if widget is in a tab deck.

Wdg

objid; if widget is not in a tab deck, returns "".

Windows, Motif; RT, RO

card_entry_func

Name of function to invoke when a tab card gains focus.

Wdg

str

Windows, Motif; widget_type = PV_CARD

card_exit_func

Name of function to invoke when a tab card loses focus.

Wdg

str

Windows, Motif; widget_type = PV_CARD

card_number

Numeric sequence of tab card within a tab deck from left to right.

Wdg

int; 1 is leftmost card.

Windows, Motif; widget_type = PV_CARD

chart_3d

Whether or not a graph displays in 3D perspective. (C constant PR_3D)

Wdg

PV_YES

PV_NO

GUI, Web, widget_type = PV_GRAPH

chart_type

Graph style.

Wdg

PV_PIE

PV_BAR

PV_XY_PLOT

PV_HIGH_LOW

GUI, Web, widget_type = PV_GRAPH

child

Name of child table view of link relationship.

Link

str

Writable only if TM transaction is not in progress

child[int]

Name of child table view in specified table view and corresponding to specified occurrence.

TV

str

RT, RO

circular

Whether circular scrolling is in effect in an arrayed widget, i.e., first to last occurrence and vise versa.

Wdg

PV_YES

PV_NO

scrolling = PV_YES

class

Transaction class name to which widget belongs; defines widget appearance and behavior in specific transaction modes.

Wdg

str; as defined in styles.sty. Can be -none-, -default- or empty. An empty string indicates that the property is set to -default-.

clearing_protect

Prevent data from being cleared (PV_YES) or allow data (PV_NO) to be cleared.

Wdg

PV_YES

PV_NO

widget_type = PV_SINGLE_LINE_TEXT | PV_MULTILINE_TEXT | PV_COMBO_BOX | PV_SCALE | PV_LIST_BOX

clock_type

Whether date/time-specific widget displays 12-hour or 24-hour format.

Wdg

PV_12_HOUR

PV_24_HOUR

data_formatting = PV_DATE_TIME

close_item

Availability of Close item on system menu.

Scr

PV_YES

PV_NO

GUI, Web, system_menu = PV_YES

clsid

Unique identifier for an ActiveX control.

Wdg

str

Web, Windows, widget_type = PV_ACTIVEX

codebase

URL location of the file which downloads an ActiveX control.

Wdg

str

Web, widget_type = PV_ACTIVEX

codeset

Codeset to use when exporting to XML. Also used for generating the encoding attribute when generating HTML. Also used for converting to/from Unicode for Panther's Java API's, when java_use_codeset is set to PV_YES.

App

PV_CP437, PV_CP775,

PV_CP850, PV_CP860,

PV_CP863,PV_CP865,

PV_DEFAULT,

PV_ISO_8859_1,

PV_ISO_8859_2,

PV_ISO_8859_3,

PV_ISO_8859_4,

PV_ISO_8859_5,

PV_ISO_8859_6,

PV_ISO_8859_7,

PV_ISO_8859_8,

PV_ISO_8859_9,

PV_ISO_8859_10,

PV_ISO_8859_13,

PV_ISO_8859_14,

PV_ISO_8859_15,

PV_ROMAN8, PV_UTF8,

PV_WINDOWS_874,

PV_WINDOWS_1250,

PV_WINDOWS_1251,

PV_WINDOWS_1252,

PV_WINDOWS_1253,

PV_WINDOWS_1254,

PV_WINDOWS_1255,

PV_WINDOWS_1256,

PV_WINDOWS_1257,

PV_WINDOWS_1258

column_click_action

Action to occur when the user clicks on the grid column title.

Wdg

PV_NONE

PV_SORT

PV_CUSTOM

Widget must be in a grid widget

column_click_func

Name of custom function to invoke when the user clicks on the grid column title.

Wdg

str

Widget must be in a grid widget; column_click_action = PV_CUSTOM

column_length

Database column length as defined in database.

Wdg

str

RO, currently unused by SQL generator

column_move_resize

Ability to move and resize columns in grid widget at runtime.

Wdg

PV_YES

PV_NO

widget_type = PV_GRID_FRAME

column_name

Name of database column from which widget was derived.

Wdg

str

Writable only if the widget is not part of an existing transaction.

column_precision

Precision (if numeric) of database column as defined in database.

Wdg

str

RO, currently unused by SQL generator

column_scale

Scale (if numeric) of database column as defined in database.

Wdg

str

RO, currently unused by SQL generator

column_separators

Whether vertical lines should display between grid member columns.

Wdg

PV_YES

PV_NO

widget_type = PV_GRID_FRAME

column_title

Title to display in grid widget.

Wdg

str

column_titles

Type of column heading to display at top of grid widget; PV_PER_COLUMN uses content of column_title property.

Wdg

PV_NONE

PV_AUTO_NUMBER

PV_AUTO_LETTER

PV_PER_COLUMN

widget_type = PV_GRID_FRAME

column_type

Column data type as defined in the database.

Wdg

str

RO, currently unused by SQL generator

columns[int]

List of database columns that are in database table and associated with table view. Used as reference for other properties.

TV

str

Writable only if table view is not part of TM transaction in progress

comments

Enter your own comments.

Scr

Wdg

str

conceal_tabs

Whether card tabs are visible; if PV_YES, user cannot raise cards to top of deck.

Wdg

PV_YES

PV_NO

widget_type = PV_DECK

conn_pool_size

Maximum number of database connections in the connection pool.

App

int

RT; WAS, set on application server, not in method call from client

continue_func_name

Special function to be called for CONTINUE operations.

TV

str

select_handling = PV_HANDLING_FUNC

control_name

Name of the ActiveX control.

Wdg

str

Web, Windows, widget_type = PV_ACTIVEX

control_string

Control string to be executed when widget is activated.

Wdg

str

widget_type = PV_PUSH_BUTTON | PV_LIST_BOX and listbox_type = PV_ACTION

control_string[logkey]

Assign behavior to specified logical key.

App Scr

str

convert_case

Text case conversion.

Wdg

PV_MIXED

PV_UPPER

PV_LOWER

count_result

Number of rows that will be fetched by SELECT. Refer to count_select.

TV

int

RT

count_select

Whether transaction manager counts the number of rows in result set prior to fetching data for SELECT.

TV

PV_YES

PV_NO

count_threshold

Maximum number of rows allowed in result set. If result set exceeds the value, check count_warning and issue prompt before fetching data.

TV

int

count_select = PV_YES, count_warning = PV_YES

count_warning

Whether or not to issue warning for large result set. PV_YES issues warning if number of rows in result set exceeds count_threshold value.

TV

PV_YES

PV_NO

count_select = PV_YES

currency_symbol

One- to five-character currency symbol for monetary data.

Wdg

str

numeric_type = PV_CUSTOM

current_component_syst em

Which component system is currently in use: COM or EJB.

App

PV_SERVER_COM

PV_SERVER_EJB

PV_SERVER_JAVA

RT, COM, WebSphere

current_offset

Horizontal offset in a shifting field. Valid for text input widgets only.

Wdg

PV_YES

PV_NO

RT, widget_type = PV_SINGLE_LINE_TEXT | PV_MULTILINE_TEXT | PV_COMBO_BOX

cursor_and_using

Cursor name to use for fetching data for a report detail node. (C constant PR_RW_CURSOR_AND_USING)

Wdg (Report s)

str

Data Source = Predefined Cursor

custom_format

Date format using combinations of pre-defined date/time variables and punctuation.

Wdg

str

date_format = PV_CUSTOM

customer_drawn

Whether or not a drawing function is installed.

Wdg

PV_YES

PV_NO

GUI; widget_type = PV_PUSH_BUTTON | PV_TOGGLE_BUTTON | PV_DYNAMIC_LABEL

data_basic_color

Color for plotting graphical data.

Wdg

int; corresponds to Panther basic color

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW and y_value_source[int] = str

data_formatting

Data format: date/time, numeric, or none.

Wdg

PV_NONE

PV_DATE_TIME

PV_NUMERIC

data_value_location

Where data values display in relation to graphical data.

Wdg

PV_NONE

PV_IN

PV_OUT

GUI, Web, chart_type = PV_BAR and y_value_source[int] = str

date_format

Date/time format using variables defined in Panther message file.

Wdg

PV_DEFAULT_0 ... PV_DEFAULT_9

PV_CUSTOM

data_formatting = PV_DATE_TIME

decimal_places

Number of decimal places.

Wdg

int

widget_type = PV_SCALE

decimal_symbol

Radix symbol for a custom numeric format.

Wdg

PV_DOTPV_COMMA

numeric_type = PV_CUSTOM

deck

Identify tab deck to which tab card is a member.

Wdg

objid

Windows, Motif; RT, RO, widget_type = PV_CARD

default_cancel

Push button default behavior.

Wdg

PV_NEITHER

PV_BOTH

PV_DEFAULT_BUTTON

PV_CANCEL_BUTTON

No Web; widget_type = PV_PUSH_BUTTON

default_link

URL destination of hyperlink.

Wdg

str

Web; widget_type = PV_DYNAMIC_LABEL | PV_GRAPH

default_row_margin

Amount of space above and below text in grid row if row_margin is not set for the grid widget.

App

int; PV_DEFAULT

GUI; widget_type = PV_GRID_FRAME

default_tran

Name of default transaction; set even if transaction is not open.

Scr

str

RT, RO

del_func_name

Special function to be called for DELETE operations.

TV

str

delete_handling = PV_HANDLING_FUNC

delete_handling

Method for handling DELETE operations.

TV

PV_HANDLING_SQL

PV_HANDLING_FUNC

PV_HANDLING_NOTHING

delete_order

Which table view (parent or child) participates in DELETE statement first.

Link

PV_CHILD_FIRST

PV_PARENT_FIRST

Writable only if link's table views are not part of TM transaction in progress

delete_service

Specifies a service to implement a DELETE operation that removes information from database tables

TV

str

JN, Tux

depth

Depth of 3D object in a graph widget, measured as percentage of widget size.

Wdg

str (0.0 .. 100.0)

GUI, Web, chart_3d = PV_YES

devserv_id

Name of file access server. Defaults to name of host on which server resides.

App

str

RO

di_string[int]

Identifies deleted rows in sequence; i.e., di_string[i]; i from 1 to widget->num_del_images.

Wdg

str

RT, RO

dialog

Defines screen as modal or non-modal window. PV_YES removes Resize, Maximize, and Minimize options from system menu (prevents resize, maximize, or minimize).

Scr

PV_YES

PV_NO

GUI, RO

dim

Low intensity display of widget's text or label.

Scr

Wdg

PV_YES

PV_NO

CM, Scr: border_fg_color_type = PV_BASIC Wdg: fg_color_type = PV_BASIC

display_codepage

Codepage Windows should use to display characters.

App

Valid codepage codes are listed for the codeset property.

GUI Windows New in Panther 5.50.

display_window

Target window in which screen is displayed.

Scr

str

Web

distinct

Whether or not duplicate rows are included or omitted from query results.

TV

PV_YES

PV_NO

double_click

Control string executed when user double-clicks on widget.

Wdg

str

No Web, widget_type = PV_DYNAMIC_LABEL | PV_SINGLE_LINE_TEXT | PV_MULTILINE_TEXT | PV_LIST_BOX | PV_COMBO_BOX

drop_down_data[int]

Data associated with option menu/combo box.

Wdg

str

widget_type = PV_OPTION_MENU | PV_COMBO_BOX drop_down_source = PV_CONSTANT_DATA

drop_down_screen

Name of screen containing data that will populate option menu/combo box.

Wdg

str

widget_type = PV_OPTION_MENU | PV_COMBO_BOX

drop_down_source = PV_EXTERNAL_SCREEN

drop_down_size

Number of visible elements in option menu/combo box drop down list.

Wdg

int

widget_type = PV_OPTION_MENU | PV_COMBO_BOX

drop_down_source

Data source for populating option menu/combo box: constant (static data) or an external screen.

Wdg

PV_CONSTANT_DATA

PV_EXTERNAL_SCREEN

widget_type = PV_OPTION_MENU | PV_COMBO_BOX

drop_down_trim_empty

If PV_YES, trailing empty rows in option menu/combo box drop down list.will be removed

App

PV_YES

PV_NO

GUI Windows

edit_mask

Display and data characters required to define the mask; filters data on user input.

Wdg

str

keystroke_filter = PV_EDIT_MASK

empty_format

Whether or not a format should display when the widget has no data.

Wdg

PV_YES

PV_NO

data_formatting = PV_NUMERIC; to apply a format when widget is empty, zero_format must be PV_YES.

end_column

End-column assignment for box widget.

Wdg

int

widget_type = PV_BOX

end_row

End-row assignment for box widget.

Wdg

int

widget_type = PV_BOX

endsession

Function to call during shutdown processing.

App

str

PV_NULL

Windows

entry_function

Function to call when object gains focus (i.e., when a user tabs or clicks into it).

Scr

Wdg

SelGrp

str

exit_function

Function to call when object loses focus (i.e., when a user tabs or clicks into it).

Scr

Wdg

SelGrp

str

export_to_html

Whether or not widget's value is available to JavaScript operations.

Wdg

PV_YES

PV_NO

Web

expose_function

Name of function to invoke when a tab card becomes the top card on the deck or when the screen opens.

Wdg

str

Windows, Motif; widget_type = PV_CARD

external_help_tag

Context identifying tag used to display corresponding help topic. Identifier is passed to your external help-processing event function.

Scr

Wdg

str

No Web

extra_line_size_check

When set, page length calculations are changed. This can change the placement of page breaks for reports that have long pixmaps.

App

PV_YES

PV_NO

New in Panther 5.50

fetch_directions

Transaction manager's scrolling method for records that can be scrolled up and down: up/down in all modes, default (down only in all modes), down only in all modes, and up/down in view mode.

Scr TV

PV_CONT_ALWAYS

PV_CONT_DEFAULT

PV_CONT_NEVER

PV_CONT_NONE

PV_CONT_VIEW_ONLY

2-tier GUI only

fg_color_name

GUI-specific foreground color.

Wdg

str; name, RGB value, or alias name (as defined in

cmap file).

fg_color_type = PV_EXTENDED

fg_color_num

Panther basic color specified for foreground color.

Wdg

BLACK, BLUE, GREEN, CYAN, RED, MAGENTA, YELLOW, WHITE, HILIGHT | BLACK, HILIGHT | BLUE, HILIGHT | GREEN, HILIGHT | CYAN, HILIGHT | RED, HILIGHT | MAGENTA, HILIGHT | YELLOW, HILIGHT | WHITE

fg_color_type = PV_BASIC

fg_color_type

Foreground color type: Panther basic, GUI-specific color, or scheme color as defined in cmap file.

Wdg

PV_BASIC

PV_EXTENDED

PV_SCHEME

field[int]

Identifies widgets (from 1 to num_fields) in specified table view.

TV

objid; widget name or field number if unnamed.

RT, RO

field_below[int]

App: Identifies widgets (from specified number) participating in current transaction.

TV: Identifies widgets (from 1 to

num_fields_below) in specified server view and in its child table views.

App

TV

objid; widget name or field number if unnamed.

RT, RO

fill_character

Character, such as asterisk, to fill leading or trailing blanks. Character pads field to its maximum length.

Wdg

str

data_formatting = PV_NUMERIC

first_occurrence

First visible occurrence in an array.

Wdg

int

RT

fldnum

Field number of the widget where the cursor is currently positioned.

Scr

Wdg

int

RT, RO

focus_protection

Widget focus protection. PV_YES for grid widget prevents focus on grid members regardless of individual settings; PV_NO honors grid members' focus protection settings. In Web, single line and multiline text widgets having PV_YES value display in bold text.

Wdg

PV_YES

PV_NO

font_name

Font name specification: Panther-specific, locally installed, or graph-specific if object is graph widget.

App

Scr

Wdg

str

GUI

form_attributes

HTML attributes for the <FORM> tag that will modify Panther-generated HTML.

Scr

SrvCom

str

Web

framset

Containing frameset

SCR Fset

Spl Pane

name of containing frameset in JPL; otherwise, the frameset's object ID

frequency

How often, in seconds, system date/time is updated.

Wdg

int

system_update = PV_YES

frozen_columns

Number of columns that remain stationary when user tabs or shifts columns horizontally.

Wdg

int

widget_type = PV_GRID_FRAME

function

Transaction manager event function to invoke for this table view in order to change processing associated with transaction event.

TV

str

function_call

Function call text for a report. (C constant PR_RW_ACTION_STRING)

Wdg (Reports)

str

grid

Identifies grid widget to which specified widget belongs.

Wdg

str; name of grid widget if the object is a grid member; empty string if object is not a grid member or is a grid widget; object ID (@id()) if grid widget is unnamed.

grid_column

Widget's column position in a grid widget.

Wdg

int

grid != ""

grid_current_occ

Grid widget's current (or selected) occurrence.

Wdg

int

RT, RO

grid_height

Height of grid cell in screen's positioning grid; measured in grid units (g) by default, characters (c), inches (in), millimeters (mm), or pixels (p).

Scr

str; pixel values must be whole numbers; otherwise, fractional values are permitted.

No Web, In CM, grid dimensions are fixed–each character occupies one cell

grid_width

Width of grid cell in screen's positioning grid, measured in grid units (g) by default, characters (c), inches (in), millimeters (mm), or pixels (p).

Scr

str; pixel values must be whole numbers; otherwise, fractional values are permitted.

No Web, In CM, grid dimensions are fixed–each character occupies one cell

group

Identifies group to which widget is a member.

Wdg

str; name of the group if named; empty string if the object is not a group member; object ID (@id()) if the group is unnamed.

RT

group_by

Names of the widgets whose values are used to group data in SELECT statement.

Wdg

str

having

Additional search condition for having-condition of SELECT statement.

Wdg

str

hdl_advertise

Name of current advertise event handler. Empty string assignment reinstates default built-in advertise event handler.

App

str

JN/Tux only; RT

hdl_exception

Name of current exception event handler. Empty string assignment reinstates default built-in exception event handler.

App

str

JN/Tux only; RT

hdl_jif_changed

Name of current jif_changed event handler. Empty string assignment reinstates default built-in jif_changed handler.

App

str

JN/Tux only; RT

hdl_message

Name of current message event handler. Empty string assignment reinstates built-in default message event handler.

App

str

JN/Tux only; RT

hdl_post_request

Name of current post_request event handler. Empty string assignment reinstates built-in default post_request handler.

App

str

JN/Tux only; RT

hdl_post_service

Name of current post_service event handler. Empty string assignment reinstates built-in default post_service handler.

App

str

JN/Tux only; RT

hdl_pre_request

Name of current pre_request event handler. Empty string assignment reinstates built-in default pre_request handler.

App

str

JN/Tux only; RT

hdl_pre_service

Name of current pre_service event handler. Empty string assignment reinstates built-in default pre_service handler.

App

str

JN/Tux only; RT

hdl_request_received

Name of current request_received event handler. Empty string assignment reinstates built-in default request_received handler.

App

str

JN/Tux only; RT

hdl_server_exit

Name of current server_exit event handler. Empty string assignment reinstates built-in default server_exit handler.

App

str

JN/Tux only; RT

hdl_unadvertise

Name of current unadvertise event handler. Empty string assignment reinstates built-in default unadvertise handler.

App

str

JN/Tux only; RT

hdl_unload

Name of current unload event handler. Empty string assignment reinstates built-in default unload event handler.

App

str

JN/Tux only; RT

head_markup

HTML markup to modify

<HEAD> tag in Panther-generated HTML.

Scr SrvCom

str

Web

height

Vertical size of object.

Scr SrvCom Wdg

str

No Web

help_screen

Name of help screen; invoked if help is requested when screen or widget has focus.

Scr Wdg

str

No Web

hidden

Whether or not widget is hidden. In a tab card, the card's tab is affected. In Web application, HTML tags are not generated for hidden widgets (values PV_YES or PV_ALWAYS). To generate HTML tag for hidden widgets, set export_to_html = PV_YES.

Wdg

PV_YES

PV_NO

PV_ALWAYS

hide_function

Name of function to invoke when the topmost tab card loses its place because another tab card has gained focus or when the screen closes.

Wdg

str

Windows, Motif, widget_type = PV_CARD

hook_app_focus_change

Whether to call screen exit and screen entry when application loses and gains focus.

App

PV_YES

PV_NO

Windows, Panther 5.20 and later

hor_scroll_bar

Horizontal scroll bar assignment for shifting widget.

Wdg

PV_YES

PV_NO

word_wrap = PV_NO and max_data_length > length

horiz_anchor

Horizontal anchor point.

Wdg

PV_LEFT

PV_RIGHT

PV_CENTER

GUI, Web. For box widget, position_region = PV_YES

horiz_max_size

Widget's maximum width if screen is resized at runtime.

Wdg

str; grid units (g) by default, characters (c), inches (in), millimeters (mm), or pixels (p).

GUI, auto_horiz_resize = PV_YES

horiz_min_size

Widget's minimum width if screen is resized at runtime.

Wdg

str; grid units (g) by default, characters (c), inches (in), millimeters (mm), or pixels (p).

GUI, auto_horiz_resize = PV_YES

horiz_rotation

Graph's horizontal rotation (about the vertical axis), as measured in degrees.

Wdg

str (0 .. 90)

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW and chart_3d = PV_YES

horiz_shrinking

Method by which horizontal dimension and position of widgets within region are readjusted when box widget shrinks.

Wdg

PV_DECREASE_REGION_SI ZE
PV_KEEP_REGION_SIZE
PV_PREVENT_GRID_SHRIN KING

GUI, widget_type = PV_BOX

horizontal

Horizontal arrangement of an array.

Wdg

PV_YES

PV_NO

array_size > 1

html_max_loop

Number of loop iterations to perform before terminating process. Default is 1000.

App

int

Web

html_max_nest

Number of nesting levels allowing in condition processing. Default is 20.

App

int

Web

html_name

Name of HTML widget, during HTML generation.

Wdg

str

RO, Web

html_template

Name of HTML document to use for HTML structure during HTML generation.

Scr

SrvCom

str

Web

icon

Name of icon image file.

Scr

str

GUI

id

Internal identification for specified object.

App Link Scr SelGrp Sync TV Wdg

int

RT, RO

image_map

URL of server-side image map containing the coordinates and hyperlinks for the image.

Wdg

str

Web, active_pixmap = fileName

in_delete_where

Whether or not widget value is included in the WHERE clause of the SQL DELETE statement.

Wdg

PV_YES

PV_NO

Writable only if widget is not part of a TM transaction in progress

in_update_where

Whether or not widget is included in the WHERE clause of the SQL UPDATE statement.

Wdg

PV_YES

PV_NO

Writable only if widget is not part of a TM transaction in progress

in_gui

Test for GUI and not character mode.

App

PV_YES

PV_NO

RT, RO

in_server

Determine which distributed application product is running.

App

PV_SERVER_NONE

PV_SERVER_COM

PV_SERVER_MTS

PV_SERVER_EJB

RT, RO

in_web

Determine whether the application is running as a web application.

App

PV_YES

PV_NO

RT, RO

in_zoom

Test if in zoom window.

App

PV_YES

PV_NO

RT, RO

inactive_pixmap

Name of image file to display on the widget when it is inactive (or cannot receive focus)

Wdg

str

GUI, Web, active_pixmap = filename, widget_type = PV_PUSH_BUTTON | PV_RADIO_BUTTON | PV_CHECK_BOX | PV_TOGGLE_BUTTON | PV_DYNAMIC_LABEL

initialization

When to populate option menu/combo: on screen entry, or when the widget is activated.

Wdg

PV_FILL_AT_INIT

PV_FILL_AT_POPUP

widget_type = PV_OPTION_MENU | PV_COMBO_BOX and drop_down_screen = screenName

input_protection

Allow (PV_NO) or prevent (PV_YES) data entry. Single line and multiline text widgets in Web applications with PV_YES value are displayed in bold text.

Wdg

PV_YES

PV_NO

ins_del_buttons

Whether or not to allow Insert and Delete buttons in grid widget in a Web application.

Wdg

PV_YES

PV_NO

Web, widget_type = PV_GRID_FRAME

ins_func_name

Special function to be called for INSERT operations.

TV

str

insert_handling = PV_HANDLING_FUNC

insert_expression

Expression included in values-list of INSERT statement of generated SQL.

Wdg

str

use_in_insert = PV_YES Writable only if the widget is not part of TM transaction in progress

insert_handling

Method for handling INSERT operations.

TV

PV_HANDLING_SQL

PV_HANDLING_FUNC

PV_HANDLING_NOTHING

insert_order

Which table view (parent or child) participates in the INSERT statement first.

Link

PV_CHILD_FIRST

PV_PARENT_FIRST

Writable only if the link's table views are not part of TM transaction in progress

insert_service

Name of service to use to implement Insert operation to database table associated with the table view.

TV

str

JN, Tux

italic

Italic font style attribute.

App
Wdg
Scr

PV_DEFAULT

PV_YES

PV_NO

GUI; Has no effect if the specified font_name does not have an italic qualifier or if it is only available in an italic style

item_link

URL destination of hyperlink per widget occurrence.

Wdg

str

Web; widget_type = PV_DYNAMIC_LABEL | PV_GRAPH

java_tag

Java event handler for this object.

Scr
SrvCom
Wdg

str

Java must be enabled

java_use_codeset

If set to PV_YES, Panther's Java methods will convrt to/from Java Strings using the current codeset.

App

PV_YES

PV_NO

New in Panther 5.51.

If PV_YES, when C API functions explicity use UTF-8, and the JNI method uses String, proper conversion of UTF-8 to/from String will occur.

javascript

JavaScript functions called by screen or widget JavaScript events.

Scr
SrvCom
Wdg

str

Web

join_type

Type of join between two table views. The link type must be Server. Default is PV_INNER.

Link

PV_INNER

PV_LEFT_OUTER

PV_RIGHT_OUTER

PV_FULL_OUTER

type = PV_LNK_SERVER

justification

Left, right, or centered text orientation.

Wdg

PV_LEFT

PV_RIGHT

PV_CENTERED

PV_CENTERED not available in CM and Web and otherwise available only if widget_type = PV_BOX and label = str

keep_image_size

Whether or not to use GUI image dimensions when positioning image in generated HTML. PV_NO, image positions on single line in HTML.

Wdg

PV_YES

PV_NO

Web, active_pixmap = fileName

keep_in_frame

Determines whether screen opens as MDI window.

Scr

PV_YES

PV_NO

Windows, v4.5, RO, dialog = PV_NO

keep_on_top

Determines whether the screen is the topmost window.

Scr

PV_YES

PV_NO

Windows, v4.5, RO, dialog = PV_NO | keep_in_frame = PV_NO

key_constant[int]

Identifies primary key constants (from 1 to num_key_columns) in specified table view.

TV

str

RT, RO; only available for updatable table views after a SELECT, NEW, COPY, or COPY_FOR_UPDATE command

key_field[int]

Identifies primary key fields (from 1 to num_key_columns) in specified table view.

TV

objid

RT, RO; only available for updatable table views after a SELECT, NEW, COPY, or COPY_FOR_UPDATE command

keystroke_filter

Keystroke filter applied on data entry.

Wdg

PV_UNFILTERED

PV_DIGITS_ONLY

PV_YES_NO

PV_ALPHABETIC

PV_NUMERIC

PV_ALPHANUMERIC

PV_REGULAR_EXP

PV_EDIT_MASK

label

Label or initial text assignment.

Wdg

str

RO for static labels; widget_type = PV_GRID_FRAME: Web only

legend[int]

Where data values display in relation to graphical data.

Wdg

str

GUI, Web; chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW and y_value_source[int] = str

legend_border_width

Border width in graph legend.

Wdg

str (0 .. 100)

GUI, Web, legend_placement = PV_DEFAULT | PV_LOCATION | PV_POSITION

legend_in_data_space

Whether or not graph legend should reside within data space.

Wdg

PV_YES

PV_NO

GUI, Web, legend_placement = PV_LOCATION

legend_placement

Placement of graph legend.

Wdg

PV_DEFAULT

PV_NONE

PV_LOCATION

PV_POSITION

widget_type = PV_GRAPH

legend_text_size

Relative point size of text associated with graph's legend.

Wdg

str (0 .. 100)

GUI, Web, legend_placement = PV_DEFAULT | PV_LOCATION | PV_POSITION

legend_title

Graph legend title.

Wdg

str

GUI, Web, legend_placement = PV_DEFAULT | PV_LOCATION | PV_POSITION

legend_x_anchor

X coordinate position to which graph's legend is anchored.

Wdg

PV_LEFT

PV_CENTER

PV_RIGHT

GUI, Web, legend_placement = PV_POSITION

legend_x_location

Horizontal placement (along x axis) of graph's legend.

Wdg

PV_LEFT

PV_CENTER

PV_RIGHT

GUI, Web, legend_placement = PV_POSITION

legend_x_position

Horizontal position (along x axis) of graph's legend.

Wdg

str (0 .. 100)

GUI, Web, legend_placement = PV_POSITION

legend_y_anchor

Y coordinate position to which graph's legend is anchored.

Wdg

PV_TOP

PV_MIDDLE

PV_BOTTOM

GUI, Web, legend_placement = PV_POSITION

legend_y_location

Vertical placement (along y axis) of graph's legend.

Wdg

PV_TOP

PV_MIDDLE

PV_BOTTOM

GUI, Web, legend_placement = PV_POSITION

legend_y_position

Vertical position (along y axis) of graph's legend.

Wdg

str (0 .. 100)

GUI, Web, legend_placement = PV_POSITION

length

Number of columns of data/characters a widget can display onscreen. In a tab card, it is the length of the tab.

Wdg

int

Not applicable to dynamic and static labels or push buttons in Web applications; widget's label determines its length

line_style[int]

Style of line connecting data points for each data set (int) in a graph.

Wdg

PV_NONE

PV_SOLID

PV_DASHED

PV_DOTTED

PV_LONG_DASH

PV_DASH_DOT

GUI, Web; must be bar_style = PV_LINE | PV_CURVE | PV_TREND; xy_style = PV_LINE | PV_CURVE

line_width[int]

Width of line connecting data points for each data set (int) in a graph.

Wdg

str (0 .. 100)

GUI, Web; must be bar_style = PV_LINE | PV_CURVE | PV_TREND; xy_style = PV_LINE | PV_CURVE

link_attributes

HTML attributes to add to anchor tag (<A>).

Wdg

str

Web, default_link = URL; widget_type = PV_DYNAMIC_LABEL | PV_GRAPH

listbox_type

List box widget's behavior type: action or selection type.

Wdg

PV_ACTION

PV_SELECT_ANY

widget_type = PV_LIST_BOX

mail_attachment_delete

If PV_YES, file is attached and then deleted when mail object is destroyed.

Mail

PV_YES

PV_NO

mail_attachment_encodi ng

Encoding used for attached file.

Mail

str

mail_attachment_filena me

Filename to be sent as attachment.

Mail

str

mail_attachment_pathna me

File page and name to be sent as attachment.

Mail

str

mail_attachment_tag

Application that generated the attachment.

Mail

str

mail_bcc[int]

Value for BCC: line of the mail message.

Mail

str

mail_cc[int]

Value for CC: line of the mail message.

Mail

str

mail_connected

Indicates whether there is an active MAPI connection.

Mail

PV_YES

PV_NO

PR_MAIL_SYSTEM only. Always PV_NO with CDO

mail_flags

Flags specifying how to logon to the MAPI session or CDO server.

Mail

PV_MAPI_NEW_SESSION

PV_MAPI_LOGON_UI

PV_MAPI_PASSWORD_UI

PV_MAPI_USE_CDO

PV_MAPI_USE_CDO_SSH

PR_MAIL_SYSTEM only

mail_from

Value for From: line of the mail message.

Mail

str

mail_password

Optional password for MAPI logon or CDO connect function.

Mail

str

PR_MAIL_SYSTEM only

mail_port

Port to connect to when using CDO

Mail

int (0 .. 65535)

CDO only

mail_profile

Optional MAPI profile name.

Mail

str

PR_MAIL_SYSTEM only

mail_receipt

Whether to ask for a receipt when the mail is first read.

Mail

PV_YES

PV_NO

mail_replyto

Value for the Reply-to: line of the mail message

Mail

str

CDO only

mail_server

Mail server to connect to

Mail

str

CDO only

mail_subject

Value for Subject: line of the mail message.

Mail

str

mail_text

Text of the mail message.

Mail

str

mail_to[int]

Value for To: line of mail message.

Mail

str

mail_username

Username when connecting

Mail

str

CDO only

max_bundles

Maximum number of send bundles available, including the unnamed bundle. Defaults to 10.

App

int

RT

max_data_length

Maximum number of columns of data widget can contain, includes offscreen data.

Wdg

int

No Web, widget_type = PV_SINGLE_LINE_TEXT | PV_MULTILINE_TEXT | PV_LIST_BOX | PV_COMBO_BOX

max_decimals

Maximum number of decimals places allowed in numeric display.

Wdg

int

numeric_type = PV_CUSTOM

max_fetches

Maximum number of fetches of data.

App

int

RT

max_min

Whether or not screen can be maximized and/or minimized.

Scr

PV_NEITHER

PV_BOTH

PV_MAXIMIZEABLE

PV_MINIMIZEABLE

GUI

max_occurrences

Maximum data (number of rows) the object can contain.

Wdg Sync

int; for maximum number allowed by system, set to an empty string ("")

scrolling = PV_YES

max_rows_per_fetch

Number of rows returned in a fetch request. Default (and maximum) value is 1000.

App

int

RT

maximize_no_reposition

If set to PV_YES in Panther for Windows, windows will not be repositioned when they are maximized or restored.

App

PV_YES

PV_NO

New in Panther 5.50.

maximum_value

Uppermost value of range of values.

Wdg

str

Data entry type widgets and scale widgets

mdt

PV_YES if contents of widget or group has changed (for example, when selection has been made).

Wdg SelGrp

PV_YES

PV_NO

RT

member

Group to which widget belongs.

Wdg

str

RT, RO

memo1...memo9

Memo text associated with object.

Scr Wdg SelGrp Sync TV Link SrvCom

str

menu_name

Name of screen's menu.

Scr

str

No Web

menu_script_file

Screen's menu script file.

Scr

str

No Web

min_decimals

Minimum number of decimal places allowed in numeric display.

Wdg

int

numeric_type = PV_CUSTOM

min_horiz_space

Positioning specification to define minimum horizontal space to reserve between widgets.

Scr Wdg

str; grid units (g) by default, characters (c), inches (in), millimeters (mm), or pixels (p).

GUI

min_vert_space

Positioning specification to define minimum vertical space to reserve between widgets.

Scr Wdg

str; grid units (g) by default, characters (c), inches (in), millimeters (mm), or pixels (p).

GUI

minimum_value

Minimum value of range of values.

Wdg

str

Data entry type widgets and scale widgets

mnemonic_character

Mnemonic character assignment.

Wdg

str

RT

mnemonic_position

Mnemonic character position in screen's title or widget's label

Scr Wdg

int

No Web, Scr: title = str; Wdg: label = str

model

Name of transaction model. Table view specification takes precedence over screen-level.

Scr SrvCom TV

str

mouse_field

Field number of widget where mouse clicked.

App

int

RO

mouse_field_name

Name of widget where mouse clicked.

App

str

RO

mouse_field_occ

Occurrence number where mouse clicked.

App

int

RO

mouse_form_name

Name of screen where mouse clicked.

App

str

RO

must_fill

Whether or not widget's length must be character filled to its maximum (no blanks, spaces)

Wdg

PV_YES

PV_NO

name

Name attribute.

Scr Wdg SelGrp Sync TV Link

str

Scr: RT, RO

next_tab_stop

Name of widget or group that gets focus when user tabs out of the current object.

Wdg SelGrp

str

No Web

no_validation

Prevent (PV_YES) or allow (PV_NO) widget validation.

Wdg

PV_YES

PV_NO

null_field

Whether or not widget can accept and display null value.

Wdg

PV_YES

PV_NO

null_text

Character string to display when widget content is empty or null.

Wdg

str (up to 255 chars)

null_text = PV_YES

num_children

Number of child table views in table view.

TV

int

RT, RO

num_columns

Number of columns in table view. To get column names use columns[int].

TV

str

RT, RO

num_del_images

Number of deleted rows. Refer to di_string[int].

Wdg

int

RT, RO

num_fields

Number of widgets in specified table view.

TV

int

RT, RO

num_fields_below

Number of widgets in table view and in its child table views. For application, number of widgets participating in current transaction.

App TV

int

RT, RO

num_key_columns

Number of widgets comprising primary key (indicated in primary_key[int] property) of table view. Use primary_key to get names.

TV

int

RT, RO; only available for updatable table views after a SELECT, NEW, COPY, or COPY_FOR_UPDATE command

num_occurrences

Number of populated occurrences in specified object.

Wdg SelGrp Sync

int

RT

num_of_selections

Number of selections allowed within a selection group.

SelGrp

PV_0_OR_1

PV_1

PV_ANY

num_relations

Number of relationship entries specified in link's relations property.

Link

int

RT, RO

num_sorts

Number of entries indicated in table view's sort_widgets[int] property.

TV

int

RT, RO

num_sv_fields

Number of widgets in server view (as identified by the sv property) or in direct or indirect child table views connected via server links to the server view.

TV

int

RT, RO

num_svs_below

Number of server views connected to table view; number includes the specified TV and all direct and indirect child table views connected via sequential links. For application, number of server views participating in current transaction.

App
TV

int

RT, RO

num_tvs

Number of child table views connected directly or indirectly, via server links, to specified server view (as identified by the sv property).

TV

int

RT, RO

num_tvs_below

Number of table views, including specified TV, and direct or indirect child table views of the server view. For application, number of table views participating in current transaction.

App TV

int

RT, RO

number_of_cards

Number of tab cards associated with tab deck widget, including hidden cards.

Wdg

int

Windows, Motif; RT, RO, widget_type = PV_DECK

numeric_type

Numeric format using variables defined in Panther message file.

Wdg

PV_DEFAULT_0 ...PV_DEFAULT_9

PV_CUSTOM

data_formatting = PV_NUMERIC

numflds

Number of widgets on screen.

Scr

int

RT, RO

numgrps

Number of groups on screen.

Scr

int

RT, RO

old_ax_initialize

Change how ActiveX controls are initialized

App
ActiveX

PV_YES

PV_NO

Must be set before control is realized/created

old_shrink_algorithm

Restores report area shrink to work as it did in Panther 5.40 and earlier.

App

PV_YES

PV_NO

New in Panther 5.51.

on_blur

JavaScript function called when widget loses focus.

Wdg

str

Web

on_change

JavaScript function called when widget's content changes.

Wdg

str

Web

on_click

JavaScript function called when user clicks on widget.

Wdg

str

Web

on_focus

JavaScript function called when widget gets focus.

Wdg

str

Web

on_load

JavaScript function to be called when the screen is loaded.

Scr SrvCom

str

Web

on_mouse_out

JavaScript function called when user moves mouse out of a widget.

Wdg

str

Web

on_mouse_over

JavaScript function called when user moves mouse over widget. Hyperlink's URL is displayed in browser status line.

Wdg

str

Web, default_link = URL

on_select

JavaScript function called when content of widget is selected (highlighted).

Wdg

str

Web

on_submit

JavaScript function called when screen is submitted.

Scr SrvCom

str

Web

on_unload

JavaScript function called when screen is unloaded.

Scr SrvCom

str

Web

onscreen_columns

Number of grid columns to display.

Wdg

int

widget_type = PV_GRID_FRAME

onscreen_rows

Number of data rows to display.

Wdg

int

widget_type = PV_MULTILINE_TEXT | PV_LIST_BOX | PV_GRID_FRAME

orientation

Graph's orientation: PV_VERTICAL, X axis runs horizontally and Y axis runs vertically; PV_HORIZONTAL, X axis runs vertically and Y axis runs horizontally.

Wdg

PV_HORIZONTAL

PV_VERTICAL

GUI, Web; chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

pane

Pane a screen or widget resides in

Scr Spl

Wdg

name of containing pane in JPL; otherwise, the pane's object ID

RO; error if screen or widget is not in a pane

pane_col

Column the pane is in

Pane

int

pane_index

Index of the pane in its containing splitter

Pane

int

pane_row

Row the pane us in

Pane

int

pane_screen

Screen that resides in the pane

Pane

str; name of the screen in JPL; otherwise, the screen's object ID

parent

Link: Name of parent table view of link relationship.

Link

str

Writable only if TM transaction is not in progress

TV: Name of parent table view (if any) of specified table view.

TV

str

RT, RO; returns empty string if root table view is specified since root has no parent

parent_link

Name of link in which specified table view is the child.

TV

str

RT, RO; returns empty string if root table view is specified since root has no parent

parent_window

Specifies the parent window of a non-MDI window.

Scr

PV_NONE

PV_MDI_FRAME

Windows, v4.5, RO, dialog = PV_NO | keep_in_frame = PV_NO

password_char

Character to display on user input. In Web applications where a single line text widget has password_field = PV_YES, asterisks are displayed.

Wdg

str

No Web, password_field = PV_YES

password_field

Whether or not content of widget is invisible. For Web applications, widgets that have property set to PV_YES just display asterisks.

Wdg

PV_YES

PV_NO

widget_type = PV_SINGLE_LINE_TEXT | PV_MULTILINE_TEXT

pie_diameter

Diameter of pie chart as a percentage of overall size of graph widget.

Wdg

str (0.0 .. 200.0)

GUI, Web, chart_type = PV_PIE

pie_direction

Order in which segments are placed around pie chart graph.

Wdg

PV_CLOCKWISE

PV_COUNTERCLOCKWISE

GUI, Web, chart_type = PV_PIE

pie_start_angle

Location of first segment in pie chart, measured in degrees.

Wdg

str (0 .. 359)

GUI, Web, chart_type = PV_PIE

pie_x_position

Horizontal position of pie chart within graph widget.

Wdg

str (0.0 .. 100.0)

GUI, Web, chart_type = PV_PIE

pie_y_position

Vertical position of pie chart within graph widget.

Wdg

str (0.0 .. 100.0)

GUI, Web, chart_type = PV_PIE

placement

Where to place currency symbol in monetary data.

Wdg

PV_LEFT

PV_RIGHT

PV_MIDDLE

numeric_type = PV_CUSTOM and currency_symbol must have a value

point_marker[int]

Style of point marker format for each data series (int) in graph.

Wdg

PV_NONE

PV_DOT

PV_PLUS

PV_STAR

PV_O

PV_X

PV_SQUARE

PV_DIAMOND

PV_TRIANGLE

PV_CIRCLE

PV_FILLED_SQUARE

PV_FILLED_DIAMOND

PV_FILLED_TRIANGLE

PV_FILLED_CIRCLE

GUI, Web, Either: bar_style = PV_LINE | PV_CURVE | PV_POINT | PV_TREND or xy_style = PV_LINE | PV_CURVE | PV_POINT

point_size

Font point size.

App

Scr

Wdg

str

GUI; Font size is system- dependent; point size must be available for specified font_name or font_name must be scalable

pointer

Mouse pointer shape.

Scr

str

GUI

poll_frequency

Determine how often the report viewer checks to see if the user has pressed the CANCEL button. (C constant PR_RW_POLL_FREQUENCY)

App
(Rpt)

int

popup_menu

Name of menu that will popup when user clicks right-mouse button on widget.

Scr

Wdg

str

No Web; Menu must be in a menu script loaded in memory at screen- or application-level

popup_script_file

Name of menu file (*.mnu) to load in screen-level memory.

Wdg

str

No Web

position_region

Whether or not box widget is treated as a positioning region.

Wdg

PV_YES

PV_NO

widget_type = PV_BOX

precision

Numeric precision assignment for use by database drivers.

Wdg

SelGrp

int

c_type = PV_DOUBLE | PV_FLOAT | PV_PACKED | PV_ZONED

prefix_markup

HTML markup to include in start tag.

Wdg

str

Web

prev_tab_stop

Name of widget or group that gets focus when user backtabs out of current object.

Wdg

SelGrp

str

No Web

previous_form

The screen name as specified in the cache file.

App

str

Web; RT, RO

primary_key[int]

Columns composing database table's primary key.

TV

str

Writable only if table view is not part of a TM transaction in progress

primary_key_update

Whether a primary key change should be deleted and inserted OR updated.

App

PV_YES

PV_NO

provider_url

The URL of the application server.

App

str

RT; WAS

queryendsession

Function to call during shutdown processing.

App

str

PV_QUERYENDSESSION_YE S

PV_QUERYENDSESSION_NO

PV_QUERYENDSESSION_AS K

PV_NULL

Windows

radio_buttons

Whether or not to display radio buttons on each occurrence in a Web application's grid widget.

Wdg

PV_YES

PV_NO

Web, widget_type = PV_GRID_FRAME

reg_exp_filter

Regular expression to validate data on a character-by-character basis.

Wdg

str

keystroke_filter = PV_REGULAR_EXP

regenerate_ins_sql

Whether or not the transaction manager regenerates a SQL INSERT statement for every row in a table view. PV_NO is the default value at application level; PV_DEFAULT at table view level.

App, TV

PV_YES

PV_NO

PV_DEFAULT

RT

regenerate_upd_sql

Whether or not the transaction manager regenerates a SQL UPDATE statement for every row in a table view. PV_NO is the default value at application level; PV_DEFAULT at table view level.

App, TV

PV_YES

PV_NO

PV_DEFAULT

RT

region_margin

Positioning specification to define reserved space between widgets and container's border.

Scr Wdg

str; grid units (g) by default, characters (c), inches (in), millimeters (mm), or pixels (p).

GUI, Wdg: widget_type = PV_BOX

regular_exp

Regular expression used to validate widget's content.

Wdg

str

rel_child[int]

Database column derived from child table view; component of link's relations property.

Link

str

RT, RO

rel_op[int]

Type of relationship between two table views–join or lookup– for an entry in link's relations property.

Link

PR_REL_OP_JOIN

PR_REL_OP_LOOKUP

RT, RO

rel_parent[int]

Database column (or widget) belonging to parent table view; component of link's relations property.

Link

str

RT, RO

relations[int]

List of entries that describe the relationship between two table views. Refer to rel_child[int], rel_parent[int], and rel_op[int] for runtime equivalents.

Link

str; in the form "parentColname childColname relationship".

repeating

Whether or not null character/string (in null_text property) fills widget's content to its maximum length.

Wdg

PV_YES

PV_NO

null_text = PV_YES

report_invocation

Name of report to invoke as a subreport; including filename if report is external: reportFilename!report Name. (C constant PR_RW_ACTION_STRING)

Rpt

str

report_no_color

When set to PV_YES, color properties of widgets in reports are ignored.

App

PV_YES

PV_NO

New in Panther 5.40.

required

Whether or not user input is required.

Wdg

PV_YES

PV_NO

resize_function

Custom resize function for controlling screen layout after screen is resized.

Scr

str

No Web

resizeable

Allow or prevent screen from being resized by user at runtime.

Scr

PV_YES

PV_NO

No Web

reverse

Reverse video attribute. For widgets, applies to text.

Scr

Wdg

PV_YES

PV_NO

Scr: CM (reverse video handling is terminal-dependent), border_fg_color_type = PV_BASIC

Wdg: fg_color_type = PV_BASIC.

root

Scr: Table view name, -none-, or empty string (indicates property is set to -default-). To get root table view of current transaction, use sv application property or call sm_tm_pinquire with an argument of TM_ROOT_NAME.

Scr

SrvCom

str

Writable only if TM transaction is not in progress

Detail node: Root table view when transaction manager is used to fetch data. (C constant PR_RW_DETAIL_ROOT)

Wdg (Rpt)

str

Data Source = TM View

rounding

How numeric data should be rounding: up, down, or round adjust (rounds up above 5).

Wdg

PV_ROUND_ADJUST

PV_ROUND_DOWN

PV_ROUND_UP

data_formatting = PV_NUMERIC

row_entry_func

Name of function to invoke when a grid row gains focus.

Wdg

str

widget_type = PV_GRID_FRAME

row_exit_func

Name of function to invoke when a grid row loses focus.

Wdg

str

widget_type = PV_GRID_FRAME

row_margin

Amount of space above and below text in grid row.

Wdg

str (units)

GUI; widget_type = PV_GRID_FRAME

row_separators

Whether or not horizontal lines display between each grid member row.

Wdg

PV_YES

PV_NO

widget_type = PV_GRID_FRAME

row_titles

Source or type of row titles in grid widget: none, numbers, or data in the first column.

Wdg

PV_NONE

PV_AUTO_NUMBER

PV_FIRST_COLUMN

widget_type = PV_GRID_FRAME

runtime_license

License needed to access the ActiveX control at runtime.

Wdg

str

Windows, no Web; widget_type = PV_ACTIVEX

save_func_name

Special function to be called for SAVE operations.

TV

str

delete_handling | insert_handling | update_handling = PV_HANDLING_FUNC

scale

Database property that determines the length of a numeric column. This property is acquired from the database column. This information is currently unused by Panther.

Wdg

int

screen_type

Identifies a screen or service component.

Scr

SrvCom

PV_SCREEN

PV_COMPONENT

scroll_buttons

Whether or not to allow scroll buttons in grid widget in Web application.

Wdg

PV_YES

PV_NO

Web, widget_type = PV_GRID_FRAME

scroll_increment

Number of occurrences to scroll when PgDn/PgUp is used.

Wdg Sync

int

Wdg: scrolling = PV_YES

scrolling

Whether or not widget scrolls vertically.

Wdg

PV_YES

PV_NO

Not applicable to multiline text widgets in Web applications

secure_post

Whether or not screen should be posted to secure server using HTTPS protocol.

Scr

SrvCom

PV_YES

PV_NO

Web

seg_label_location

Where labels should display: around outer edge of pie chart or as a legend.

Wdg

PV_OUT

PV_LEGEND

GUI, Web, chart_type = PV_PIE and seg_label_source = str

seg_label_source

Source or values for pie chart segment labels.

Wdg

str

GUI, Web, chart_type = PV_PIE

seg_percent_location

If and where percentages are displayed in pie chart segments.

Wdg

PV_NONE

PV_IN

PV_OUT

GUI, Web, chart_type = PV_PIE

seg_style_source

Styles (or source of) for each pie chart segment.

Wdg

str

GUI, Web, chart_type = PV_PIE

seg_value_location

If and where numeric pie chart segment values are displayed.

Wdg

PV_NONE

PV_IN

PV_OUT

GUI, Web, chart_type = PV_PIE

sel_func_name

Special function to be called for SELECT operations.

TV

str

select_handling = PV_HANDLING_FUNC

select_expression

Expression in select list of generated SQL.

Wdg

str

use_in_select = PV_YES

select_force_valid

Whether or not field validation (sm_fval) is called after data is written to the widget.

Wdg

PV_YES

PV_NO

use_in_select = PV_YES

select_handling

Method for handling SELECT operations.

TV/SV

PV_HANDLING_SQL

PV_HANDLING_FUNC

PV_HANDLING_NOTHING

select_on_entry

Whether or not widget content is selected when user tabs into field.

Wdg

PV_YES

PV_NO

select_service

Name of service to use to implement Select operation against database table associated with the table view.

TV

str

JN, Tux

select_set_valid

Whether or not VALIDED bit should be set when SELECT statement fetches data to widget

Wdg

PV_YES

PV_NO

use_in_select = PV_YES

selected

Whether or not selection-type widget is selected.

Wdg

PV_YES

PV_NO

RT

selection_screen

Name of screen (and service component selection screen) to display list of viable choices when user presses ITSEL key or chooses Help.

Wdg

str

widget_type = PV_SINGLE_LINE_TEXT | PV_MULTILINE_TEXT with word_wrap = PV_NO

shift_increment

Number of columns of data to shift.

Wdg

int

max_data_length > length

show_status_text

If PV_YES, the most recent status message from the control will be displayed in the status line when the control has focus.

Wdg

PV_YES

PV_NO

Web widget_type = PV_ACTIVEX

sibling

Define screen as sibling, which means user can bring focus to this screen without closing the calling screen.

Scr

PV_YES

PV_NO

RT

sign

Whether object's numeric data type is signed or unsigned; for use by database drivers.

Wdg SelGrp

PV_YES

PV_NO

c_type = FT_PACKED | FT_ZONED

size_to_contents

Whether or not widget resizes at runtime to fit its content.

Wdg

PV_YES

PV_NO

No Web (browser determines size based on content); label = str

sort_order

Define how data is sorted when the user clicks on the grid column title.

Wdg

PV_DATE_TIME

PV_LEXICOGRAPHIC

PV_NUMERIC

PV_CUSTOM

Widget must be in a grid widget; column_click_action = PV_SORT

sort_order_func

Name of custom function to invoke when data in the grid column is sorted.

Wdg

str

Widget must be in a grid widget; sort_order = PV_CUSTOM

sort_widgets[int]

List of widget names by which to order data.

TV

str

source_occ

Occurrence from parent table view that was valid when the child table was last fetched.

TV

int

RT, RO

spacing

Space between array elements.

Wdg

int

array_size > 1

splitter

Splitter the pane is a member if

Scr Pane

Spl

name of containing splitter in JPL; otherwise, the splitter's object ID

splitter_col_width

Array of column widths

Spl

int

splitter_cols

Number of columns

Spl

int

splitter_row_height

Array of row heights

Spl

int

splitter_rows

Number of rows

Spl

int

sql_statement

SQL string to fetch data for a report's detail node. (C constant

PR_RW_SQL_STATEMENT)

Wdg (Rpt)

str

Data Source = SQL Query

start_column

Horizontal starting position.

Wdg

int

start_row

Vertical starting position.

Wdg

int

startup

Open screen at default size, maximized, or minimized (iconified).

Scr

PV_NORMAL

PV_ICONFIELD

PV_MAXIMIZE

GUI

status_line_text

Status line text displayed when object has focus.

Scr

Wdg

str

For Web applications, the browser must be JavaScript-enabled to display status line text in the browser's status message area

status_line_font

Change the value supplied by the Font entry in the [Prolifics StatusLine] section of the Windows initialization file

App

str

Windows

stripe_current_row

Whether or not entire grid row is highlighted on selection as opposed to a single cell.

Wdg

PV_YES

PV_NO

widget_type = PV_GRID_FRAME

style

Line style for widget's border.

Wdg

PV_STYLE_0... PV_STYLE_9 corresponding to Panther line style.

CM, widget_type = PV_MULTILINE_TEXT | PV_LIST_BOX and border = PV_YES

stylesheet_data

The body of the stylesheet as specified inline.

Scr

str

Web, stylesheet_source = PV_INLINE

stylesheet_link

A URL for external stylesheet.

Scr

str; URL

Web, stylesheet_source = PV_LINK

stylesheet_source

Whether or not the stylesheet is specified inline or referenced by URL.

Scr

PV_NONE

PV_LINK

PV_INLINE

Web

stylesheet_type

Stylesheet specification to be used: CSS or JavaScript.

Scr

PV_CSS

PV_JAVASCRIPT

Web, stylesheet_source = PV_INLINE | PV_LINK

submit

Runs the script on the push button instead of submitting screen back to the HTTP server.

Wdg

PV_YES

PV_NO

Web, widget_type = PV_PUSH_BUTTON

subtitle

Graph's subtitle (displays below title).

Wdg

str

GUI, Web, widget_type = PV_GRAPH

subtitle_text_size

Graph's subtitle text size; percentage of the widget size.

Wdg

str (0.0 .. 100.0)

GUI, Web, widget_type = PV_GRAPH and subtitle = str

suffix_markup

HTML markup to include in end tag.

Wdg

str

Web

sv

Name of server view containing current table view or widget. App: Name of root table view of current transaction.

App

Wdg

TV

str

RT, RO

sv_below[int]

Names of server views at and below specified server view and corresponding to specified occurrence.

App TV

str

RT, RO

sv_field[int]

Identifies widgets (from 1 to num_sv_fields) in specified server view.

TV

objid; name or field number if unnamed

RT, RO

sync_group

Synchronized scrolling group identifier.

Wdg

objid; name or field number if unnamed.

RT

synchronization

Whether members of table/server view are synchronized in order to update database.

Wdg

PV_DEFAULT

PV_YES

PV_NO

Writable only if widget is not participating in TM transaction in progress

system_menu

Presence or absence of system menu. PV_NO for Web application screens allows widgets to position next to browser window's borders (also see title_bar and 1).

Scr

PV_YES

PV_NO

system_update

Allow operating system to update date/time field.

Wdg

PV_YES

PV_NO

data_formatting = PV_DATE_TIME

tab_entry_func

Name of function to invoke when a tab card's tab gains focus.

Wdg

str

Windows, Motif.

tab_exit_func

Name of function to invoke when a tab card's tab loses focus.

Wdg

str

Windows, Motif.

table

Database table name associated with table view. Used in FROM clause in SQL generation.

TV

str

Writable only if table view is not participating in TM transaction in progress

table_lookup

Name of screen whose contents are used to validate data entry in widget.

Wdg

str

widget_type = PV_SINGLE_LINE_TEXT | PV_MULTILINE_TEXT | PV_COMBO_BOX

tableview

Table view name.

Wdg

objid

RT, RO

target

Target window/frame for hyperlink direction.

Wdg

str

Web, default_link = URL

target_default

Target window in which screen's hyperlinks are displayed.

Scr

SrvCom

str

Web

text_size

Overall text size within graph; percentage of the widget size.

Wdg

str (0.0 .. 100.0)

GUI, Web, widget_type = PV_GRAPH

thousand_sep

Punctuation for indicating a thousandths separator in numeric data.

Wdg

PV_COMMA

PV_DOT

PV_BLANK

PV_NONE

numeric_type = PV_CUSTOM

three_d

3-D shading effect around buttons and other objects. Can be set at application level and overridden on screen-by-screen basis. PV_APPLICATION uses application-level specification.

App Scr

PV_YES

PV_NO

PV_APPLICATION

No Web

title

Scr: Screen title, displayed on the title bar.

Scr
SrvCom

str

title

Application's frame window title in Windows

App

str

Windows

title

Wdg (graph): Title displayed top center.

Wdg

str

GUI, Web, widget_type = PV_GRAPH

title

Wdg (non-graph): Title text on widget border.

Wdg

str

CM, widget_type = PV_MULTILINE_TEXT | PV_LIST_BOX and border = PV_YES

title_bar

Screen's title bar is or is not displayed. PV_NO for Web screens allows widgets to position next to browser window's borders (also see border and system_menu).

Scr

PV_YES

PV_NO

title_text_size

Graph's title text size, measured as a percentage of graph widget's size.

Wdg

str (0.0 .. 100.0)

GUI, Web, widget_type = PV_GRAPH and title = str

tm_ansi_joins

When set to PV_YES, TM will generate ANSI syntax inner and outer joins

App

PV_YES

PV_NO

New in Panther 5.40

tm_ansi_outer_joins

When set to PV_YES, TM will generate ANSI syntax outer joins

App

PV_YES

PV_NO

New in Panther 5.40

tm_apply_class_changes

When set to PV_YES, TM will apply PR_CLASS changes at once

App

PV_YES

PV_NO

New in Panther 5.10

tm_clear_fast

Transaction manager's method of clearing data: PV_YES clears data by server view; PV_NO (default) clears data by table view.

App

PV_YES

PV_NO

PV_DEFAULT

RT

tm_scope

Determine if a service call is for the table view and all table view/server views in the tree or for the server view only.

App

TM_TV_AND_BELOW

SV_ONLY

RT

tm_server_view

Determine the name of the server view in the current transaction manager-implemented service call. This value is set in the middleware API transaction model and ensures that the correct arguments are sent and received for the service call.

App

str

RT

tm_transaction

Determine whether a service is transaction manager-enabled, and if so, which transaction manager operation is to be performed.

App

ttUNKNOWN ttSELECT ttUPDATE ttINSERT ttDELETE ttLINKVAL

RT

toolbar_allowed_sites

Sets the allowed toolbar placements.

App

PV_TOOLBAR_FLOAT

PV_TOOLBAR_TOP

PV_TOOLBAR_BOTTOM

PV_TOOLBAR_LEFT

PV_TOOLBAR_RIGHT

Windows toolbar; RT

toolbar_current_site

Sets the current toolbar placement.

App

PV_TOOLBAR_FLOAT

PV_TOOLBAR_TOP (def)

PV_TOOLBAR_BOTTOM

PV_TOOLBAR_LEFT

PV_TOOLBAR_RIGHT

Windows toolbar; RT

toolbar_hidden

Whether or not the toolbar is visible.

App

PV_YES

PV_NO

Windows toolbar; RT

toolbar_x_position

Determines the x coordinate of the toolbar's upper left corner.

App

int

Windows toolbar; RT

toolbar_y_position

Determines the y coordinate of the toolbar's upper left corner.

App

int

Windows toolbar; RT

tooltip_style

Determine the tooltip style bits.

App

PV_TOOLTIP_ALWAYS

PV_TOOLTIP_NOPREFIX

PV_TOOLTIP_NOANIMATE

PV_TOOLTIP_NOFADE

Windows, Motif, RT

tooltip_text

Determine the tooltip text.

Wdg

str

Windows, Motif, v4.5+

topmost_card

Identify topmost tab card on tab deck.

Wdg

objid; card name

Windows, Motif, RT, widget_type = PV_DECK

tp_async_poll_interval

How often to poll for outstanding asynchronous service requests.

App

double (>0); in seconds (default 1.0)

JN/Tux

tp_block

Service call's response when blocking condition exists (e.g., if buffer is not available). PV_YES, service call waits for available resources or until timeout occurs; PV_NO, call fails immediately.

App

PV_YES

PV_NO

JN/Tux

tp_commit_return

When transaction returns to calling agent during execution of xa_commit. TP_COMMIT_DECISION_LOG GED, xa_commit returns after all participants in transaction indicate that they are prepared for commit (first phase of two-phase commit protocol). TP_COMMIT_COMPLETED, xa_commit returns only after calling agent gives permission to commit (second phase of two-phase commit protocol).

App

TP_COMMIT_DECISION_LO GGED

TP_COMMIT_COMPLETED

JN/Tux

tp_exc_code

Exception code associated with most recently executed middleware API command. Reset after every middleware API command and generated by agent which originates the command (whereas tp_mon_exc_code is generated by middleware API). Check tp_severity for successful completion. It is possible that exception occurred, but exception handler determined the statement succeeded.

App

int; 0 indicates no exception

JN/Tux, RO

tp_exc_msg

Exception message associated with most recent middleware API command. Reset after every middleware API command and generated by agent which originates command (whereas tp_mon_exc_msg is generated by middleware API). Check tp_severity for successful completion of statement. It is possible that exception occurred, but exception handler determined the statement succeeded.

App

str; a 0 length message indicates no exception

JN/Tux, RO

tp_exc_names[int]

Mnemonic name associated with exception code (must be a positive number). Use value of tp_exc_code as array index.

App

str; TP_ prefix omitted, e.g., COMMIT_FAILED for TP_COMMIT_FAILED

JN/Tux, RO

tp_mon_exc_code

Exception code associated with most recent middleware API command. Reset after every middleware API command and generated by middleware API (whereas tp_exc_code is generated by agent that issued command). If an exception is detected by Panther rather than by middleware API, tp_exc_code gets value while tp_mon_exc_code does not.

App

int

JN/Tux, RO

tp_mon_exc_msg

Exception message associated with most recent middleware API command. Generated by the middleware API and reset after every middleware command. (tp_exc_msg is generated by agent that issued the command.) If middleware does not supply an exception message, property is cleared. If exception is detected by Panther instead of the middleware API, message is written to tp_exc_msg.

App

Str

JN/Tux, RO

tp_return

Return value from most recently executed middleware API command.

App

str

JN/Tux, RT, RO

tp_severity

Severity associated with most recently executed middleware API command. Reset after every middleware API command. Commands successfully completed, return TP_NONE.

App

TP_NONE, TP_INFORMATION, TP_WARNING, TP_ERROR, TP_MESSAGE, TP_COMMAND, TP_REQUEST, TP_TRANSACTION, TP_CONNECTION, TP_PANIC

JN/Tux, RT, RO

tp_severity_names[int]

Mnemonic names of exception severities. Use tp_severity (which must be 0 or greater) as array index.

App

NONE, INFORMATION, WARNING, ERROR, MESSAGE, COMMAND, REQUEST, TRANSACTION, CONNECTION, PANIC

JN/Tux, RT, RO

tp_signal_restart

Reaction of service call or unsolicited message notification to system interrupt signal. PV_YES, service call is protected from system interruption; PV_NO, allows signal interrupt and results in service call failure.

App

PV_YES

PV_NO

JN/Tux, RT

tp_svc_cache_size

Size of service portion of JIF cache–number of services to be cached to improve performance.

App

int; default 20 for client, 50 for server

JN/Tux, RT

tp_svc_outcome

Status value associated with most recently completed service request. Reset after every service request completes. Use TP_SUCCESS to test for success; TP_FAILURE to test for failure.

App

TP_SUCCESS, TP_FAILURE

JN/Tux, RT, RO

tp_svc_return

Return value associated with most recently completed service request. Always an integer reflecting CODE value specified by service when it executes service_return command.

App

str; 0, if service has no return value.

JN/Tux, RT, RO

tp_this_call

Callid of active request.

App

str (empty if no request is active)

JN/Tux, RT, RO

tp_timeout

Reaction of service call to blocking condition. PV_YES (default) establishes connection- wide default and service call waits for default timeout period specification; PV_NO, service calls ignore timeout limit and wait indefinitely.

App

PV_YES

PV_NO

JN/Tux, RT

tp_tran_level

Current transaction level.

App

int; 1 if caller is in a transaction, 0 if it is not.

JN/Tux, RT, RO

tp_tran_status

Status associated with current default transaction. Test whether to commit or rollback transaction (as done by xa_end command). Test for success using TP_WILL_COMMIT; use TP_WILL_ABORT to test for failure. TP_WILL_COMMIT, reset to zero whenever transaction is successfully initiated. If after subsequent statements are executed, tp_severity value exceeds TP_WARNING, or tp_svc_outcome value indicates application-level service request failure, value is set to TP_WILL_ABORT.

App

TP_WILL_COMMIT TP_WILL_ABORT

JN/Tux, RT, RO

tp_unsol_poll_interval

Frequency with which the middleware polls for outstanding unsolicited messages. If using different method of receiving unsolicited messages (e.g., signal interrupts), property has no effect.

App

double (>=0); default 10 seconds

JN/Tux, RT

tv

Name of table view to which the widget is a member.

Wdg

str

RT, RO

tv[int]

Name of specified server view and all table views connected directly or indirectly (from 1 to num_tvs) via server links to the specified server view.

TV

str

RT, RO

tv_below[int]

App: Names of table views participating in current transaction.

App

str

RT, RO

tv_below[int]

TV: Names of table views connected directly or indirectly to specified table view (and corresponding to array number); e.g., x->tv_below[n] means the n'th table view at or below the server view containing the table view x.

TV

str

RT, RO

type

Type of link between two table views.

Link

PV_LNK_SEQUENTIAL

PV_LNK_SERVER

PV_LNK_NONE

Writable only if the link's table views are not part of a TM transaction in progress.

underlined

Font style attribute.

App
Scr Wdg

PV_DEFAULT

PV_YES

PV_NO

No Motif

upd_func_name

Special function to be called for UPDATE operations.

TV

str

update_handling = PV_HANDLING_FUNC

updatable

Whether table view is updatable (database tables participate in INSERT, UPDATE, DELETE transactions).

TV

PV_YES

PV_NO

Writable only if the table view is not participating in TM transaction in progress

update_expression

Expression used in SET clause of SQL generated UPDATE statement.

Wdg

str

use_in_update = PV_YES; writable only if the widget is not participating in TM transaction in progress

update_handling

Method for handling UPDATE operations.

TV

PV_HANDLING_SQL

PV_HANDLING_FUNC

PV_HANDLING_NOTHING

update_order

Which table view (parent or child) participates in UPDATE statement first.

Link

PV_CHILD_FIRST

PV_PARENT_FIRST

Writable only if the link's table views are not participating in TM transaction in progress

update_service

Name of service to use to implement Update operation in database tables associated with the table view.

TV

str

JN, Tux

use_in_insert

Whether or not widget is included in INSERT statement and, therefore, its content is added to database.

Wdg

PV_YES

PV_NO

Writable only if the widget is not participating in TM transaction in progress

use_in_select

Whether or not database column associated with widget is included in the select list of a SELECT statement.

Wdg

PV_YES

PV_NO

Writable only if the widget is not participating in TM transaction in progress

use_in_update

Whether or not database column associated with widget is included in the SET clause of an UPDATE statement.

Wdg

PV_YES

PV_NO

Writable only if the widget is not participating in TM transaction in progress

use_in_where

Whether or not WHERE clause should use widget's data to specify which rows to fetch.

Wdg

PV_YES

PV_NO

validation_func

Validation function executed when object loses focus or when button pressed.

Wdg
SelGrp

str

RT

validation_link

Name of link to use to validate widget's data.

Wdg

str

validation_service

Name of service that receives data from the client into the service component, verifies the primary key in the database, and returns detail data for that primary key to the client.

Link

str

JN, Tux

valided

Whether or not object has been validated.

Wdg
SelGrp

PV_YES

PV_NO

RT

vbscript

VBScript function.

Scr
SrvCom
Wdg

str

Web

version_column

Whether or not widget is identified as the version column.

Wdg

PV_YES

PV_NO

Writable only if the widget is not participating in TM transaction in progress

vert_max_size

Determine widget's maximum growth in height if screen is resized at runtime.

Wdg

str; grid units (g) by default, characters (c), inches (in), millimeters (mm), or pixels (p).

GUI, auto_vert_resize = PV_YES

vert_min_size

Determine widget's minimum width if screen is resized at runtime.

Wdg

str; grid units (g) by default, characters (c), inches (in), millimeters (mm), or pixels (p).

GUI, auto_vert_resize = PV_YES

vert_rotation

Graph's vertical rotation (about horizontal axis), measured in degrees.

Wdg

str (0 .. 90)

GUI, Web, widget_type = PV_GRAPH, chart_3d = PV_YES

vert_scroll_bar

Vertical scroll bar assignment for scrolling grid, list box, or multiline text widgets.

Wdg

PV_YES

PV_NO

scrolling = PV_YES

vert_shrinking

Method by which vertical dimension and widget positions are adjusted when box widget is shrunk.

Wdg

PV_DECREASE_REGION_SI ZE

PV_KEEP_REGION_SIZE

PV_PREVENT_GRID_SHRIN KING

GUI, widget_type = PV_BOX

vertical_anchor

Vertical anchor point.

Wdg

PV_TOP

PV_BOTTOM

PV_MIDDLE

GUI, Web

view_full_page

Whether report viewer output is scaled to the page size (PV_YES) or to the actual size (PV_NO).

App

PV_YES

PV_NO

vncolms

Number of columns in viewport.

Scr

int

RT, no Web

vnlines

Number of lines in viewport.

Scr

int

RT, no Web

vofcolm

Viewport column offset.

Scr

int

RT, no Web

vofline

Viewport line offset.

Scr

int

RT, no Web

vstcolm

Viewport start column.

Scr

int

RT, no Web

vstline

Viewport start line.

Scr

int

RT, no Web

wallpaper_pixmap

Screen's wallpaper pixmap filename in GUI, and BACKGROUND attribute in Web applications.

Scr

str

GUI, Web

wallpaper_style

Screen's wallpaper display: centered or tile.

Scr

PV_CENTER

PV_TILE

GUI, wallpaper_pixmap = string

web_alt_as_tooltips

When web_use_tooltips and this property are both set to PV_YES, only the label property will be used for the title attribute.

App

PV_YES

PV_NO

Web

web_generate_ids

Bitmask that can cause id= attributes to be generated for specified widgets.

App

PV_WEB_IDS_NONE Default

PV_WEB_IDS_HIDDEN for hidden widgets

PV_WEB_IDS_NAMED for named widgets

PV_WEB_IDS_SPAN <span> tags generaed for SL's; DL's and focus protected grid members.

PV_WEB_IDS_DIV <div> tags generaed for focus protected MLT's.

PV_WEB_IDS_TABLE <table> tags generaed for named boxes and grids.

PV_WEB_IDS_IMG for <img> and <input type=image> widgets

PV_WEB_IDS_OTHER for other widgets

PV_WEB_IDS_ALL for all widgets.

Web New in Panther 5.51.

web_old_template_msgs

When set to PV_YES, messages will be displayed in the HTML generated from HTML templates and the {{form:messages}} template tag will be ignored.

App

PV_YES

PV_NO

Web. New in Panther 5.51

web_use_tooltips

When set to PV_YES, widgets that have the tooltip_text or the label property will get the title attribute in the generated HTML.

App

PV_YES

PV_NO

Web

webid

Name of the next cache file to be generated by the Web application server.

App

str

Web

where_operator

Operator to use in WHERE condition.

Wdg

PV_WHERE_EQUAL
PV_WHERE_GREATER
PV_WHERE_IN
PV_WHERE_LESS
PV_WHERE_LIKE
PV_WHERE_LIKE_R
PV_WHERE_LIKE_LR
PV_WHERE_NONE
PV_WHERE_NOT_EQUAL
PV_WHERE_NOT_GREATER
PV_WHERE_NOT_IN
PV_WHERE_NOT_LESS
PV_WHERE_NOT_LIKE
PV_WHERE_NOT_LIKE_R
PV_WHERE_NOT_LIKE_LR

use_in_where = PV_YES

where_use_if_null

Whether or not null value is included in WHERE condition.

Wdg

PV_YES

PV_NO

use_in_where = PV_YES

widget_type

Object type. Value corresponds to object type as listed. Types for widgets appears in next entry.

App Scr

PV_APPLICATION

PV_SCREEN

RT, RO

Widget type

Wdg
Sync TV
SelGrp

PV_DYNAMIC_LABEL
PV_SINGLE_LINE_TEXT
PV_MULTILINE_TEXT
PV_PUSH_BUTTON
PV_TOGGLE_BUTTON
PV_RADIO_BUTTON
PV_CHECK_BOX
PV_OPTION_MENU
PV_LIST_BOX
PV_LINK PV_HORIZONTAL_SCALE
PV_VERTICAL_SCALE
PV_COMBO_BOX
PV_BOX
PV_HORIZONTAL_LINE
PV_VERTICAL_LINE
PV_GRID_FRAME
PV_GRAPH
PV_REPORT_AREA PV_BLOB_DATA
PV_CARD
PV_DECK PV_STATIC_LABEL
PV_SYNC_GROUP PV_TABLE_VIEW
PV_GROUP
PV_ACTIVEX

RO

width

Horizontal size

Scr SrvCom Wdg

str; grid units (g) by default, characters (c), inches (in), millimeters (mm), or pixels (p).

No Web

word_wrap

Whether or not text should word wrap

Wdg

PV_YES

PV_NO

widget_type = PV_MULTILINE_TEXT. Word wrap behavior varies on each platform and on Web browsers.

x_axis_label

Text associated with x axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

x_axis_label_location

Location for x axis label in relation to graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

x_axis_location

Location of x axis in graph.

Wdg

PV_EDGE

PV_OPPOSITE_EDGE

PV_ZERO

PV_NONE

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

x_axis_maximum

Maximum number of data values that can be plotted along x axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

x_axis_minimum

Minimum number of data values that can be plotted along x axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

x_axis_scale

Scale type for x axis values in graph.

Wdg

PV_LINEAR PV_COMMON_LOG

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

x_tick_grid_style

Grid style tick marks along x axis of graph.

Wdg

PV_SOLID

PV_DASHED

PV_DOTTED

PV_NONE

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

x_tick_label_source

Source/values for labels associated with tick marks along x axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

x_tick_major_increment

Increment between major (larger) tick marks along x axis of graph.

Wdg

str (>0)

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

x_tick_minor_increment

Increment between minor (smaller) tick marks along x axis of graph.

Wdg

str (>0)

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

x_tick_style

Tick mark style for x axis of graph.

Wdg

PV_IN

PV_OUT

PV_BOTH

PV_NONE

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

x_tick_width

Tick mark width for x axis of graph.

Wdg

str (0 .. 100)

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

x_value_source[int]

Data value source for a given data series (up to 12).

Wdg

str

GUI, Web, chart_type = PV_XY_PLOT, y_value_source[int] = str

xml_attributes

Attributes for XML

Wdg
Scr

str

xml_import_error

PV_YES if the most recent import of XML data failed

App

PV_YES

PV_NO

xml_prefix

String to output before XML tag

Wdg
Scr

str

xml_postfix

String to output after XML tag

Wdg
Scr

str

xml_tag

Tag to assign to widget or screen in XML

Wdg
Scr

str

xml_utf8_data

UTF-8 data from import or to export

Wdg

str

RT

xy_style

Style for XY plot data series.

Wdg

PV_CURVE

PV_LINE

PV_POINT

GUI, Web, chart_type = PV_XY_PLOT and y_value_source[int] = str

y1_axis_label

Text associated with y1 axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y1_axis_label_location

Location for y1 axis label in relation to graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y1_axis_location

Y1 axis location in graph.

Wdg

PV_EDGE

PV_OPPOSITE_EDGE

PV_ZERO
PV_NONE

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y1_axis_maximum

Maximum number of data values that can be plotted along y1 axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y1_axis_minimum

Minimum number of data values that can be plotted along y1 axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y1_axis_scale

Scale type for y1 axis values of graph.

Wdg

PV_LINEAR

PV_COMMON_LOG

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y1_tick_grid_style

Grid style tick marks along y1 axis of graph.

Wdg

PV_SOLID

PV_DASHED

PV_DOTTED

PV_NONE

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y1_tick_label_source

Source/values for labels associated with tick marks along y1 axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y1_tick_major_incremen t

Increment between major (larger) tick marks along y1 axis of graph.

Wdg

str (>0)

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y1_tick_minor_incremen t

Increment between minor (smaller) tick marks along y1 axis of graph.

Wdg

str (>0)

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y1_tick_style

Tick mark style for y1 axis of graph.

Wdg

PV_IN

PV_OUT

PV_BOTH

PV_NONE

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y1_tick_width

Tick mark width for y1 axis of graph.

Wdg

str (0 .. 100)

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y2_axis_label

Text associated with y2 axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y2_axis_label_location

Location for y2 axis label in relation to the graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y2_axis_location

Y2 axis location in graph.

Wdg

PV_EDGE

PV_OPPOSITE_EDGE

PV_ZERO

PV_NONE

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y2_axis_maximum

Maximum number of data values that can be plotted along y2 axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y2_axis_minimum

Minimum number of data values that can be plotted along y2 axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y2_axis_scale

Scale type for y2 axis values of graph.

Wdg

PV_LINEAR

PV_COMMON_LOG

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y2_tick_grid_style

Grid style tick marks along y2 axis of graph.

Wdg

PV_SOLID

PV_DASHED

PV_DOTTED

PV_NONE

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y2_tick_label_source

Source/values for labels associated with tick marks along y2 axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y2_tick_major_incremen t

Increment between major (larger) tick marks along y2 axis of graph.

Wdg

str (>0)

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y2_tick_minor_incremen t

Increment between minor (smaller) tick marks along y2 axis of graph.

Wdg

str (>0)

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y2_tick_style

Tick mark style for y2 axis of graph.

Wdg

PV_IN

PV_OUT

PV_BOTH

PV_NONE

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y2_tick_width

Tick mark width for y2 axis of graph.

Wdg

str (0 .. 100)

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y_axis[int]

Y axis against which data in series (int) is plotted in graph.

Wdg

PV_Y1

PV_Y2

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW and y_value_source[int] = str

y_axis_label

Text associated with y axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y_axis_label_location

Location for y axis label in relation to graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y_axis_location

Y axis location in graph.

Wdg

PV_EDGE

PV_OPPOSITE_EDGE

PV_ZERO

PV_NONE

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y_axis_maximum

Maximum number of data values that can be plotted along y axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y_axis_minimum

Minimum number of data values that can be plotted along y axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y_axis_scale

Scale type for y axis values of graph.

Wdg

PV_LINEAR

PV_COMMON_LOG

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y_tick_grid_style

Grid style tick marks along y axis of graph.

Wdg

PV_SOLID

PV_DASHED

PV_DOTTED

PV_NONE

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y_tick_label_source

Source/values for labels associated with tick marks along y axis of graph.

Wdg

str

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y_tick_major_increment

Increment between major (larger) tick marks along y axis of graph.

Wdg

str (>0)

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y_tick_minor_increment

Increment between minor (smaller) tick marks along y axis of graph.

Wdg

str (>0)

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y_tick_style

Tick mark style for y axis of graph.

Wdg

PV_IN

PV_OUT

PV_BOTH

PV_NONE

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y_tick_width

Tick mark width for y axis of graph.

Wdg

str (0 .. 100)

GUI, Web, chart_type = PV_BAR | PV_XY_PLOT | PV_HIGH_LOW

y_value_source[int]

Y value source for given data series in XY plot graph, either the name of an array containing data, or a list of values.

Wdg

str

GUI, Web, chart_type = PV_XY_PLOT

zero_format

Whether or not format should be applied to data when it is zero.

Wdg

PV_YES

PV_NO

data_formatting = PV_NUMERIC


Accessing Properties

objectName->propertySpec

or

@objectModifier(objectIdentifier)->propertySpec

Object Identifiers

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.

Table 1-4 Object Identifiers

Object modifier Object identifier

@app

None. The current program object identifier is always specified as @app().

@field_num

Widget's field number on a screen (on the window stack or in an active LDB), specified as an integer value.

@id

Integer handle of any application object; obtained via the object's id property, or by calling sm_prop_id.

@ldb

Name (string value) of an LDB screen.

@screen

Name (string value) of a Panther screen on the window stack. Use @current to specify the current window.

@screen_num

Number of a screen on the window stack. An integer value as follows:

0: active screen; n<0: nth screen below active screen; n>0: nth screen above base (n=1) window.

@tp_req

String identifier (callid) associated with a service request. The identifier is stored in the tp_return application property immediately after a service call is initiated. To specify the current service, use @current as a string.

@widget

Name (string value) of widget or group on a screen that is on the window stack or in an active LDB. To specify the current widget, supply @current as a string.

Subscripts to widgets can refer to the occurrence (single brackets) or the array element (double brackets).

Property Specification

JPL

In JPL, access the properties via:

objectSpec->propertySpec

where propertySpec is specified as either:

Arrays

If the property is an array, specify the occurrence:

pkey2 = tapes->primary_key[2]

In widget arrays, subscripted references return the value of the specified occurrence [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")

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:

cust = @widget("customer")[2](1, 8)

C Functions

In C, access the properties via:

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.

The property constants used in the C functions are derived by converting the property name to upper case and prepending 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.

The following example returns the value of the hidden property for the 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);

For more information on accessing properties, refer to "Setting Properties Using the Property API," in Application Development Guide.

Properties marked with §, as in poll_frequency§, have a different C constant. See the main section.


Application Properties

Access:

@app()->property

agent_type

argc

argv[int]

auto_resize_ex_paths

auto_resize_no_touch

bold

codeset

conn_pool_size

control_string[logKey]

current_component_system

default_row_margin

devserv_id

display_codepage

drop_down_trim_empty

endsession

extra_line_size_check

field_below[int]

font_name

hdl_advertise

hdl_exception

hdl_jif_changed

hdl_message

hdl_post_request

hdl_post_service

hdl_pre_request

hdl_pre_service

hdl_request_received

hdl_server_exit

hdl_unadvertise

hdl_unload

hook_app_focus_change

html_max_loop

html_max_nest

id

in_gui

in_server

in_web

in_zoom

italic

java_use_codeset

max_bundles

max_fetches

max_rows_per_fetch

maximize_no_reposition

mouse_field

mouse_field_name

mouse_field_occ

mouse_form_name

num_fields_below

num_svs_below

num_tvs_below

old_ax_initialize

old_shrink_algorithm

point_size

poll_frequency§

previous_form

primary_key_update

provider_url

queryendsession

regenerate_ins_sql

regenerate_upd_sql

report_no_color

sv

sv_below[int]

three_d§

title

tm_ansi_joins

tm_ansi_outer_joins

tm_clear_fast

tm_scope

tm_server_view

tm_transaction

toolbar_allowed_sites

toolbar_current_site

toolbar_hidden

toolbar_x_position

toolbar_y_position

tooltip_style

tp_async_poll_interval§

tp_block

tp_commit_return

tp_exc_code

tp_exc_msg

tp_exc_names

tp_mon_exc_code

tp_mon_exc_msg

tp_return

tp_severity

tp_severity_names

tp_signal_restart

tp_svc_cache_size

tp_svc_outcome

tp_svc_return

tp_this_call

tp_timeout

tp_tran_level

tp_tran_status

tp_unsol_poll_interval§

tv_below[int]

underlined

view_full_page§

web_alt_as_tooltips

web_generate_ids

web_old_template_msgs

web_use_tooltips

webid

widget_type


Screen and Frameset Properties

Access:

screenName->property
@screen("screenName")->property
@screen("@current")->property
@screen_num(windowStackPosition)->property
@ldb("ldbName")->property

Identity

dialog

fldnum

frameset

id

java_tag

keep_in_frame

keep_on_top

memo1...memo9

mnemonic_position

name

numflds

numgrps

pane

parent_window

screen_type

sibling

splitter

three_d§

title

Geometry

grid_height

grid_width

height

max_min

min_horiz_space

min_vert_space

region_margin

resize_function

resizeable

startup

vncolms

vnlines

vofcolm

vofline

vstcolm

vstline

width

Color

bg_color_name

bg_color_num

bg_color_type

Font

bold

font_name

italic

point_size

underlined

Focus

control_string[logkey]

entry_function

exit_function

menu_name

menu_script_file

Help

external_help_tag

help_screen

popup_menu

status_line_text

Display

blink

border

border_bg_color_name

border_bg_color_num

border_bg_color_type

border_fg_color_name

border_fg_color_num

border_fg_color_type

border_style

close_item

dim

icon

pointer

reverse

system_menu

title_bar

wallpaper_pixmap

wallpaper_style

Transaction

default_tran

fetch_directions

model

root

Web

display_window

secure_post

stylesheet_data

stylesheet_link

stylesheet_source

stylesheet_type

target_default

HTML options

body_attributes

form_attributes

head_markup

html_template

Browser options

javascript

on_load

on_submit

on_unload

vbscript


XML Properties

xml_attributes

xml_postfix

xml_prefix

xml_tag


Service Component Properties

Identity

java_tag

memo1...memo9

screen_type

title

Geometry

height

width

Procedures

entry_function

exit_function

Transaction

fetch_directions

model

root


Service Request Properties

Access:

@tp_req(callid)->property
@tp_req("@current")->property

call_client

call_in_transaction

call_initial_text

call_no_reply

call_origin

call_priority

call_security_key

call_svc_alias

call_svc_name

call_text


Widget Properties

Access:

widgetName->property

If the widget's name is not unique in the current namespace:

@widget("widgetName")->property
@widget("@current")->property
@field_num(widgetFieldNum)->property

Identity

active

bi_string

c_type

card

card_number

column_title

comments

conceal_tabs

deck

default_cancel

di_string

drop_down_data[int]

drop_down_screen

drop_down_size

drop_down_source

fldnum

grid

grid_column

grid_current_occ

group

hidden

id

initialization

java_tag

justification

label

line_style

listbox_type

member

memo1...memo9

mnemonic_character

mnemonic_position

name

num_del_images

number_of_cards

precision

sign

sync_group

tableview

topmost_card

widget_type

Geometry

alt_scroll_func

array_size

auto_horiz_resize

auto_vert_resize

circular

column_move_resize

current_offset

end_column

end_row

first_occurrence

grid_current_occ

height

hor_scroll_bar

horiz_anchor

horiz_max_size

horiz_min_size

horizontal

length

max_data_length

max_occurrences

num_occurrences

onscreen_columns

onscreen_rows

position_region

row_margin

scroll_increment

scrolling

shift_increment

size_to_contents

spacing

start_column

start_row

vert_max_size

vert_min_size

vert_scroll_bar

vertical_anchor

width

Positioning

horiz_shrinking

min_horiz_space

min_vert_space

region_margin

vert_shrinking

Color

bg_color_name

bg_color_num

bg_color_type

blink

dim

fg_color_name

fg_color_num

fg_color_type

reverse

Font

bold

font_name

italic

point_size

underlined

Focus

alt_next_tab_stop

alt_prev_tab_stop

autotab

card_entry_func

card_exit_func

entry_function

exit_function

expose_function

focus_protection

hide_function

next_tab_stop

prev_tab_stop

row_entry_func

row_exit_func

selected

tab_entry_func

tab_exit_func

Help

auto_help

auto_item

external_help_tag

help_screen

popup_menu

popup_script_file

selection_screen

status_line_text

tooltip_text

Input

all_protect

clearing_protect

convert_case

edit_mask

input_protection

keystroke_filter

maximum_value

minimum_value

must_fill

reg_exp_filter

regular_exp

required

select_on_entry

table_lookup

Validation

calculation

control_string

double_click

mdt

no_validation

validation_func

valided

Format/Display

active_pixmap

armed_pixmap

border

border_style

clock_type

column_click_action

column_click_func

column_separators

column_titles

currency_symbol

custom_format

customer_drawn

data_formatting

date_format

decimal_places

decimal_symbol

empty_format

fill_character

frequency

frozen_columns

inactive_pixmap

justification

max_decimals

min_decimals

null_field

null_text

numeric_type

password_char

password_field

placement

repeating

rounding

row_separators

row_titles

sort_order

sort_order_func

stripe_current_row

style

system_update

thousand_sep

title

word_wrap

zero_format

Transaction

class

synchronization

Database

column_name

validation_link

version_column

Fetch data

group_by

having

select_expression

select_force_valid

select_set_valid

sv

tv

use_in_select

use_in_where

where_operator

where_use_if_null

New data

insert_expression

use_in_insert

Change data

in_update_where

update_expression

use_in_update

Remove data

in_delete_where

Column Edits

length

precision

scale

type

Web

auto_expand

default_link

export_to_html

html_name

image_map

ins_del_buttons

item_link

keep_image_size

radio_buttons

scroll_buttons

submit

target

HTML options

attributes

link_attributes

prefix_markup

suffix_markup

Browser options

javascript

on_blur

on_change

on_click

on_focus

on_mouse_out

on_mouse_over

on_select

vbscript

XML

xml_attributes

xml_postfix

xml_prefix

xml_tag

xml_utf8_data

Graphs

General

bar_chart_type

chart_3d

chart_type

depth

horiz_rotation

orientation

subtitle

subtitle_text_size

text_size

title

title_text_size

vert_rotation

Graph data

bar_style

data_basic_color

data_value_location

legend[int]

line_style[int]

line_width[int]

point_marker[int]

x_value_source[int]

xy_style

y_axis

y_value_source[int]

Pie

pie_diameter

pie_direction

pie_start_angle

pie_x_position

pie_y_position

Pie segments

seg_label_location

seg_label_source

seg_percent_location

seg_style_source

seg_value_location

Graph legend

legend_border_width

legend_in_data_space

legend_placement

legend_text_size

legend_title

legend_x_anchor

legend_x_location

legend_x_position

legend_y_anchor

legend_y_location

legend_y_position

Axis

x_axis_label

x_axis_label_location

x_axis_location

x_axis_maximum

x_axis_minimum

x_axis_scale

y1_axis_label

y1_axis_label_location

y1_axis_location

y1_axis_maximum

y1_axis_minimum

y1_axis_scale

y2_axis_label

y2_axis_label_location

y2_axis_location

y2_axis_maximum

y2_axis_minimum

y2_axis_scale

y_axis_label

y_axis_label_location

y_axis_location

y_axis_maximum

y_axis_minimum

y_axis_scale

Tick marks

x_tick_grid_style

x_tick_label_source

x_tick_major_increment

x_tick_minor_increment

x_tick_style

x_tick_width

y1_tick_grid_style

y1_tick_label_source

y1_tick_major_increment

y1_tick_minor_increment

y1_tick_style

y1_tick_width

y2_tick_grid_style

y2_tick_label_source

y2_tick_major_increment

y2_tick_minor_increment

y2_tick_style

y2_tick_width

y_tick_grid_style

y_tick_label_source

y_tick_major_increment

y_tick_minor_increment

y_tick_style

y_tick_width


Splitter Properties

Access:

widgetName->property
@widget("widgetName")->property
@widget("@current")->property

Identity

frameset

splitter

Geometry

splitter_col_width

splitter_cols

splitter_row_height

splitter_rows


Pane Properties

Access:

widgetName->property
@widget("widgetName")->property
@widget("@current")->property

Identity

frameset

splitter

Geometry

pane_col

pane_index

pane_row

Contents

pane_screen


ActiveX Control Properties

Access:

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.

ActiveX

clsid

control_name

runtime_license

show_status_text

Web

codebase


Selection Group Properties

Access:

widgetName->property
@widget("widgetName")->property
@widget("@current")->property

Identity

c_type

id

memo1...memo9

name

num_of_selections

precision

sign

Geometry

num_occurrences

Focus

alt_next_tab_stop

alt_prev_tab_stop

entry_function

exit_function

next_tab_stop

prev_tab_stop

mdt

validation_func

valided


Synchronized Scrolling Group Properties

Access:

widgetName->property
@widget("widgetName")->property
@widget("@current")->property

Identity

id

memo1...memo9

name

widget_type

Geometry

array_size

circular

max_occurrences

num_occurrences

scroll_increment


Table View Properties

Access:

widgetName->property
@widget("widgetName")->property
@widget("@current")->property

Identity

id

memo1...memo9

name

widget_type

Transaction

function

model

updatable

Database

columns[int]

del_func_name

delete_handling

ins_func_name

insert_handling

primary_key[int]

regenerate_ins_sql

regenerate_upd_sql

save_func_name

table

upd_func_name

update_handling

Server View

continue_func_name

count_result

count_select

count_threshold

count_warning

distinct

fetch_directions

sel_func_name

select_handling

sort_widgets

Service

delete_service

insert_service

select_service

update_service

Traversal

bi_status[int]

child[int]

field[int]

field_below[int]

key_constant[int]

key_field[int]

num_children

num_fields

num_fields_below

num_key_columns

num_sorts

num_sv_fields

num_svs_below

num_tvs

num_tvs_below

parent

parent_link

source_occ

sv

sv_below[int]

sv_field[int]

tv[int]

tv_below[int]


Link Widget Properties

Access:

widgetName->property
@widget("widgetName")->property
@widget("@current")->property

Identity

id

memo1...memo9

name

widget_type

Transaction

child

delete_order

insert_order

join_type

parent

relations[int]

type

update_order

Service

validation_service

Traversal

num_relations


Reports Properties

Access:

nodeName->property
@widget("nodeName")->property

Detail node

root§

sql_statement§

cursor_and_using§

Group node

break_on§

Call node

function_call§

Print node

area§

Subreport node

report_invocation§

Properties marked with §, as in poll_frequency§, have a different C constant. See the main section.


Mail Properties

Access:

@id(PR_MAIL_SYSTEM)->property
@id(messageObjectID)->property
mailName->property

PR_MAIL_SYSTEM Properties

mail_bcc

mail_cc

mail_connected

mail_flags

mail_from

mail_password

mail_port

mail_profile

mail_receipt

mail_replyto

mail_server

mail_subject

mail_to

mail_username

Mail Object Properties

mail_attachment_delete

mail_attachment_encoding

mail_attachment_filename

mail_attachment_pathname

mail_attachment_tag

mail_bcc

mail_cc

mail_from

mail_receipt

mail_replyto

mail_subject

mail_text

mail_to

name