Each control has a set of properties associated with it that governs attributes of the control's appearance or behavior. Some properties are set when you define the control, while others are defined only at runtime. While you can manipulate most properties through your code at runtime, each time that the application is started the value associated with each property is initialized. The functions Get_Property() and Set_Property() are used to get the value assigned to a particular property, and to set the value associated with a particular property.
In this chapter, properties are arranged in alphabetical order. Each property includes a description, sample usage, and explanation of the usage and values returned by Get_Property() and Set_Property(). Properties designed specifically for use by Lotus Notes developers are labeled with an icon; properties for use with OpenInsight native data only are also noted with an icon.
For more information about properties, refer the Guide to Application Development, which includes information on controls and properties that apply to each.
Definitions
For the purposes of this chapter the following definitions apply.
- Control: Graphical object used in a window or form to process text, or to control processing.
- Linked Control: A control that is linked to a data table.
- Interactive Control: Any control that can have focus and be controlled by keyboard
OpenInsight Properties Reference
| Command | Description |
|---|---|
| ACCELERATOR | Returns or defines an accelerator key for a menu item. |
| ACCEPTDROPFILES | A boolean property that lets the operating system know if a user can drag files from the Operating System shell to the OpenInsight form or control. |
| ACCESSDATA | Sets or returns the text in the cell that the cursor is currently positioned in (ACCESSPOS) |
| ACCESSPOS | Sets or returns the position of the internal cursor in the edit table. |
| ANCHORBOTTOM | Returns or sets the controls bottom anchor status. |
| ANCHORRIGHT | Returns or sets the controls right anchor status. |
| ARRANGEICONS | When set to true, indicates that minimized MDI child windows (for MDI frame) or icon (for window) will automatically be kept arranged. |
| ARRAY | Returns or sets all cell values as a two dimensioned array indexed by column, then row for the specified edit table control. |
| ATRECORD | Set and retrieve record as reflected in the window. |
| AUTOSCROLL | When set to 1, tabbing and control accelerators (eg., the underlined letter in a label like "Close") are used to automatically change pages. |
| AUTOSIZECOL | When not set to 0, and any column in an edit table is resized, the width of the specified column is automatically adjusted. |
| AUTOSIZEHEIGHT | Returns or sets the controls autosize height status. |
| AUTOSIZEWIDTH | Returns or sets the controls autosize width status. |
| BACKCOLOR | Sets or retrieves the RGB value associated with the background color of the specified control. |
| BITMAP | Get_Property returns the path to the picture file; Set_Property sets the path and whether the bitmap should be transparent. |
| BLOCK_EVENTS | Setting the BLOCK_EVENTS property to true disables the generation and processing of all event messages (except for CLOSE) in the system. |
| CANCEL | With Get_Property, returns the control identifier to which the CANCEL property has been assigned. |
| CANUNDO | If an action that can be undone has been performed against the control, CANUNDO returns true. |
| CARETPOS | Indicates the position of the caret in the control. |
| CELLPOS | With Set_Property, allows you to enter data to or retrieve from a specific cell of an edit table. |
| CHARMAP | The 255-character conversion map used for keyboard input. |
| CHECK | Returns or sets the value of a check box. |
| CLICKPOS | Returns the position of the mouse when the button is clicked over the edit table. |
| CLIENTSIZE | Use with Get_Property, only. |
| COLDATA | Fills or retrieves the current column (SELPOS) of the edit table as @VM-delimited array of cells. |
| COLUMN | Returns the name of the column that the specified control is linked to. Use with Get_Property, only. |
| CONV | Returns the output conversion specification for the named control. |
| COUNTER | Returns the current value and increments the value of COUNTER. |
| CTRLMAP | Returns an @FM-delimited list of control identifiers, as they apply to the specified window, including the menu. |
| CURSOR | Returns or sets the cursor to be used when a control has focus. |
| DATASOURCETYPE | Returns the type of datasource the control is bound to (i.e., Notes Form, DataSet) |
| DDECOMMAND | Sends a command string to the server. |
| DDEERROR | Returns any error code generated by the DDE connection or activity processes. |
| DDEITEM | The specification of the DDE field, and part three of the DDE three-level hierarchy. |
| DDELINK | Establishes a DDE link with a server, in one of four modes. |
| DDEDATA | Pokes or retrieves data to or from the DDE server. |
| DDEMODE | Used only with Get_Property, returns the connection mode for the current DDE session. |
| DDESERVICE | Part one of the DDE three-level hierarchy. |
| DDETOPIC | Part two of the DDE three-level hierarchy. |
| DEFAULT | Returns or sets the DEFAULT property to one (and only one) button in a window. |
| DEFPROP | Returns or sets a value of the default property for that control. |
| DESIGNMODE | A boolean property that, when set, implements the following behavior on a control: |
| DESTROY_FLAG | Use with Get_Property only. |
| DEVMODE | Returns the value of the DV switch used to launch OpenInsight. |
| DRAGFORMATLIST | Contains an @fm-delimited list of data formats being dragged. |
| DRAGTEXTSELECTION | Contains the starting point and length of the selected text used for a drag operation. |
| DRAGSELROWCOUNT | Contains the numbers of rows being dragged from a row-oriented control. |
| DRAGSELROWS | Contains the row numbers of the data being dragged from a row-oriented control. |
| DRAGPOS | Contains the client coordinates of the mouse (i.e relative to the control’s client area) when the drag operation started. |
| DRAGCOPY | A boolean property denoting if a drag source control allows a copy operation |
| DRAGMOVE | A boolean property denoting if a drag source control allows a MOVE operation. |
| DRAGCELLPOS | Contains the cell position of data begin dragged within an edit table. |
| DRAGBUTTON | Contains a number specifying which mouse button was used to start the drag operation. |
| DRAGSOURCE | Contains the name of the OpenInsight control that is the "drag source" during a drag operation. |
| DRAWTEXT | Specifies whether the value contained in the HELPTEXT property is displayed as text on the screen or as balloon help. |
| DROPACCEPT | Set to false during a DRAGOVER event to stop OpenInsight from performing data comparisons against the drop target untl the control is entered again. |
| DROPCOPY | A boolean property denoting if a drop source control allows a copy operation. |
| DROPSOURCE | Contains the name of the OpenInsight control that is the "drag source" during a drag operation. For use with Get_Property only. |
| DROPDOWN | Drops down the list box (Set_Property), or returns true or false (Get_Property). |
| DROPFORMATLIST | Contains an @fm-delimited list of data formats accepted by the control. |
| DROPMOVE | A boolean property denoting if a drop source control allows a MOVE operation. |
| DROPRESULT | The DropResult property is set to prevent OpenInsight from performing any default data copy or move operations after the DRAGROP event returns. |
| DROPTARGET | Contains the name of the OpenInsight control that is currently the target of a drag-drop operation. |
| DROPTYPE | Used during the DRAGDOP event to let the system know what operation took place. |
| DSOHANDLE | Returns the handle of the DataSet associated with a control. |
| DTHANDLE | Returns the underlying handle of the datatable object. |
| DUMMYCAPTION | Allows the specified control to behave as if it is the title (or caption) bar of a window. |
| ECHO | If the specified control has a CHAR event, this property allows you to turn the echo of user keystrokes on or off. |
| ENABLED | Allows a disabled control to issue an event, or disables a control. |
| ENABLEDRAG | A boolean property to allow data to be dragged from that control. |
| ENABLEDRAGLIST | A boolean property to allow combobox lists to be dragged from that control. |
| ENABLEDRAGROWS | A boolean property to allow selected rows within an edittable to be dragged from that control. |
| ENABLEDROP | A boolean property to mark the control as a drop target. |
| ENABLEDROPEXPAND | A boolean property to allow the control to respond to mouse hover notifications and expanding a node automatically. |
| ENABLEDROPSCROLL | A boolean property to allow the control to respond to mouse hover notifications while data is dragged over the control. |
| ENABLEDROPLIST | A boolean property to allow simple combo box drop target controls to register their list component as a drop target. |
| EVENTQUALIFIER | Sets or retrieves the event qualifier for the MENU event of a MENU item. |
| EVENROWCOLOR | Set and retrieve the RGB color of even numbered rows within an edit table. |
| EXITCODE | Returns the exit code (integer) of the last Windows application started by Utility ("RUNWIN", …). |
| FOCUS | Used to determine if a control has focus, or to set focus to a control. |
| FOCUSCELLCOLOR | Defines the color to use for the cell that currently has focus within the edit table. |
| FOCUSCELLFONT | Defines the font to use for the cell that currently has focus within the edit table. |
| FOCUSRECTCOLOR | Defines the color of the rectangle drawn around the cell with focus. |
| FOCUSRECTSTYLE | Defines how the focus rectangle is drawn around the cell with focus. |
| FOCUSRECTWEIGHT | Defines the thickness of the rectangle drawn around the cell with focus. |
| FONT | Sets or returns the font and its characteristics that are assigned to the control. |
| FontStructure | FontStructure attributes for the FONT property are as follows. |
| FORECOLOR | Returns or sets the foreground color of the specified control. |
| GOTFOCUS_CONTROL | Identifies the last control on the window that had an event handler defined for the GOTFOCUS event. |
| GOTFOCUS_VALUE | When a control gets focus, the value of that control's TEXT property is saved in GOTFOCUS_VALUE. |
| GRADIENTSTYLE | Sets and retrieves the gradient style of the background color of a window. |
| HANDLE | Windows handle for the object. |
| HEADERHEIGHT | Set or retrieve the height of the header row in an edit table control. |
| HELPTEXT | For controls, gets or sets text to be displayed as balloon help. |
| HOLD_EVENTS | Holds Windows messages in the Presentation Server's queue until OpenEngine completes the current event processing. |
| HPOSITION | Returns or sets position of slide in a horizontal scroll bar. |
| ICON | This property sets or returns the path to an icon file (.ICO). |
| ID | Retrieves the current primary key associated with the form. |
| IDLEPROC | Value is an @FM-delimited array: |
| IMAGE | Set_Property() sets the bitmap control to display the raw image, as actually read from an image file. |
| IMAGECLIP | Set to true to clip the image (only show as much of the image as fits into the control) or false to resize the image to the size of the control. |
| IMAGECOUNT | Specifies the number of images in a bitmap. |
| IMAGENUMBER | Specifies the image to display for a multi-image bitmap. |
| IMAGEOFFSET | For clipped bitmaps, this property specifies the location within the image (not within the control) to draw from. |
| IMAGEORIGIN | For clipped bitmaps, this property specifies the location within the control (not the image) to treat as the origin. |
| INVALUE | Sets or retrieves DEFPROP property of the control in internal format. |
| ITEMSTYLE | Sets or retrieves a menu style, which is a combination (BitOr) of any number of the following values: |
| IOOPTIONS | Sets/Gets the file I/O options for the window. |
| LABEL | Text used as a heading for columns in an edit table control. |
| LIMIT | Returns count of items in a control. |
| LIST_EX | Returns or sets what the list would be if fully expanded. |
| LIST | Returns or sets the items that appear in the list box or drop-down list box. |
| MAXIMIZESIZE | The MAXIMIZESIZE sets and retrieves the maximum size coordinates for a window. |
| MDIACTIVE | Set_Property activates the specified MDI child window. |
| MDIFRAME | Returns the name of the MDI frame for an MDI child window, or null if the specified window is not an MDI frame or child. |
| MISC | Returns or sends a string of user-defined data. |
| MODAL | Allows you to disable all existing (at the time the property is set) windows, or all windows that belong to the OpenInsight application. |
| MODIFIED | Checks, sets, or resets the Boolean Modified flag, for combo and edit boxes, and for an edit line. |
| MV | Returns true, if the specified control is associated with a multi-value table column. |
| NEXT | With Get_Property(), returns the next object in the tab order. |
| NOACCELTRANSLATION | A boolean property that will stop the passing of an OLE control's keystroke processing to the OpenInsight Presentation Server. |
| NOTIFYPOS | Returns the position where the last action occurred. |
| ODDROWCOLOR | Set and retrieve the RGB color of odd numbered rows within an edit table. |
| ORIG_SIZE | Returns the original size and position of the specified control. |
| ORIG_STRUCT | Used only with Get_Property(), returns the structure with initial values of the control. |
| ORIG_XXX | You can use the ORIG_XXX properties to reset control properties to their original values. |
| PAGELIST | Determines whether a particular control should be displayed on all pages of a multi-page form, or the current page only. |
| PARENT | Returns the parent (or owner) name of the specified control. |
| PART | If the control is linked to a key field which is a multi-part key, returns which part of the key this control is linked to. |
| POPUP_LIMIT | Returns the number of menu items in a menu popup that the specified item belongs to. |
| POPUP | Name of menu popup item the specified menu item belongs to. |
| POS | Returns the position of the column, relative to the data table structure, associated with the specified control. |
| POSITION | Returns the position (starting with 1) of a menu item in a menu popup the item belongs to. |
| PREVFOCUS | Returns the last control that had focus. |
| PREVIOUS | With Get_Property, returns the previous object in the controls tabbing order for the window. |
| PREVSELPOS | Returns the previously selected cell in an edit table. |
| PSSTYLE | A Get_Property only property that returns the current Presentation Server style for a control. |
| QBFLIST | Sets or returns the browse list of Native Table keys for QBF (Query By Form). |
| QBFPOS | Returns the absolute position of the current Native Tables record in a QBF (Query By Form) list. |
| QBFSTATUS | Used only with Get_Property, determines whether or not QBF (Query By Form) is active. |
| QUERYEND | Get_Property returns a Boolean value that indicates whether the Windows message WM_QUERYENDSESSION is being processed by OpenInsight. |
| RECEIVER | Get_Property() returns an object that was set as receiver of messages sent through the OpenEngine C interface. |
| RECORD | When set, allows you to override the default @RECORD associated with the current window. |
| REDRAW | When set to false, prevents the display of visual changes in a particular window until re-set to true. |
| REPOS_TYPE | Returns the repository type classification for the specified window. |
| REQUIRED | When true, requires control to contain data. Used primarily with database linked controls. |
| ROWDATA | Fills or retrieves the current row of the edit table as an @FM-delimited array of cells. |
| ROWLIMIT | Set and retrieve number of allowable rows within an edit table. |
| ROWSHADE | A boolean property that will paint alternating edit table rows in different colors. |
| RTFTEXT | Set and retrieve RTF text from an edit box which has the Rich Editor property set. |
| SAVEWARN | Set to true by the system when changes are made to data in bound controls. |
| SELECTION | With Get_Property, returns the starting position and length of selected text in the control. |
| SELPOS_EX | Returns the expanded position of the selected item in a (hierarchical) list box. |
| SELPOS | Returns or sets the position (starting with 1) of the selected position in an edit table or list box. |
| SERVERNAME | Returns the OpenEngine ServerName used by OpenInsight. |
| SIZE | Returns or sets the size and position of the specified control. |
| SORTEDCOL | Allows you to sort the contents of an edit table by a specified column. |
| STATUSLINE | Sets or retrieves the name of the control that displays help text for menu items and bitmapped buttons. |
| STYLE(STYLE_EX) | Sets or retrieves the Windows SDK style (long integer) for a control. |
| TABLE | Returns the name of the table linked with the specified control. |
| TABOUTEXCEED | When set to true, and size limit for a control's text value is reached, automatically tabs to the next control. |
| TABSTOPS | Returns or sets the number of pixels, from the origin, between tab stops in a control. |
| TEXT | Returns or sets text values which appear in the control. |
| TEXTVAL | Same as TEXT property, but converts @TM,@SVM,@VM to <CR>/<LF> for Set_Property, and <CR>/<LF> to @TM for Get_Property. |
| THEMED | Determines if the desktop is using themes. |
| TIMER | Starts or stops the timed generation of TIMER events for a window. |
| TOPPOS | Indicates the position of the top-most visible item in a list box, or the top and left-most visible cell in an edit table. |
| TRACKINGSIZE | The TRACKINGSIZE sets and retrieves the minimum and maximum size coordinates for a window. |
| TYPE | Returns the formal control type name for the specified control. |
| UDPLIST | This property provides a method of obtaining a list of user-defined properties for a control. |
| UTF8 | Setting the SYSTEM UTF8 property will ensure that UTF8 processing is enforced within an application. |
| VALID | Returns the input validation specification for the named control, or null if none is specified. |
| VALUE | Returns or sets the value of a selected radio button or tab within a tab control. |
| VALUES | Returns or sets the values within a tab control. |
| VERSION | Returns Windows version :@FM:OpenInsight version. |
| VISIBLE | Returns or sets visibility status of specified control. |
| VPOSITION | Returns or sets position of slide in a vertical scroll bar. |
| XLIST | Returns or sets the items that appear in the list box or drop-down list box. |
| System_Object | The SYSTEM object code is contained in a file called PMProp2.cpp in the PM_SysProperty function.. |
