skip to main content
OpenEdge Development: ADM Reference
Visual Objects and Their Methods and Properties : Visual object properties
 
Visual object properties
Visual Object properties provide information about visual objects and their classes. This information can include whether an object is enabled, the contents of the object and so on. You can read property values and in many instances you can change property values. To read a value for a property, you use a get function, and to change a value for a property, you use a set function.
These functions conform to the following conventions:
*get — Uses the form getpropname and returns the current value of the property.
Note: This function accepts no arguments.
*set — Uses the form setpropname. The set function accepts a single argument—the new value for the property—and returns TRUE/FALSE depending on whether the value change succeeds.
For more information about getting and setting property values, see Chapter 1, “ADM2 SmartObject API Reference.”
ActionEvent
This property returns the event to publish on defaultAction of the browse. When setting this, you define the persistent trigger that runs defaultAction and also subscribes the source-procedure.
Data type: CHARACTER
Note: Read and Write
AllFieldHandles
This property is defined for all visual objects and returns a list of handles for all widgets in the SmartObject’s frame.
Data type: CHARACTER
Note: Read and Write
AllFieldNames
This property is defined for all visual objects and returns a list of all widgets in the SmartObject’s frame. This list of widgets includes data fields that come back as part of the DisplayFields list and other objects such as buttons and fields that are not derived from an SDO, including rectangles and fields labels that are separate widgets with their own handles.
Data type: CHARACTER
Notes:  
*Read and Write.
*For SmartDataFields, the logical name of the dynamic Lookup or Combo is returned in the AllFieldNames list along with its procedure handle in the AllFieldHandles list.
ApplyActionOnExit
Currently used by SmartSelect, this property indicates whether or not exit is to perform the same action as the DEFAULT-ACTION. Set to TRUE if exit is to perform the same action. Currently used by SmartSelect.
Data type: LOGICAL
Note: Read and Write
ApplyExitOnAction
Currently used by SmartSelect, this property indicates whether or not the DEFAULT-ACTION is to exit the browse. Set to TRUE if DEFAULT-ACTION is to exit the browse.
Data type: LOGICAL
Note: Read and Write
AutoSort
Indicates whether the root node should be auto-sorted.
Data type: LOGICAL
Note: Read and Write
BrowseHandle
Handle of the browse control.
Data type: HANDLE
Note: Read only
CalcWidth
Logical value that determines whether the width of the browse is calculated to the exact amount needed for the fields it contains.
Data type: LOGICAL
Note: Read and Write
CanUndoChanges
Determines whether there is something to undo, either screen changes or saved changes. It also returns true if UndoNew is true and NewRecord is 'add' or 'copy'.
Data type: LOGICAL
Note: Read only
ClientRect
Returns the client rectangle for the TreeView.
Data type:  
Note: Read only
Col
Column of the object.
Data type: DECIMAL
Note: Read only
color3DFace
Property that can be used to set BGCOLOR or FGCOLOR on any three-dimensional face widget.
Data type: Integer
Note: Read only
color3DHighLight
Property that can be used to set BGCOLOR or FGCOLOR on any three-dimensional highlight widget.
Data type: INTEGER
Note: Read only
color3DShadow
Property that can be used to set BGCOLOR or FGCOLOR on any three-dimensional shadow widget.
Data type: INTEGER
Note: Read only
ColumnsMovable
This property determines whether the browser's columns are movable. If the browser has been initialized and its handle is valid, COLUMN-MOVABLE is set.
Data type: LOGICAL
Note: Read and Write
ColumnsSortable
This property determines whether the browser's columns are movable. If the browse object has been initialized and its handle is valid, ALLOW-COLUMN-SEARCHING is set to turn on or off the START-SEARCH trigger which is used to sort the columns.
Data type: LOGICAL
Note: Read and Write
CreateHandles
Comma-separated list of the handles, in character form, of the fields in the data visualization object that should be enabled for an Add or Copy operation.
Data type: CHARACTER
Note: Read only
CtrlFrameHandle
Handle of the TreeView’s control frame.
Data type: HANDLE
Note: Read only
DataModified
Indicates whether the current SCREEN-VALUES have been modified but not saved.
Data type: LOGICAL
Notes:  
*Read and Write.
*When DataModified is set to TRUE, the check occurs before any other code is executed.
*Disables searching while there is an update in progress in the SmartDataBrowser. SmartDataBrowser version of setDataModified.
DataObject
Filter used at design time for data objects.
Data type: CHARACTER
Note: Read and Write
DataObjectHandle
This property returns the handle of the actual data object, rather than the SBO. This property is used where the browser needs to access the actual data object but the datasource is an SBO.
Data type: HANDLE
Note: Read only
DataSignature
A character string that lists the integers corresponding to the data types of the fields in an object temp-table. This string is used to compare objects for equivalence as follows:
*1 = CHARACTER
*2 = DATE
*3 = LOGICAL
*4 = INTEGER
*5 = DECIMAL
*6 = Reserved for FLOAT OR DOUBLE in the future
*7 = RECID
*8 = RAW
*9 = Reserved for IMAGE in the future
*10 = HANDLE
*13 = ROWID
Data type: CHARACTER
Note: Read only
DefaultCharWidth
Default width of character fields.
Data type: CHARACTER
Note: Read and Write
DefaultEditorLines
Default number of inner lines for editors.
Data type: DECIMAL
Note: Read and Write
DefaultLayout
The default layout for the object.
Data type: CHARACTER
Note: Read only
DefaultWidth
Default width for non-character fields.
Data type: DECIMAL
Note: Read and Write
DisableOnInit
Indicates whether the current object should be left disabled when it is first initialized.
Data type: LOGICAL
Note: Read and Write
DisplayedField
Name of the field to display in the selection. This property can be used in signature matching.
Data type: CHARACTER
Note: Read and Write
DisplayFieldsSecurity
Comma-separated list of security types corresponding to AllFieldHandles.
Data type: CHARACTER
Note: Read and Write
DisplayedTables
List of SDO table names used by the visualization. Can be only RowObject. If the object was built against an SBO, it is the list of SDO ObjectNames whose fields are used.
Data type: CHARACTER
Note: Read only
Down
Down attribute for the browse. Called from initializeObject for dynamic SmartDataBrowsers.
Data type: INTEGER
Note: Write only
Editable
Indicates whether this object can be edited (add/copy/save/update).
Data type: LOGICAL
Note: Read and Write
EnabledObjFlds
List of the field names of widgets enabled in this object not associated with data fields.
Data type: CHARACTER
Note: Read only
EnabledObjFldsToDisable
Property that controls whether or not to disable non-database objects when the data fields are disabled. You can enter one of the following:
*None — Non-database objects remain enabled when the fields are disabled.
*Al l — Non-database objects are disabled in view mode.
*Comma separated list — A comma-separated list of non-database object names that you want disabled in view mode.
Data type: CHARACTER
Notes:  
*Read and Write.
*The property only applies to non-database objects that have been defined as enabled in the master. See the “EnabledObjFlds” section for more information about enabling.
*You can edit this property using the viewer's Instance Property dialog box.
EnabledObjHdls
List of the handles of widgets enabled in this object and not associated with data fields.
Data type: CHARACTER
Note: Read only
EnabledFields
A comma-separated list of the names of enabled fields in this object that map to fields in the SmartDataObject (&ENABLED-FIELDS).
Data type: CHARACTER
Notes:  
*Read and Write.
*When EnabledFields is set to FALSE, the check occurs before other code is executed.
EnabledHandles
A comma-separated list of the handles, in character format, of the enabled fields in the visualization object.
Data type: CHARACTER
Note: Read and Write
ExpandOnAdd
Use this property along with the TreeView property to automatically expand a node that has been newly added to a TreeView.
Data type: LOGICAL
Note: Read and Write
FetchOnReposToEnd
This property returns TRUE if the browse should fetch more data from the server to fill the batch when repositioing to the end of a batch.
Data type: LOGICAL
Notes:  
*Read and Write
*Using this setting gives the correct visual appearance, but requires an additional request to the server.
FieldColumn
Column number of the left most field.
Data type: DECIMAL
Note: Read and Write
FieldFormats
Internal override of formats for fields.
Data type: CHARACTER
Note: Read and Write
FieldHandles
A comma-separated list of the handles, in character format, of the Data Fields in the visualization object.
Data type: CHARACTER
Note: Read and Write
FieldHelpIds
Internal list of properties for the fields. Each element consists of a name and a value, separated by CHR(1).
Data type: CHARACTER
Note: Read and Write
FieldsEnabled
Indicates whether the fields in this visualization object are enabled.
Data type: LOGICAL
Note: Read only
FieldLabels
Internal list of properties for the fields. Each element consists of a name and a value, separated by CHR(1).
Data type: CHARACTER
Note: Read and Write
FieldOperatorStyles
Internal list of properties for the fields. Each element consists of a name and a value, separated by aCHR(1).
Data type: CHARACTER
Note: Read and Write
FieldToolTips
Internal list of properties for the fields. Each element consists of a name and a value, separated by a CHR(1).
Data type: CHARACTER
Note: Read and Write
FieldWidths
Internal list of properties for the fields. Each element consists of a name and a value, separated by a CHR(1).
Data type: CHARACTER
Note: Read and Write
FilterActive
Values of FilterActive and QueryColumns. TRUE if a filter is active and QueryColumns is not the empty string and TRUE if the DataSource has a logical filter.
Data type: LOGICAL
Notes:  
*Read only.
*It might be set to TRUE explicitly or use the Querycolumns.
FilterTarget
Handle for a data object, in character format or the name of the linked filter object. Currently supports only one.
Data type: CHARACTER
Note: Read and Write
FilterTargetEvents
Comma-separated list of the events to which this object wants to subscribe to in its FilterTarget.
Data type: CHARACTER
Note: Read and Write
FolderWindowToLaunch
Property that contains the name of a logical object (usually a folder window) to launch when a user selects a maintenance option on an object controller (usually a container and a browser with a toolbar). Use this property to launch an object that allows the user to maintain details for records.
Data type: CHARACTER
Note: Read only
FrameMinHeightChars
Predetermined character height of a frame.
Data type: DECIMAL
Note: Read and Write
FrameMinWidthChars
Predetermined character width of a frame.
Data type: DECIMAL
Note: Read and Write
FullRowSelect
The FullRowSelect property of the tree. If TRUE, the entire node (text and icon) is highlighted.
Data type: LOGICAL
Note: Read and Write
GroupAssignHidden
Property used to verify whether the object is hidden and if it can remain hidden.
Data type: Logical
Notes:  
*Read only.
*This property is used by the linkState procedure in the data.p file to verify that the link can be deactivated and how to republish the message.
*Returns FALSE as soon as any visible object is found.
*This property is also used to verify whether all GroupAssignTargets are hidden and if they should remain hidden.
GroupAssignSource
Handle of the object’s GroupAssign source.
Data type: HANDLE
Note: Read and Write
GroupAssignSourceEvents
Comma-separated list of the events this object wants to subscribe to in its GroupAssign source.
Data type: CHARACTER
Note: Read and Write
GroupAssignTarget
Handle, in character format, of the object’s GroupAssign target.
Data type: CHARACTER
Note: Read and Write
GroupAssignTargetEvents
Comma-separated list of the events this object wants to subscribe to in its GroupAssign target.
Data type: CHARACTER
Note: Read and Write
Height
Height of the object.
Data type: DECIMAL
Note: Read only
HideOnInit
Indicates whether the current object should be left hidden when it is first initialized.
Data type: LOGICAL
Note: Read and Write
HideSelection
Indicates whether the Tree View remains highlighted. If TRUE, the current node in the TreeView does not remain highlighted when focus leaves the Tree View.
Data type: LOGICAL
Note: Read and Write
ImageHeight
Height of images in the image list associated with the TreeView.
Data type: INTEGER
Note: Read and Write
ImageWidth
Width of images in the image list associated with the TreeView.
Data type: INTEGER
Note: Read and Write
ILComHandle
The com-handle of the ImageList ActiveX object.
Data type: HANDLE
Note: Read only
Indentation
Number of pixels of indentation between two generations of nodes.
Data type: INTEGER
Note: Read and Write
LabelEdit
Indicates whether a user can edit a node. If TRUE, the user can click on the node to edit it.
Data type: INTEGER
Note: Read and Write
LayoutOptions
List of multi-layout options for the object.
Data type: CHARACTER
Note: Read and Write
LayoutVariable
Name of the &LAYOUT-VARIABLE preprocessor for the object, which is used as a prefix to the name of the procedure that resets it.
Data type: CHARACTER
Note: Read only
LineStyle
Determines the line style for a tree. This property has the following options:
*0 (Default) — Displays lines between child nodes and their parent.
*1 — Displays lines between root nodes and lines between child and parent nodes.
Data type: INTEGER
Note: Read and Write
MaxWidth
Maximum width of the browse when CalcWidth is TRUE.
Data type: DECIMAL
Note: Read and Write
MinHeight
Determines the minimum height.
Data type: DECIMAL
Note: Read and Write
MinWidth
Determines the minimum width.
Data type: DECIMAL
Note: Read and Write
ModifyFields
Property that determines which fields should set DataModified to TRUE in their containing viewer when fields are modified. For data-source fields, this property also controls the fields from which values are collected for passing to the data source and update target.
Valid values for this property are:
*All — All EnabledObjects should set DataModified
*None — No EnabledObjects should set DataModified
*EnabledFields — Only Fields from the data source should set DataModified
*Updatable — Only EnabledFields that can be updated in the data source should set DataModified
*Comma separated list — List of object names that can set DataModified when changed
Data type: CHARACTER
Notes:  
*Read and Write.
*Setting DataModified to TRUE in the viewer enables Save and Reset in the TableioSource toolbar.
*DataFields that do not set DataModified using one of these values are not passed to the update target on save. However, the data source value is displayed again on save.
*ModifyFields is used to determine which field values are collected by the collectChanges procedure. For more information, see the “collectChanges” section.
*You can edit this property using the viewer's Instance Property dialog box.
NextNodeKey
Unique code to be used for the Key attribute of the Tree view.
Data type: CHARACTER
Notes:  
*Read only.
*You cannot begin a key for a node with a number in Microsoft TreeView. Therefore, the prefix xcNodePrefix is used.
*The key is used as the sort field when adding nodes. Therefore, the string “999999999999” is used to guarantee a valid sort order.
NodeExpanded
Expands or collapse a node based on the argument passed.
Data type: LOGICAL
Note: Write only
NumDown
Number of rows that are displayed DOWN in the browse.
Data type: INTEGER
Note: Read and Write
ObjectEnabled
Indicate whether the current object is enabled.
Data type: LOGICAL
Note: Read only
ObjectLayout
Current layout name for the object.
Data type: CHARACTER
Note: Read and Write
OLEDrag
Determines whether OLEDrag is supported. If TRUE, drag is supported.
Data type: LOGICAL
Note: Read and Write
OLEDrop
Determines whether OLEDrop is supported. If TRUE, drop is supported.
Data type: LOGICAL
Note: Read and Write
Operator
The Operator, the default when OperatorStyle is Implicit.
Data type: CHARACTER
Note: Read and Write
OperatorLongValues
List of operators and long text.
Data type: CHARACTER
Note: Read and Write
OperatorStyle
The style for the operator. The following lists the valid values for operator:
*Explicit — Specify operator in a separate widget.
*Implicit — Use the Operator and UseBegins property.
*Range — Use two fill-ins and specify GE and LE values.
*Inline — Type the operator into the field (defaults to Equals, or BEGINS if UseBegins is TRUE).
Data type: CHARACTER
Note: Read and Write
OperatorViewAs
View-as type used to define the operator when OperatorStyle equals Explicit.
Data type: CHARACTER
Note: Read and Write
Property
Properties for the specified node. These can include the following properties:
*BACKCOLOR — The background color of the node.
*BOLD — Whether the node is bold.
*CHECKED — Whether the node is checked.
*CHILD — The first child node.
*CHILDREN — The number of children of the node.
*COUNT — The number of nodes in the tree.
*EXPANDED — Whether the node is expanded or collapsed.
*FIRSTSIBLING — The first sibling of the node.
*FORECOLOR — The foreground color of the note.
*FULLPATH — The full path of the node.
*GETVISIBLECOUNT — The number of visible nodes.
*IMAGE — The image (contained in imagelist) for the node.
*INDEX — The index of the node.
*KEY — The unique key of the node.
*LASTSIBLING — The last sibling of the node.
*PARENT — The parent of the node.
*NEXT — The next node key.
*PATHSEPARATOR — The delimiter returned by the FullPath property.
*PREVIOUS — The previous node key.
*ROOT — The root of the node.
*SELECTEDITEM — The selected node.
*SORTED — Whether the children of the node are sorted.
*TAG — The tag of the specified node.
*TEXT — The label text of the specified node.
*VISIBLE — Whether the entire tree is visible/invisible.
Data type: CHARACTER
Note: Read and Write
QueryRowObject
Handle of the RowObject temp-table associated with the Browse’s query.
Data type: HANDLE
Note: Read and Write
RecordState
String indicating whether a record is available or not. Valid values are RecordAvailable and NoRecordAvailable.
Data type: CHARACTER
Note: Read only
RefreshTree
Refreshes the tree view.
Data type: LOGICAL
Note: Write only
ResizeHorizontal
Indicates whether an object can be resized horizontally. The value for this property is TRUE if the object can be resized horizontally (in X).
Data type: LOGICAL
Note: Read and Write
ResizeVertical
Indicates whether an object can be resized vertically. The value for this property is TRUE if the object can be resized vertically (in Y).
Data type: LOGICAL
Note: Read and Write
RootNodeParentKey
Parent key for root nodes on the tree. You can use the parent key to find all root nodes that has this parent.
Data type: CHARACTER
Note: Read only
Row
Height of the object. Use repositionObject to set the Row.
Data type: DECIMAL
Note: Read only
RowIdent
The ROWID, in character format, of the current row of the visualization. If the update-target is an SmartDataObject (SDO), the database ROWIDs can be stored as the second entry of the list. If connected to a SmartBusinessObject (SBO), the value is a semicolon-separated list corresponding to the SBO’s DataObjectNames list. If the SBO is a valid UpdateTarget, then the ROWIDs are for the UpdateTargetNames; otherwise the DataSourceNames.
Data type: CHARACTER
Notes:  
*Read and Write.
*Returns only the ROWIDs that uniquely identify this object’s connection to the dataSource/updateTarget and remove unnecessary ROWIDs so the property can be used directly as input to update methods in the SBO. The assumption is that all tables that are displayed only in the visual object are on the one side of a one-to-many or many-to-one relation of the table that is updated, so that they are uniquely identified through the updatable table and their ROWIDs are not part of this object Ident. However, return more than one ROWID is returned for the case where more than one SDO is updated as one-to-one in the SBO.
RowUpdated
Returns TRUE if the current record has been saved, but not comitted. The value is supposed to reflect the visual object's status, so it uses the UpdateTarget (not the DataSource) in order to only return TRUE if the object did the change and/or can undo/save the change.
Data type: LOGICAL
Note: Read only
RowObject
Handle of the RowObject temp-table buffer or the Browser’s temp-table definition.
Data type: HANDLE
Note: Read only
SaveSource
Indicates whether the TableIO-Source is set to Save or Update. This value is TRUE if the TableIO-Source is set to Save and FALSE if set to Update (modal).
Data type: LOGICAL
Note: Read and Write
Scroll
Scroll property of the tree. If TRUE, scrollbars appear.
Data type: LOGICAL
Note: Read and Write
ScrollRemote
Value of ScrollRemote.
Data type: LOGICAL
Note: Read and Write
SearchField
Name of a field where searching is enabled. If set, space is allocated for a fill-in to accept a value to be repositioned to.
Data type: CHARACTER
Note: Read and Write
SelectedNode
Key of the selected node.
Data type: CHARACTER
Note: Read only
ShowCheckBoxes
Indicates whether a check box appears next to a node. If TRUE, check boxes appear beside each node on the TreeView.
Data type: LOGICAL
Note: Read and Write
ShowRootLines
Indicates whether there should be lines to the root of the tree. If TRUE, there should be lines leading to the roots of the tree.
Data type: LOGICAL
Note: Read and Write
SingleSel
Controls whether a node is expanded when selected. If TRUE, the node is expanded when selected or clicked.
Data type: LOGICAL
Note: Read and Write
Sort
Identifies whether a selection should be sorted. If TRUE, the selection is to be sorted.
Data type: LOGICAL
Note: Read only
TableIOSource
Identifies the source for the input and output Table.
Data type: HANDLE
Note: Read and Write
TableIOSourceEvents
Comma-separated list of the events to which this object wants to subscribe to in its TableIO source.
Data type: CHARACTER
Note: Read and Write
ToggleDataTargets
Property used to control whether or not dataTargets should be set to on or off in linkState. This value changes based on what is passed with the active or inactive parameter.
Data type: Logical
Notes:  
*Read and Write.
*If TRUE, dataTargets should be set to on or off in linkState depending on what is passed with the active or inactive parameter.
*If FALSE, dataTargets should not be set to on or off in linkState depending on what is passed with the active or inactive parameter.
ToolbarSource
Handle or list of handles.
Data type: CHARACTER
Note: Read and Write
ToolbarSourceEvents
List of events to be subscribed to in the Toolbar-Source.
Data type: CHARACTER
Note: Read and Write
ToolTip
Property containing the ToolTip for the browser.
Data type: CHARACTER
Notes:  
*Read and Write.
*This property is supported in both Progress Dynamics and Non-Progress Dynamics environments.
TreeDataTable
Handle of a dynamic temp-table populated with property fields for a TreeView.
Data type: HANDLE
Note: Read only
TreeStyle
Use this property with the TreeView property to specify the appearance for a TreeView. You can specify the following to define the appearance of a Tree View:
*0 — Text only.
*1 — Image and text.
*2 — Plus and minus with text.
*3 — Plus and minus with image and text.
*4 — Lines and text.
*5 — Lines, image, and text.
*6 — Lines, plus and minus, with text.
*7 — (Default) Lines, plus and minus with image and text.
Data type: INTEGER
Note: Read and Write
TVControllerSource
Handle of the procedure controlling this TreeView.
Data type: HANDLE
Note: Read and Write
TVControllerTarget
Usually, the handle of the TreeView being controlled.
Data type: HANDLE
Note: Read and Write
TVControllerTargetEvents
List of target events to which this controller wants to subscribe.
Data type: CHARACTER
Note: Read only
UndoChangeCaption
Returns the appropriate text for the Undo button’s tooltip. The tooltip changes to indicate what is undone by each click of the button.
Data type: CHARACTER
Note: Read only
UndoNew
Returns true if UndoChange can undo unsaved records created by an Add or Copy. If false, cancelRecord must be called directly.
Data type: LOGICAL
Note: Read and Write
UpdateTarget
Used for pass-through links, to connect an object inside the container with an object outside the container.
Data type: CHARACTER
Note: Read and Write
UpdateTargetNames
ObjectName of the Data Object to be updated by this visual object. This is set if the Update-Target is an SBO or other Container with DataObjects.
Data type: CHARACTER
Note: Read and Write
UseBegins
Value of UseBegins. This value is TRUE when BEGINS is supposed to be used for character tests.
Data type: LOGICAL
Note: Read and Write
UseContains
Property used to determine when to use Contains. If TRUE, then Contains should be used as operator for character values.
Data type: LOGICAL
Note: None
UseSortIndicator
Indicates whether the browser uses a graphical arrow in the column label to show sort column and sort direction. The default is TRUE, which displays the arrow.
Data type: LOGICAL
Note: Read and Write
ValidKey
Indicates whether there is a valid key. If TRUE, there is a valid key.
Data type: LOGICAL
Note: Read only
VisualBlank
Used to visualize searching for BLANK values.
Data type: CHARACTER
Note: Read and Write
Width
Width of the object.
Data type: DECIMAL
Note: Read only
WindowTitleField
This property usually contains the name of a field that you want to concatenate to the window title of a container. You can use this property to indicate what record is being maintained.
For example, if you have an object controller for Products, and you launch a folder window and you want the product code to appear in the title, you would assign the value gsc_product.product_code to this property. As a result, when the folder window launches, the product code of the product being maintained is concatenated to the window title.
Data type: CHARACTER
Note: Read and Write