Data Classes

List Box Data Class

 

When creating or editing a data class for a List Box control type, Data Class Definitions maintenance displays the following:

 


List Box Data Class
 (Load From File On) 
(Load From File was added in PxPlus 2019)


List Box Data Class (Load From File Off)

Note:
Properties marked with an * (asterisk) can be dynamic. Expressions that come from a data class must be global variables. See Dynamic Control Properties.

The following tabbed panels are available: Display, Attributes, User Aids, Validation and Query.

Class Name

Key to the data classes file (providex.dcl). When entering a new data class name, spaces are not allowed. Maximum length is 30 characters.

Click the Query button (binoculars) for a list of defined data classes (if any). Click the Browse buttons to browse to existing data classes. Click the Copy Class button to copy an existing data class to a new data class. If unsaved changes are detected when selecting these buttons, a message will display to save the changes.

(First/Last Class browse buttons were added in PxPlus 2019.)

(Add/Edit Notes)

(Available when a new or existing data Class Name is entered or selected)

Button used to add (or edit) notes for a new or existing data class. Maximum 1024 characters. The button's appearance and tooltip change to indicate that a note was added for the data class.

(The Add/Edit Notes button was added in PxPlus 2022.)

(Copy Class)

(Available when an existing data Class Name is selected)

Button used to create a new data class by copying the settings from an existing data class. Once it is created, the new data class must be saved, as the Copy process does not do this.

(The Copy Class button was added in PxPlus 2019.)

Last Class Change

This information is updated automatically whenever a change is made to the data class definition.

(Last Class Change was added in PxPlus 2023.)

Control Type

Default control type used to represent the data that belongs to your defined data class. Click the drop-down arrow for a list of selections: Multi Line, Drop Box, List Box, Radio Buttons, Check Box. (Default is Multi Line.)

The control type lets the NOMADS Panel Designer and File Maintenance Generator know which type of control to use for representing the data element.

Description

Generic description of the data class (Fixed value, Expression or Message Library Reference). This will be copied to the data dictionary when the data class is applied to an element. See Element Description.

*Dynamic

For new data classes created in PxPlus 2018, this check box is selected by default.

For data classes created prior to PxPlus 2018, this check box is not selected by default.

Select this check box to set dynamic control properties to Dynamic automatically when the data class is entered for a control in the Panel Designer. If Dynamic is not selected, dynamic control properties must be set to Dynamic manually after entering the data class for a control. See Dynamic Control Properties.

(The Dynamic check box was added in PxPlus 2018.)

Internal Data Type

Internal format of the data when manipulated by a program, either String or Numeric. (Default is String.)

Internal Size

Maximum size of the stored data element.

If the Internal Data Type is for a String variable, the Internal Size value will define the maximum string length. For a Numeric variable, enter nnn.dd where nnn is the maximum number of digits (including the decimal) and dd is the number of digits after the decimal point (i.e. the PRECISION of the number).

If the selected Control Type is Radio Buttons or Check Box, the Internal Size is 1.

Display ( * indicates a Dynamic property)

List Box Type

Select the type of list box.

Standard

(Default) Used to review and access a single column of data.

Report View

Displays multiple data elements in a tabular list with the use of headings and other attributes.

Formatted

Used to define multiple columns, line breaks and other formatting.

Tree View

Provides a tree-like structure view with optional bitmaps.

List View

Produces vertically wrapping columns (with optional bitmaps) where only the first element of each record is displayed.

(List Box Type was added in PxPlus 2018.)

Properties

List Box Width

Width of the control in number of columns - numeric expression. Format mask is ##0.00 and valid entries are 0 to 255.

List Box Height

Height of the control in number of lines - numeric expression. Format mask is ##0.00 and valid entries are 0 to 240.

*List Values

List of values that NOMADS uses to preload the list box. Can be a Fixed value or a string Expression. A data table/file can also be used.

Load From File

(Available when the Dynamic check box is selected)

Select this check box to define a data table/file as the source when populating a list box at run time. See Populate from Data Source.

(The Load From File check box was added in PxPlus 2019.)

Table

(Available when Load From File check box is selected)

Name of the data table/file. When a valid table/file is entered, the Key and Return Value fields are populated.

