| Control Object Properties |
|
| The various properties available for defining ProvideX common control objects are described below. Each property name cross-references to one or more control object(s), which are described in the section Graphical Control Objects. | |||||||||||
| Align$ | GRID | ||||||||||
| Text
alignment. Valid values include TR
(top-right), TC (top-center), TL (top-left), R
(right), C (center), L
(left), BR (bottom-right), BC (bottom-center), BL
(bottom-left). Default: "L" (left) |
|||||||||||
| Auto | DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE TREEVIEW VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
Signal
on all changes: When set, the control will
generate a 'Change' event whenever its value changes as
opposed to the default off state where the control will
only generate the change event when losing focus.
There are three possible values:
|
|||||||||||
| AutoSequence | GRID | ||||||||||
| Automatic
row sequence. This assigns a column number
that will contain the automatic row sequence number.
ProvideX automatically fills in values of the cells with
the appropriate row number. When rows are changed, the
column containing the sequence number is automatically
updated. (Changing this property forces full redraw
of the grid). Default: 0. |
|||||||||||
| AutoState | TREEVIEW | ||||||||||
| Control automatic toggling of states. See State Indicators. | |||||||||||
| BackColour$ | BUTTON CHART CHECK_BOX DROP_BOX GRID LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARLIST_BOX | ||||||||||
| Background
colour. Valid colour names are listed under
Colour
Properties.
Default: "Default". |
|||||||||||
| BackColor$ | Background colour US spelling. See above. | ||||||||||
| BackHilight1$ | LIST_BOX
LISTVIEW Background colour, alternating lines. Valid colour names are listed under Colour Properties. Default: "Default". |
||||||||||
| BackHilight2$ | LIST_BOX
LISTVIEW Background colour, alternating three lines. Valid colour names are listed under Colour Properties. Default: "Default". |
||||||||||
| BigJump | H_SCROLLBAR
V_SCROLLBAR Scrollbar big jump value. Default: 0. |
||||||||||
| Bitmap$ | GRID | ||||||||||
| Bitmap
to appear in cell. For example, !Stop
(embedded bitmaps) or C:\windows\clouds.bmp (external bitmaps). |
|||||||||||
| BitmapPosition BUTTON CHECK_BOX RADIO_BUTTON TRISTATE_BOX | Bitmap position: 1=Left of text; 2=Right of text; 3=Above text; 4=Below text. Default: 1. | ||||||||||
| BottomBorder | GRID Bottom border of cell (thickness): 0 to 3 pixels. Default: 0. |
||||||||||
| BottomLeftTick$ GRID | Bottom
left tick. When set to a colour, this
displays a tick in the bottom left corner of the cell.
Valid colour names are listed under Colour
Properties.
Default: "Default". |
||||||||||
| CascadeState | TREEVIEW | ||||||||||
| Control cascading of states. See State Indicators. | |||||||||||
| CellFormat$ | GRID Cell format mask. Default: null. See FMT= option, MULTI_LINE Directive. |
||||||||||
| CellHiLight | GRID Cell selection highlight: 0=Cell is not highlighted; 1=Cell has focus rectangle; 2=Cell is highlighted (appears selected); 3=Cell is highlighted and has focus rectangle. Default: 1. |
||||||||||
| CellImpliedDecimal GRID | Cell Implied Decimal: Controls implied decimal input on cell by cell basis. | ||||||||||
| CellLeft | GRID Cell Left Position: Relative X position for cell. |
||||||||||
| CellTip$ | GRID Tip for Cell: Tip message. |
||||||||||
| CellTop | GRID Cell Top Position: Relative Y position for cell. |
||||||||||
| CellType$ | GRID Grid cell type. For a list of available cell type values, see Cell Types under the GRID Directive. Default: "Normal". |
||||||||||
| CellTypeList$ | GRID | ||||||||||
| List of supported cell types (described above). | |||||||||||
| Children | TREEVIEW | ||||||||||
| Number of direct descendant children for current item set by 'Item. | |||||||||||
| Col | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Screen position (column) of control. | |||||||||||
| Cols | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Width of control in column units. | |||||||||||
| Column | GRID LISTVIEW | ||||||||||
| Column number of grid or Listview. | |||||||||||
| Column$ | GRID | ||||||||||
| Grid column name. | |||||||||||
| ColumnNames$ GRID | Comma-separated list of Grid column names. | ||||||||||
| ColumnPixels | GRID | ||||||||||
| Width of column in pixels. | |||||||||||
| ColumnSizeLock GRID | Column resizing by user: 0=Off; 1=On. Valid only when Resizable < > 0. Default: 0. | ||||||||||
| ColumnsWide | GRID LISTVIEW | ||||||||||
| Number of columns. | |||||||||||
| ColumnWidth | GRID LISTVIEW | ||||||||||
| Width of column in column units. | |||||||||||
| CurrentCellColour$ GRID | Background
Colour for current cell. Valid colour names
are listed under Colour Properties. |
||||||||||
| CurrentColumn | GRID | ||||||||||
| Current column with focus. | |||||||||||
| CurrentItem | DROP_BOX LIST_BOX LISTVIEW TREEVIEW | ||||||||||
| Current item with focus/selected. Default: 1 (0, if no data). | |||||||||||
| CurrentPoint | CHART | ||||||||||
| Current data point. Default: 1 (0, if no data). | |||||||||||
| CurrentRow | GRID | ||||||||||
| Current row with focus. Default: 1. | |||||||||||
| CurrentSet | CHART | ||||||||||
| Current dataset. Default: 1 (0, if no data). | |||||||||||
| CtlName$ | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Control
type. This value can be one of the
following: "MULTI_LINE" (see MULTI_LINE Directive) "LIST_BOX" (see LIST_BOX Directive) "LIST_VIEW" (see LIST_BOX Directive) "TREE_VIEW" (see LIST_BOX Directive) "DROP_BOX" (see DROP_BOX Directive) "VARLIST_BOX" (see VARLIST_BOX Directive) "VARDROP_BOX" (see VARDROP_BOX Directive) "BUTTON" (see BUTTON Directive) "CHECK_BOX" (see CHECK_BOX Directive) "TRISTATE_BOX" (see TRISTATE_BOX Directive) "RADIO_BUTTON" (see RADIO_BUTTON Directive) "V_SCROLLBAR" (see V_SCROLLBAR Directive) "H_SCROLLBAR" (see H_SCROLLBAR Directive) "GRID" (see GRID Directive) "CHART" (see CHART Directive). |
|||||||||||
| DraggedColumn GRID | Column number dragged from. This indicates the column number (cell) where dragging started. Default: 0.See Drag and Drop. | ||||||||||
| DraggedRow | GRID | ||||||||||
| Row number dragged from. This indicates the row number (cell) where dragging started. Default: 0.See Drag and Drop. | |||||||||||
| DroppedOn | DROP_BOX LIST_BOX LISTVIEW TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX | ||||||||||
| Index number in list box. This indicates the index number that dragged items were dropped on to; if items are not dropped on to a specific line, 0 is returned. | |||||||||||
| DroppedOnColumn GRID | Column number where dropped. This indicates the column number (cell) where the mouse was released/items dropped. See Drag and Drop. | ||||||||||
| DroppedOnRow GRID | Row number where dropped. This indicates the row number (cell) where the mouse is released/items dropped. See Drag and Drop. | ||||||||||
| Edit | TREEVIEW | ||||||||||
| Control direct editing by user. This enables the automatic editing of item text; i.e., the user can double click on an item to change its value. (See OPT="E" under Treeview List Boxes) 1=allow editing, 0=no editing, -1=force current item into edit mode. Default: 0. | |||||||||||
| Enabled | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Enabled indicator: 1=True, 0=False. Default: 1. | |||||||||||
| EnterMode | GRID | ||||||||||
| Set movement for Enter key: 0=Normal Processing (edits cell); 1=Move right across a grid by column, exit on last column; 2=Move right across a grid by column, wrap to first column; 3=Move down by row, hold on last row; 4=Move down by row, return to column 1, hold on last row. Default: 0. Using Shift , with these key modes reverses the direction. The TabMode value is automatically applied to Enter if the '+E' mnemonic has been set; however, EnterMode can be changed to a different value, if needed. |
|||||||||||
| Eom$ | BUTTON CHART CHECK_BOX DROP_BOX GRID LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARLIST_BOX | ||||||||||
| Last change terminator. Refer to each control directive for specific eom$ character value. | |||||||||||
| ExcelStyle | GRID | ||||||||||
| Excel type grid: 0=No grid lines, 1=Lines. Default: 0. | |||||||||||
| Expanded | TREEVIEW | ||||||||||
| Node
expanded: -2=Collapse selected level and
all subordinates, -1/0=Collapsed, 1=Expanded, 2=Expand selected level and all sub-ordinates. Default: 0. |
|||||||||||
| Fmt$ | CHART GRID LIST_BOX LISTVIEW MULTI_LINE TREEVIEW | ||||||||||
| Control format definition. For more information, refer to the FMT= option as described under the associated control directive; e.g., CHART Directive. | |||||||||||
| Focus | BUTTON CHECK_BOX DROP_BOX GRID LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARLIST_BOX | ||||||||||
| Focus indicator: 1=Control has focus. Default: 0. | |||||||||||
| Font$ | BUTTON CHART CHECK_BOX DROP_BOX GRID LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARLIST_BOX | ||||||||||
| Font
for control/cell. Indicates font name,
size, and optional properties. Refer to the 'FONT' Mnemonic for details. |
|||||||||||
| Footer$ | CHART | ||||||||||
| Chart footer. | |||||||||||
| Height | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Height of control in pixels. | |||||||||||
| HoverColour$ | BUTTON CHECK_BOX LIST_BOX LISTVIEW RADIO_BUTTON TRISTATE_BOX | ||||||||||
| Hover colour. The button is highlighted when the mouse moves over its location. Valid colour names are listed under Colour Properties. Default: "Default". | |||||||||||
| HoverColor$ | Hover colour US spelling. See above. | ||||||||||
| hWnd | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Windows handle for control. | |||||||||||
| Id | RADIO_BUTTON | ||||||||||
| Radio button index to reference. | |||||||||||
| ImageCount | BUTTON RADIO_BUTTON TRISTATE_BOX | ||||||||||
| Number of images contained in a bitmap button. 1 to 4. Default: 0. | |||||||||||
| ImpliedDecimal | GRID
MULTI_LINE Implied Decimal: Controls implied decimal input in grids and multi-lines. |
||||||||||
| InsDelEnabled | GRID | ||||||||||
| Cell editing keys. 0=Off, 1=On. Default: 0.This enables use of Insert to begin cell editing and Delete for clearing the contents of a cell. | |||||||||||
| Item | DROP_BOX LIST_BOX LISTVIEW TREEVIEW VARDROP_BOX VARLIST_BOX | ||||||||||
| Index number of item in list. | |||||||||||
| ItemCount | DROP_BOX LIST_BOX LISTVIEW TREEVIEW VARDROP_BOX VARLIST_BOX | ||||||||||
| Number of items in list. See Load on Demand. | |||||||||||
| ItemNeededCtl LIST_BOX LISTVIEW | Signal/CTL event number to generate when items are requested from the list box. This property must be set prior to pre-declaring the number of items the listbox is to have by setting the ItemCount property. See Load on Demand. | ||||||||||
| ItemNeededFrom LIST_BOX LISTVIEW | Index number of the items requested. The 'ItemNeededFrom and 'ItemNeededTo properties are set once the user scrolls the list box to request more items to be loaded. See Load on Demand. | ||||||||||
| ItemNeededTo | LIST_BOX LISTVIEW | ||||||||||
| Index number of the items requested. See Load on Demand. | |||||||||||
| ItemState | TREEVIEW | ||||||||||
| Numeric value indicating the state of the item. 1-based, 0=No state indicator. There is a maximum of 15 states. This property is used in conjunction with 'StateBitmaps$. See State Indicators. | |||||||||||
| ItemTag$ | TREEVIEW | ||||||||||
| Maintain hidden tag string on item set by 'Item. This tag can hold internal user-defined information about the item such a file keys, etc. | |||||||||||
| ItemText$ | DROP_BOX LIST_BOX LISTVIEW TREEVIEW VARDROP_BOX VARLIST_BOX | ||||||||||
| Value of the current item set by 'Item. | |||||||||||
| JoinColumns | GRID | ||||||||||
| Merge two or more columns (left to right). Set this property in the column that starts the join (leftmost) to the total number of joined columns - that number of columns will be merged into one. For columns belonging to an existing join, this property returns a negative integer indicating the column current position within the join. | |||||||||||
| JoinRows | GRID | ||||||||||
| Merge
two or more rows (downward). Set this
property in the row that starts the join (uppermost) to the total number of joined rows - that number of rows will be merged into one. For rows belonging to an existing join, this property returns a negative integer indicating the rows current position within the join. |
|||||||||||
| Key$ | BUTTON CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Hot key to jump to control. | |||||||||||
| Left | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Left margin for control in pixels. | |||||||||||
| LeftBorder | GRID | ||||||||||
| Left border of cell (thickness): 0 to 3 pixels. Default: 0. | |||||||||||
| LegendLocation$ CHART | Location
of chart legend. Values include: TopLeft,
Left, BottomLeft, TopRight, Right, and BottomRight. |
||||||||||
| LegendText$ | CHART | ||||||||||
| Legend text for a data set. | |||||||||||
| Len | GRID MULTI_LINE VARDROP_BOX VARLIST_BOX | ||||||||||
| Input length of cell or line. | |||||||||||
| Line | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Screen position of control. | |||||||||||
| LineColour | TREEVIEW | ||||||||||
| Colour of lines to use connecting entries in the Treeview. | |||||||||||
| Lines | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Height of control in number of lines. | |||||||||||
| LoadIOList$ | GRID | ||||||||||
| 'LoadList$ in compiled IOList format. See Loading/Accessing by Row. | |||||||||||
| LoadList$ | GRID | ||||||||||
| List of columns loaded. Lists column names in the order they appear physically in the grid. Loading/Accessing by Row. | |||||||||||
| Lock | GRID LIST_BOX | ||||||||||
| Lock status. 1=Lock, 0=Unlock. Default: 0. | |||||||||||
| LockColumns | GRID | ||||||||||
| Number of columns to lock into position, starting from column 1. | |||||||||||
| LockRows | GRID | ||||||||||
| Number of rows to lock into position, starting from row 1. | |||||||||||
| MaxValue | H_SCROLLBAR V_SCROLLBAR | ||||||||||
| Maximum scroll bar value. | |||||||||||
| MenuColumn | GRID | ||||||||||
| Column number on right-click. This property indicates the column number of a selected cell on a right-click of the mouse. | |||||||||||
| MenuCtl | BUTTON CHART CHECK_BOX DROP_BOX GRID LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARLIST_BOX | ||||||||||
| CTL value on right-click. This property reports/sets the CTL value to generate when an object is selected on a right-click of the mouse. | |||||||||||
| MenuRow | GRID | ||||||||||
| Row number on right-click. This property indicates the row number of a selected cell on a right-click of the mouse. | |||||||||||
| MouseOver | LIST_BOX LISTVIEW TREEVIEW | ||||||||||
| Item number on mouse-over. This property returns the item number of an object when the mouse pointer is over it. If the mouse is not over an object, -1 is returned. 0 is returned if the cursor is over an area in the control with no data. | |||||||||||
| Msg$ | BUTTON CHECK_BOX DROP_BOX GRID LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX | ||||||||||
| Message line text for the control. | |||||||||||
| MultiSelect | GRID | ||||||||||
| Select multiple cells: 1=On; 0=Off. Default: 1. | |||||||||||
| NotifyExpand | TREEVIEW | ||||||||||
| Detect expand/collapse requests. When set to non-zero value, this causes a tree view expand/collapse to generate an event with EOM code "+" (expand) or "-" (collapse). | |||||||||||
| Nul$ | MULTI_LINE | ||||||||||
| Null input display text. | |||||||||||
| NumPoints | CHART | ||||||||||
| Largest number of data points within data set. | |||||||||||
| NumSets | CHART | ||||||||||
| Total number of data sets. | |||||||||||
| OnFocusCtl | BUTTON CHECK_BOX DROP_BOX GRID LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX | ||||||||||
| On focus CTL event. 0 is returned if no on focus CTL value is set up for the control. | |||||||||||
| OverlapEnabled GRID | Allow cells to overlap: 1=Yes, 0=No. Default: 1. | ||||||||||
| Parent | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Parent window handle. | |||||||||||
| PointText$ | CHART | ||||||||||
| Point label values. Single string of point label values where the last character is the delimiter. | |||||||||||
| PrefixData | TREEVIEW | ||||||||||
| Control prefix on data loaded into Treeview. 0=No prefix on the data - data has bitmap option off; 1=Data loaded in the Treeview can be prefixed with curly braces containing a bitmap, state value, and tag value (separated with semi-colons) - data has bitmap option on; 2=Returns same prefix with curly braces when data is read, and can be supplied when the data is written (as above). | |||||||||||
| Resizable | GRID | ||||||||||
| Enable grid resize by user: 0= Neither row or columns are resizable; 1=Both columns and rows are resizable; 2=Columns are resizable, rows are not; 3=Rows are resizable, columns are not. Default: 1. | |||||||||||
| RightBorder | GRID | ||||||||||
| Right border of cell (thickness): 0 to 3 pixels. | |||||||||||
| Row | GRID | ||||||||||
| Grid row reference. | |||||||||||
| RowData$ | GRID | ||||||||||
| Row data based on. LoadList$. See Loading/Accessing by Row. | |||||||||||
| RowHeight | GRID | ||||||||||
| Height of current row in lines. | |||||||||||
| RowHiLight | GRID | ||||||||||
| Row selection highlight: 1=Row Highlight; 0=Cell Highlight. This enables selection of a full row rather than limited to cells. Only locked cells are highlighted. One side effect is that when the cells are locked the grid becomes a fancy list view. | |||||||||||
| RowPixels | GRID | ||||||||||
| Height of row in pixels. | |||||||||||
| RowsHigh | GRID | ||||||||||
| Number of rows defined in Grid. | |||||||||||
| Scroll | MULTI_LINE | ||||||||||
| Set
scroll bar types.0=No scroll bars,
1=Vertical scroll bars, 2=Horizontial scroll bars, 3=Both scroll bars. |
|||||||||||
| SelectColumn | GRID | ||||||||||
| Column number of selected cell. (Read Only) See Multiple Selections. | |||||||||||
| SelectCount | GRID LIST_BOX LISTVIEW TREEVIEW | ||||||||||
| Number
of items/cells selected. Set this property
to zero to de-select all items. See Multiple Selections. |
|||||||||||
| SelectedChildren TREEVIEW | Number Of Child Items. Used in conjunction with 'SelectStateMask to return the number of child items with the desired state. (Children being entries on the tree that have no sub-ordinates). See Multiple Selections. | ||||||||||
| SelectIndex | CHART GRID LIST_BOX LISTVIEW TREEVIEW | ||||||||||
| Index to 'SelectItem. Set this property to point to a selected element; e.g., 1 points to the first item selected, 2 points to the second item selected, etc. See Multiple Selections. | |||||||||||
| SelectItem | LIST_BOX LISTVIEW TREEVIEW | ||||||||||
| Item number in list selected. This returns the sequential location within the list of the item being pointed to by 'SelectIndex property. See Multiple Selections. | |||||||||||
| SelectLength | MULTI_LINE VARDROP_BOX VARLIST_BOX | ||||||||||
| Length of selected item. This reports the number of characters currently highlighted. This allows for cut, copy, and paste within a GUI input region. | |||||||||||
| SelectOffset | MULTI_LINE VARDROP_BOX VARLIST_BOX | ||||||||||
| Position where highlight/cursor begins. This indicates where the highlight begins within the data or, if nothing is highlighted, the current cursor location.This allows for cut, copy, and paste within a GUI input region. | |||||||||||
| SelectRow | GRID | ||||||||||
| Row number of selected cell. (Read Only) See Multiple Selections. | |||||||||||
| SelectStateMask TREEVIEW | State filter to apply. See State Indicators. | ||||||||||
| SelectText$ | MULTI_LINE VARDROP_BOX VARLIST_BOX | ||||||||||
| Text
contained within the highlight. This allows
for cut, copy, and paste within a GUI input region. See Multiple Selections. |
|||||||||||
| SelectValue$ | GRID | ||||||||||
| Value within selected field. See Multiple Selections. | |||||||||||
| Sep$ | CHART DROP_BOX GRID LIST_BOX LISTVIEW MULTI_LINE TREEVIEW VARDROP_BOX VARLIST_BOX | ||||||||||
| Separator character between each field, column, or data point. | |||||||||||
| SepLoad$ | CHART DROP_BOX GRID LIST_BOX LISTVIEW MULTI_LINE TREEVIEW VARDROP_BOX VARLIST_BOX | ||||||||||
| Separator character for each row or data set. | |||||||||||
| SignalOnExit | DROP_BOX GRID LIST_BOX LISTVIEW MULTI_LINE TREEVIEW VARDROP_BOX VARLIST_BOX | ||||||||||
| Signal event on exit: 0=No signal on exit; 1=Signal on exit; 2=Grid only, signal when changing row or on exit (sets column value to 0 and row value to last row exited; 3=Grid only, signal when changing row or on exit (sets column and row values to zero). | |||||||||||
| SignalOnly | BUTTON CHECK_BOX RADIO_BUTTON TRISTATE_BOX | ||||||||||
| Signal
only-do not get focus: 0=Off; 1=On. This
property can also be read, returning 1 or 0 to indicate if the control is to signal only and not get focus. Default: 0. |
|||||||||||
| SkipLockedCells GRID | Skip over locked cells: 1=On; 0=Off. Default: 1. | ||||||||||
| SmallJump | H_SCROLLBAR V_SCROLLBAR | ||||||||||
| Scroll bar small jump value. | |||||||||||
| Sort | LISTVIEW TREEVIEW GRID | ||||||||||
| Column
sorting. In Listviews
and GRID, this property sets the number of columns
to sort by. Negative integers indicate descending order. In Treeviews, sorting values indicate the following: 1=Automatically sort data in ascending order; 0=Reset sort indicators; -1= cause current 'Item to be sorted; -2 cause the current 'Item and its descendants to be sorted. Default: 1. Grid support for the 'Sort property is a +PxPlus Exclusive When using the Grid sort on Numeric data, the currency sign, thousands separator, and decimal point is established when the grid is first created. |
|||||||||||
| StateBitmaps$ | TREEVIEW | ||||||||||
| List
of images used to display states. Separated
by vertical bars; e.g., "!Stop|!Print". A maximum of 15 images can be applied to this property. See State Indicators. |
|||||||||||
| SwapEnabled | GRID | ||||||||||
| Column swap enabled: 1=Yes, 0=No. Default: 0. | |||||||||||
| TabMode | GRID | ||||||||||
| Movement setting for Tab key: 0=Normal Processing (exits grid); 1=Move right across a grid by column, exit on last column; 2=Move right across a grid by column, wrap to first column; 3=Move down by row, hold on last row; 4=Move down by row, return to column 1, hold on last row. Default: 0. | |||||||||||
| Tbl$ | CHECK_BOX DROP_BOX LIST_BOX RADIO_BUTTON TRISTATE_BOX | ||||||||||
| Translation table. Returns table of single-character values representing selections. | |||||||||||
| Text$ | BUTTON CHECK_BOX GRID RADIO_BUTTON TRISTATE_BOX | ||||||||||
| Text of item or label. In a grid, this property applies to "Button"cell types only. | |||||||||||
| TextColour$ | BUTTON CHART CHECK_BOX DROP_BOX GRID LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARLIST_BOX | ||||||||||
| Foreground text colour. Valid colour names are listed under Colour Properties. Default: "Default". | |||||||||||
| TextColor$ | Foreground text colour US spelling. See above. | ||||||||||
| TickPerUnit | GRID | ||||||||||
| Display
units in grid "ruler". This sets
the number of ruler-style "ticks" between
numbers (units) displayed in the header cells (row and
column) of the grid; e.g., 'TickPerUnit=8 will display a number every 8 ticks on the ruler and causes median points (at 'TickPerUnit/2) to appear slightly larger. Ruler numbers begin at zero and count upwards by whole numbers, but will be reset to zero again if the header cell contains a 'Value$ greater than null. Default: 0. |
|||||||||||
| TickPixels | GRID | ||||||||||
| Pixels
between ticks in grid "ruler".
This sets the space in pixels between ruler-style "ticks" (marker lines) displayed in the header cells of the grid. |
|||||||||||
| Tip$ | BUTTON CHART CHECK_BOX DROP_BOX GRID LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARLIST_BOX | ||||||||||
| Tip message for control. | |||||||||||
| Title1$ | CHART | ||||||||||
| Primary chart title. | |||||||||||
| Title2$ | CHART | ||||||||||
| Secondary chart title. | |||||||||||
| Top | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Top of control in pixels. | |||||||||||
| TopBorder | GRID | ||||||||||
| Top border of cell (thickness): 0 to 3 pixels. Default: 0. | |||||||||||
| TopLeftTick$ | GRID | ||||||||||
| Top left tick. When set to a colour, this displays a tick in the top left corner of the cell. Valid colour names are listed under Colour Properties. Default: "Default". | |||||||||||
| TrackColour$ | GRID | ||||||||||
| Cell tracking colour. Header cells corresponding to a cell that currently has focus are switched to colour set by this property as the user moves around the grid. This provides a visual cue to the user for which column and row they are currently on. Only header cells that use their default colour will change to the tracking colour. Valid colour names are listed under Colour Properties. Default: "Default". | |||||||||||
| TrackColor$ | Cell tracking colour US spelling. See above. | ||||||||||
| Uppercase | GRID MULTI_LINE | ||||||||||
| Force text to uppercase. 1=On, 0=Off. Default: 0. | |||||||||||
| Value$ | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Current item or grid cell value. | |||||||||||
| ValuenNoSignal$ | LIST_BOX
LISTVIEW MULTI_LINE TREEVIEW |
||||||||||
| Same as 'Value$ however when used to change the value in the control no "OnChange" event will occur. This property is a +PxPlus Exclusive | |||||||||||
| Visible | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Control visible flag: 1=Yes, 0=No. Default: 1. | |||||||||||
| Width | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Width of control in pixels. | |||||||||||
| XAxisLocation$ CHART | X-Axis location. (Back or Bottom). Default: "Bottom" | ||||||||||
| XAxisTitle$ | CHART | ||||||||||
| X-Axis title. | |||||||||||
| YAxisLocation$ CHART | Y-Axis location. (Back or Left). Default: "Left" | ||||||||||
| YAxisTitle$ | CHART | ||||||||||
| Y-Axis title. | |||||||||||
| ZAxisLocation$ CHART | Z-Axis location. (Bottom or Left). Default: "Left" | ||||||||||
| ZAxisTitle$ | CHART | ||||||||||
| Z-Axis title. | |||||||||||
| _PropList$ | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Contains list of Properties. See Multi-Property Access. | |||||||||||
| _PropSep$ | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Separator between values. See Multi-Property Access. | |||||||||||
| _PropValue$ | BUTTON CHART CHECK_BOX DROP_BOX GRID H_SCROLLBAR LIST_BOX LISTVIEW MULTI_LINE RADIO_BUTTON TREEVIEW TRISTATE_BOX VARDROP_BOX VARLIST_BOX V_SCROLLBAR | ||||||||||
| Accesses property values. See Multi-Property Access. | |||||||||||
| Colour Properties | The
properties used to define colour attributes in various
graphical control objects include the following: |
||||||||||
| BackColour$ | BottomLeftTick$ | TopLeftTick$ | |||||||||
| BackHilight1$ | CurrentCellColour$ TextColour$ | ||||||||||
| BackHilight2$ | HoverColour$ | TrackColour$ | |||||||||
| To apply a colour to these properties, use one of the following valid colour names: Default Dark Gray Black |
|||||||||||
| Dark
Red Light Red Dark Green Light Green |
|||||||||||
| Dark Blue | |||||||||||
| Light Blue | |||||||||||
| Dark
Magenta Light Magenta Light Gray White |
|||||||||||
| ... or use a RGB code (RGB:n n n where n=0-255) or user-defined colour (refer to the 'COLOUR' & '_COLOUR' Mnemonics). |
|||||||||||