Click the Query Table View button (magnifying glass) for a tree view of table names by Group. For information on creating a filter to locate a specific table name, see Filtering the Table Names Lookup.

Click the Query button (binoculars) for a query view of tables by table name. For information on using the query features (i.e. search, sort, filter, etc.), see Run-Time Query.

Key

(Available when a Table is selected)

Key definition to use to read the selected Table. Defaults to the Primary key when a Table is entered. This key controls the sort sequence for the list box values.

If no Display Value is entered, the values for the selected Key will be loaded into the list box.

Display Value

(Available when a Table is selected)

(Optional) Specify a display value (either Fixed or Expression) to use to load the list box or leave blank.

If no Display Value is specified, the Key values will be used to load the list box.

Fixed

Select an element whose values will be used to load the drop box instead of the Key values.

Click the drop-down arrow for a list of string elements in the selected Table. This list includes numeric elements (if defined), which display either as =STR(value:"format") or =STR(value), depending on whether a Display format mask was defined for the numeric element in the Data Dictionary.

Examples:

=STR(ytdSales:"##,###,##0.00")

With Display format mask ##,###,##0.00

=STR(QtyOnHand)

Without a Display format mask

If a numeric element is selected when the data class is saved, the Display Value drop box will show Expression the next time this data class is accessed.

Expression

Enter an expression for the values to load in the list box.

The expression will be evaluated while loading the list box. Only variables available to the %nomads'class object may be used, which includes any columns from the Load From File Table or global variables or any system-wide variables. Constant string values may also be used.

Depending on the List Box Type associated with the data class, the format of these expressions will vary slightly, as explained below.

Standard and List View List Boxes

Individual lines in a Standard or List View list box are all one string. If desired, separate individual components with a separator such as ':' (colon), '/' (forward slash) or '-' (dash).

Examples:

   ClientCode$+': '+ClientName$

   'Date = '+DTE(InvoiceDate$:%Dl %Ml %D/%Y)

Formatted List Boxes

Formatted and Report View list boxes allow multiple columns to be used for one line of data. In this case, the standard column separator (SEP) should be used between components.

Note:
When using the Report View format, the names and lengths of the columns will be determined from the Data Dictionary.

When using a Tree View list box, use SEP to create nodes in the tree structure.

Examples:

   ProductCode$+SEP+ProductDescription$

   %CompanyCode$+SalesPersonCode$+SalespersonName$

(The ability to use numeric elements and specify an Expression was added in PxPlus 2020.)

Include Key and Value

(Available when Display Value is Fixed and a non-numeric element is selected)

(Optional) Select this check box to use both the Key value and the Display Value to load the list box in the following format: Keyvalue: DisplayValue. (By default, this check box is not selected.)

Example:

If the Key is ClientIDKey:Client ID and the Display Value is ClientName$, the list box will load using both these values:

  

Filter Test

(Available when a Table is selected)

(Optional) Enter an expression to filter the records that will be loaded in the list box if the expression is evaluated as True.

Examples:

   UCS(DepartmentCode$)=''EAST''

   MID(ProductCode$,1,3)=''CAR''

   ytdSales>0

(Filter Test option was added in PxPlus 2020.)

Return Value

(Available when a Table is selected)

Select the return value when an entry is selected from the list box. This value is used to define the Translation table for the list box.

Click the drop-down arrow for a list of defined Key values for the selected Table. Defaults to the Primary key when a Table is entered.

If an element is selected for the Display Value, then "List Box Display Value" will be added as an available selection to the top of the Return Value drop-down list.

Descriptive Field

(Available when a Table is selected)

(Optional) Specify a descriptive field (either Fixed or Expression) to allow it to be available when creating display-only Multi-Line controls in the NOMADS Panel Designer. See Extended Class Browse.

Fixed

Click the drop-down arrow to select from a list of string elements in the selected Table. This list includes numeric elements (if defined), which display either as =STR(value:"format") or =STR(value), depending on whether a Display format mask was defined for the numeric element in the Data Dictionary.

Examples:

=STR(ytdSales:"##,###,##0.00")

With Display format mask ##,###,##0.00

=STR(QtyOnHand)

Without a Display format mask

If a numeric element is selected when the data class is saved, the Descriptive Field drop box will show Expression the next time this data class is accessed.

Expression

Enter an expression to populate the value in the Multi-Line control when making a selection from the list box. The expression will be evaluated while validating the data. Only variables available to the %nomads'class object may be used, which includes any columns from the Load From File Table or global variables or any system-wide variables. Constant string values may also be used.

Examples:

   ClientCode$+': '+ClientName$

   'Date = '+DTE(InvoiceDate$:%Dl %Ml %D/%Y)

   SalespersonCode$+SEP+SalespersonName$ (see Note)

Note:
If a SEP is included in an expression, it will insert another line in the display-only Multi-Line control, which will require a Height setting greater than 1.

If entering an expression that includes columns from the selected Table, the Populate All Fields check box must be selected.

(Descriptive Field option for List Box data classes was added in PxPlus 2020.)

Populate All Fields

(Available when a Descriptive Field is entered or selected)

Select this check box to allow all data elements in the selected Table to be available when creating display-only Multi-Line controls in the NOMADS Panel Designer.

(Populate All Fields option for List Box data classes was added in PxPlus 2020.)

*Visual Class

Assign visual class to the control. See Visual Class Assignment.

Note:
Visual class names that begin with an *(asterisk) are pre-defined visual classes used by PVX Plus and may be subject to change without notice.

(added in PxPlus 2018)

*iNomads Class

The iNomads class contains class attribute references used when defining the control in the HTML code generated in iNomads. An iNomads class reference must start with an alpha character (A-Z or a-z), followed by any combination of A-Z, a-z, 0-9, underscore or dash. Multiple references may be entered, separated by a space. For a list of pre-defined iNomads classes, see iNomads Classes.

(added in PxPlus 2018)

Attributes ( * indicates a Dynamic property)

Attributes

Auto Tab Skip

Control is skipped when tabbing forward but is still accessible via Shift - Tab or the mouse.

Initially Disabled

Control region is grayed out and is not accessible to the user for input. The control is accessible programmatically.

Initially Hidden

Control is not displayed but is accessible programmatically.

Borderless

The control is drawn with no border or frame.

Strip Trailing

Strips trailing spaces when reading/writing data for control.

Signal On Exit

A signal is generated when focus leaves the control whether the selection or value has changed or not. NOMADS will execute the On Change logic.

Enable Scrolling

Allows the control to scroll in a resizable/scrollable dialogue box. See Panel Resizing.

Automatic (Signal All Changes)

A signal is returned on any changes in the control.

Disable On Empty

The system automatically disables the list box when it contains no entries. When populated, the list box is re-enabled. Overridden when the 'Enabled property is turned Off. Default is Off. (added in PxPlus 2018)

Ignore Change Flag

Select this check box when you do not want the NOMADS CHANGE_FLG variable to be updated when the control value is changed. (added in PxPlus 2017)

Standard Listbox Attributes

(Applicable when List Box Type is Standard)

Allow Variable Input

Enables the user to select any element from the list or enter any other value.

Input Length

(Applicable when List Box Type is Standard and Allow Variable Input check box is selected) Maximum input characters (Fixed or numeric Expression).

Multiple Selections

Users can select more than one entry from the list box.

No Height Adjustment

The list box will not be forced to show only complete lines. The last line will be truncated horizontally (i.e. displaying a partial line to ensure that the height of the list box matches the size defined). See Resizing Input Controls.

ReportView Attributes

(Applicable when List Box Type is Report View)

Partial Match

Partial matches in the list box data are highlighted. If selected, the text string used in a LIST_BOX WRITE will be considered a partial match for highlighting list box data; e.g. if you write "ABC", then the first item that starts with "ABC" is highlighted. (If the Multiple Selections attribute is also set, all items starting with "ABC" would be selected.)

Multiple Selections

Users can select more than one entry from the list box.

Disable Sorting

Clicking on the column heading does not cause list box elements to be sorted. The column headings will not have the 3D button look but will appear flat. Column resizing is still allowed.

Suppress Buttons

If this attribute is selected, the heading line is suppressed. The area that is occupied normally by the header is used for list output.

Column Size Lock

When selected, the Report View column headers cannot be resized by dragging. Default is Off.

Auto Column Size

When selected, columns will automatically be proportionally resized when the list box is resized. Default is Off.

Header Lock

Locks the column headers so that the user is unable to click on them or drag them. Default is Off.

Lines Per Row

Number of lines high per row. Valid values are >= 1. Allows for word wrap. Default is 1.0.

Lock Top Rows

Number of rows at the top of the list box to exclude from sorting. Enter a value or use the spinner controls to increase/decrease the value. (added in PxPlus 2019)

Lock Bottom Rows

Number of rows at the bottom of the list box to exclude from sorting. Enter a value or use the spinner controls to increase/decrease the value.

Grid Lines

Controls the display of grid lines between the rows and columns. Options are None (Default), Full grid, Vertical, Horizontal.

Center Text Vertically

Select this check box to center text vertically in the list box row only when Lines Per Row is > 1. Text that exceeds the column width is truncated and an ellipsis () is displayed. When not selected (Default), text is aligned to the top of the list box row, and text that exceeds the column width is word wrapped. (added in PxPlus 2019)

Sort Options

Controls how column data is sorted. Click the drop-down arrow for a list of selections:

Default

Null values at end

None (Raw binary sort)

Ignore case/Nulls last

Ignore case

Ignore accents/Nulls last

Ignore accents

Ignore case & accents/Nulls last

Ignore case and accents

 

The Default setting will use the system StdSortOrder setting. See 'OPTION' mnemonic or 'SortOrder$ property in the PxPlus Language Reference.

*Format

Button that launches the Report View Format Definition dialogue used to define various format options (i.e. title, width, alignment, sorting, etc.) for the columns in a Report View list box.

Formatted Listbox Attributes

(Applicable when List Box Type is Formatted)

Multiple Selections

Users can select more than one entry from the list box.

No Height Adjustment

The list box will not be forced to show only complete lines. The last line will be truncated horizontally (i.e. displaying a partial line to ensure that the height of the list box matches the size defined). See Resizing Input Controls.

*Format

Button that launches the Formatted List Box Definition dialogue used to define various format options (i.e. width, alignment, special options, etc.) for the columns in a Formatted list box.

TreeView Attributes

(Applicable when List Box Type is Tree View)

Data Has Bitmaps

As each entry in the tree view is added/written, then the beginning of the data is tested for the existence of a bitmap pathname enclosed within curly brackets. If a bitmap is present, then it overrides the standard bitmaps.

Direct Edit

Enables automatic editing so that the user can double click on an item to change its value.

Disable Sorting

The contents of the tree view will not be sorted automatically.

Suppress Buttons

By default, a tree view shows small buttons to the left of the entries with subordinate levels: either a '+' to indicate the existence of subordinates that have not been shown, or a '-' to indicate that the subordinates are being shown. Clicking the button toggles the display. If this attribute is selected, these buttons are suppressed.

Show Lines

Sets the tree view to draw connecting lines between the various entries.

*Format

Button that launches the Tree View Format Definition dialogue, which is used to set the Column Separator (delimiter character) and define default images to be displayed in the tree. You can define up to six default bitmaps or icons in tree views.

*States

Button that launches the State Indicators dialogue, which is used to set up images that will appear in front of a list box entry that can be used to indicate whether the item has been selected or not.

(Tree View States were added to Dynamic Data Classes in PxPlus 2019.)

ListView Attributes

(Applicable when List Box Type is List View)

Partial Match

Partial matches in the list box data are highlighted. If selected, the text string used in a LIST_BOX WRITE will be considered a partial match for highlighting list box data; e.g. if you write "ABC", then the first item that starts with "ABC" is highlighted. (If the Multiple Selections attribute is also set, all items starting with "ABC" would be selected.)

Multiple Selections

Users can select more than one entry from the list box.

*Format

Button that launches the List View Format Definition dialogue used to define various format options (i.e. title, width, alignment, sorting, etc.) for the columns in a List View list box.

Other

Alt-Key

Hot key for the control. Click the drop-down arrow for a list of selections. (added in PxPlus 2018)

*User Tag Field

For controls, data/tag field which can be used to pass information on such things as formatting, error messages or validation rules. Field contents are placed in a variable using the control name with a .TAG$ extension.

Full Line Highlight

(Applicable when List Box Type is Report View or List View) Full line highlight style allows the user to click any column to highlight the row; otherwise, the user can only click in the first column to highlight the row. Select from the drop-down list to set: Default, On, Off. Default indicates use of the PxPlus setting of the '+V' or '-V' mnemonic. (added in PxPlus 2018)

Object Persistence

Sets Object Persistence. (added in PxPlus 2018)

Click the drop-down arrow for a list of selections:

Default

Set via global variable

Always

On, overriding global activation

Never

Off, overriding global activation

User Aids ( * indicates a Dynamic property)

*Help Reference

Type

Click the drop-down arrow to select either Internal or External help reference:

Internal

Application supplied message text (Fixed value, string Expression or Message Library Reference).

External

Standard Windows help system consisting of a help file name and an optional keyword or reference number (Fixed or Expression).

*Floating Tip

Mouse pointer message for the control (Fixed value, string Expression or Message Library Reference).

You can customize the floating tip by adding a tip title, descriptive tip text and a hyperlink. These features enhance the visual display and functionality of the tip by providing users with much needed information at their fingertips. You can define either a Standard tip or an HTML tip that provides a simplified HTML Editor for customizing the tip text. To do this, click the button to the right of the Floating Tip multi-line input to invoke the Define Info Tip dialogue. See Defining an Info Tip.

Note:
The Floating Tip drop box and multi-line input cannot be changed once an HTML tip has been defined.

*Message Bar

Text to be displayed in the panel's status bar when focus is on the control (Fixed value, string Expression or Message Library Reference).

Validation ( * indicates a Dynamic property)

*Default Setting

Initial value to be highlighted when the list box is drawn (Fixed value or string Expression).

*Translation

Click the Translate check box to set up a table of values representing list box selections. Definition consists of a Table Value Length (length of each of the items in the table) and the translation value (Fixed or string Expression).

If the Dynamic check box is selected and the Load From File option is defined, the translation value will be set to Expression, the Table Value Length will be set to 0, and both will be locked.

(The setting of translation values for dynamic List Box data classes with Load From File functionality was added in PxPlus 2021.)

Query ( * indicates a Dynamic property)

*Query Type

Type of query to associate to the control: Panel, Query Program, Non-Query Logic. Valid formats include a NOMADS query object or query list, a custom query panel, or user-supplied query program.

Depending on the Query Type selected, different information is entered. For an explanation of each type and the information to enter, see Query Type.

*Panel Information

(Applicable when Query Type is Panel)

For an explanation of the information to enter, see Query Type: Panel.

*Query Program

(Applicable when Query Type is Query Program)

For an explanation of the information to enter, see Query Type: Query Program.

*Non-Query Logic

(Applicable when Query Type is Non-Query Logic)

For an explanation of the information to enter, see Query Type: Non-Query Logic.

 

 

Popup Menu

Button that is used to assign a popup menu to a data class (Fixed value or Expression, to be evaluated at run time when the popup signal occurs). A check mark displayed on the button indicates that a popup menu is currently assigned to the data class. This button invokes the Assign Popup Menu window for assigning Prior Popup logic, a pre-defined popup object or user-defined program. If selected, Prior Popup logic will be executed before the popup menu is displayed. If On Select logic exists for the control with the popup menu, this will be triggered before the popup event.

Select the Panel option in the Assign Popup Menu window to display a pre-set list of popup objects available for the highlighted library. The Program option is used to add a user-defined program. This can be either a Fixed value or Expression to be evaluated at run time when the popup signal occurs.

Write

Adds a new data class definition or updates an existing definition.

Delete

(Available when an existing data class is selected)

Removes the selected data class definition. Before proceeding, a message asks to confirm the deletion, as deleting a data class in use may cause issues.

Clear

Clears the current data class definition to allow you to define a new data class or select an existing definition.

Exit

Closes Data Class Definitions maintenance without saving any changes.

(The User Aids tab was added in PxPlus 2018.)