3. System Classes : ButtonField Class : TreeviewField Class
 
Share this page                  
TreeviewField Class
TreeviewField Attributes
Attribute
Data Type
Description
Inherited
From
AbsXLeft
integer
Specifies a field's starting X coordinate, including the border and shadow, relative to the form (RW)
FormField
AbsXRight
integer
Specifies a field's ending X coordinate, including the border and shadow, relative to the form (RW)
FormField
AbsYBottom
integer
Specifies a field's ending Y coordinate, including the border and shadow, relative to the form (RW)
FormField
AbsYTop
integer
Specifies a field's starting Y coordinate, including the border and shadow, relative to the form (RW)
FormField
AllBias
smallint
Specifies a field's bias setting for all modes of a frame (W)
FormField
AllowLabelEdit
integer
Deprecated. Used only if the Style of the TreeviewField is TVF_CLASSIC. For more information, see the Language Reference Guide. (RW)
Defined
AnchorPoint
integer
Specifies one of nine predetermined anchor points for a field (RW)
FormField
BgBitmap
BitmapObject
Specifies the background setting for a field when BgPattern is FP_BITMAP (RW)
FormField
BgColor
integer
Specifies the background color of a field's bounding box (RW)
FieldObject
BgDisplayPolicy
integer
Controls the positioning and display of form field background images—either anchored to their own top left corner (fixed), or anchored relative to the closest parent field whose background is fixed (RW)
FormField
BgPattern
integer
Specifies the form's background pattern (RW)
FormField
BitmapLabel
BitmapObject
Specifies an image used for the button label (RW)
Defined
BmpDisplayBehavior
integer
Determines how a bitmap appears when placed on top of certain ButtonField, ImageField, PaletteField, or TreeviewField objects, when the system color scheme changes, or a combination of both (RW)
Defined
ButtonStyle
integer
Affects both the appearance and the behavior of a ButtonField (RW)
Defined
ClassName
varchar(32)
Gives the name of an object's actual type (as opposed to its declared type) (R)
Object
ClientData
Object
Provides a way to associate data with an object (RW)
Object
ClientText
varchar(2000)
Stores text values; allows information to be assigned to a field at runtime (RW)
FieldObject
ControlField
smallint
Determines if a field manipulates the user interface instead of the underlying data (RW)
FieldObject
CurBias
smallint
Specifies the current bias setting for a field (RW)
FormField
CurNode
TreeNode
Specifies the node currently selected (RW)
Defined
Cursor
CursorBitmap
Causes the mouse cursor to change to the cursor associated with the CursorBitmap when the pointer is over the FormField object (RW)
FormField
DataType
varchar(65)
Specifies the data type of the field's variable (RW1)
FieldObject
Declared
smallint
Controls whether OpenROAD declares a variable for the field at compile time (RW)
ActiveField
DefaultString
varchar(256)
Stores the default value that OpenROAD uses when the DefaultValue attribute is set to DV_STRING (RW1)
FieldObject
DefaultValue
smallint
Specifies the default value of the variable associated with the field (RW1)
FieldObject
DragCopyCursor
CursorBitmap
When assigned to a CursorBitmap object,causes the mouse cursor to change to the cursor associated with the CursorBitmap when a DragDrop operation is made to be a copy operation by pressing the CTRL key while dragging from the TreeNode object
Defined
DragMoveCursor
CursorBitmap
When assigned to a CursorBitmap object, causes the mouse cursor to change to the cursor associated with the CursorBitmap when a DragDrop operation is begun from the TreeNode object
Defined
DragObject
Object
Sets the object that will be transferred by a drag-and-drop operation when a user starts the operation over the field (RW)
ActiveField
DropObject
varchar(32)
Holds the class name of the objects that can be dropped on the field (RW)
ActiveField
ExactNodeHeight
integer
If greater than 0, defines the exact height of each node (RW)
Defined
EventExec
FrameExec
Specifies the frame (FrameExec) to which this field's events will be queued and processed (RW)
FieldObject
FgColor
integer
Controls the color of the field's foreground (RW)
FieldObject
FocusBehavior
smallint
Controls behavior of the field relative to the input focus (RW)
ActiveField
FullName
varchar(256)
Contains the expanded name of variable (R)
FieldObject
FullRowSelect
integer
If FALSE, indicates that nodes can be selected only by clicking on the bitmap or text label of the node (RW)
Defined
Gravity
integer
Specifies the alignment of a field that is within a stack field cell, a matrix field cell, or a subform (RW)
FormField
HasButtons
integer
If set to TRUE, the TreeviewField has expansion buttons with [+] and [-] symbols to signify whether a node can be expanded or collapsed (RW)
Defined
HasCheckBoxes
integer
If set to TRUE, means that the TreeviewField will display check boxes
Defined
HasDataChanged
smallint
Indicates if any interactive changes were made to the data associated with the field (RW)
FieldObject
HasFieldChanged
smallint
Is TRUE if any structural attributes of a field have been changed since the frame was initialized (RW)
FormField
HasHorizontalScrollBar
integer
Is set to TRUE automatically when expansion of nodes causes some of the node labels to overflow the horizontal space allotted for the treeview (RW)
Defined
HasImageAndText
smallint
Specifies that the toggle field has both the custom image (for the indicator) and the text labels (RW)
Defined
HasIndicator
smallint
Specifies that the toggle field has the standard check box as the indicator (RW)
Defined
HasLines
integer
If set to TRUE, the TreeviewField has hierarchy outlines (RW)
Defined
HasRootLine
integer
If set to TRUE, there is a line at the root node level—but only if the HasLines attribute is also set to TRUE
Defined
HasScrollBar
integer
Is set to TRUE automatically when expansion of nodes causes some of the nodes to not be displayable in the vertical space allotted for the TreeviewField (RW)
Defined
Height
integer
Specifies the Y extent of the “inner rectangle” of the field, excluding borders and shadows (RW)
FormField
ImageList
array of BitmapObject
Contains label bitmaps that can be used to indicate the selected or unselected state of the nodes (R)
Defined
Indent
integer
Indicates how much indentation there will be between different levels of the tree. Only positive values are valid. (RW)
Defined
InstanceIdentifier
integer
Contains a value that uniquely identifies an instance of an allocated object (R)
Object
InstanceReferences
integer
Contains the current number of references to the object (R)
Object
IsAutoSized
integer
Forces the button to resize itself to fit current text label if TRUE (RW)
Defined
IsBold
smallint
Is TRUE for bold font (RW)
Defined
IsCurField
smallint
Is TRUE when a field has the current input focus for the frame (RW)
FormField
IsDragSource
integer
If set to TRUE, a drag-and-drop operation may be started over the field; DragObject is the object that is transferred (RW)
ActiveField
IsItalic
smallint
Is TRUE for italic font (RW)
Defined
IsNullable
smallint
Is TRUE if the variable is nullable (RW1)
FieldObject
IsPlain
smallint
Is TRUE if bold, underlining, and italics are off (RW)
Defined
IsPropOptInherited
integer
If set to TRUE, indicates that the field is to use or inherit the PropertyOptMenu of the CompositeField that is nearest in scope (RW)
ActiveField
IsReverse
smallint
Is TRUE if reverse is on for a field's background and foreground colors (RW)
FormField
IsSelected
smallint
Is TRUE if a field is selected (for fields with bias settings that are selectable); defaults to FALSE (RW)
FormField
IsUnderlined
integer
If TRUE, text is underlined (RW)
Defined
LayerSequence
integer
Specifies a field's sequence number within the field layer (RW)
FormField
MouseDownText
varchar(100)
Specifies the text displayed in the window status bar of the current frame when the mouse pointer is over the field and the select button is clicked (RW)
FormField
MouseMoveText
varchar(100)
Specifies the text displayed in the window status bar of the current frame when the mouse pointer is over the field (RW)
FormField
Name
varchar(32)
Contains the name of the field object (RW1)
FieldObject
NodeHeight
integer
Provides the actual height of each node (R)
Defined
OffBitmapLabel
BitmapObject
Specifies a bitmap image to display if the toggle field is set to off (0) (RW)
Defined
OffTextLabel
StringObject
Specifies the string to display if toggle is off (0) (RW)
Defined
OnBitmapLabel
BitmapObject
Specifies a bitmap image to display if the toggle field variable is set to on (1) (RW)
Defined
OnTextLabel
StringObject
Specifies the text value to display if the toggle is on (1) (RW)
Defined
OuterHeight
integer
Specifies the extent in Y direction of a field, including border lines and shadows (RW)
FormField
OuterWidth
integer
Specifies the extent in X direction of a field, including border lines and shadows (RW)
FormField
OutlineColor
integer
Controls the color of the border line or shadow of the bounding box around the field (RW)
ActiveField
OutlineStyle
integer
Controls the style of the outline of the field (RW)
ActiveField
OutlineWidth
integer
Controls the width of the border line or the shadow for the bounding box around the field (RW)
ActiveField
ParentField
CompositeField
Specifies the direct parent field for a field (RW)
FormField
PropertyOptMenu
OptionMenu
Contains the OptionMenu that is activated when the right mouse button is clicked while over the field (RW)
ActiveField
QueryBias
smallint
Specifies a field's bias setting when the CurMode attribute for the frame is set to FM_QUERY (RW)
FormField
ReadBias
smallint
Specifies the bias setting for a field when the CurMode attribute for the frame is set to FM_READ (RW)
FormField
RequireRealField
smallint
Indicates if a field must be associated with a toolkit control or widget (RW)
FormField
RightClickBehavior
integer
Indicates what the behavior will be when the user right-clicks the mouse on a node (or a non-node area of the treeview) (RW)
Defined
Script
StringObject
Contains the 4GL script associated with the field (RW)
FieldObject
SelBgColor
integer
Controls the background color of the bounding rectangle of the selected node in the TreeviewField (RW)
Defined
SelFgColor
integer
Controls the foreground color of the bounding rectangle of the selected node in the TreeviewField (RW)
Defined
SelIsBold
integer
If set to TRUE, then the selected node is made bold (RW)
Defined
SelNoFocusBgColor
integer
Controls the background color of the bounding rectangle of the selected node in the TreeviewField when the TreeviewField does not have the focus (RW)
Defined
SelNoFocusFgColor
integer
Controls the foreground color of the bounding rectangle of the selected node in the TreeviewField when the TreeviewField does not have the focus (RW)
Defined
ShowSelection
integer
If set to TRUE, the currently selected node is always highlighted (even when the TreeviewField loses focus) (RW)
Defined
Style
integer
Specifies the style of Treeviewfields: TVF_CLASSIC, TVF_EXTENDED, or TVF_CURRENT (RW)
Defined
TabSeqNum
integer
Set this attribute to the 1-relative number equal to the order in which you want this field to appear in the TabSequence for the containing CompositeField (RW)
ActiveField
TextAlignment
smallint
Specifies the alignment of the button's text label (RW)
ButtonField
TextDisplayBehavior
integer
Determines how the text label will appear when there is more text than will fit into the button (RW)
ButtonField
TextLabel
varchar(256)
Specifies a text title for the button (RW)
ButtonField
ToolTipText
varchar(100)
Specifies the text to be displayed when the mouse pointer rests on the FormField (RW)
FormField
TopNode
TreeNode
Specifies the topmost visible TreeNode in the treeview (RW)
Defined
Tree
Tree
Sepcifies the Tree object containing TreeNodes (RW)
Defined
TreeHeight
integer
Provides the total height of both the visible part of the TreeviewField and, if part of the TreeviewField is scrolled out of view, it also includes that height (R)
Defined
TreeWidth
integer
Provides the total width of both the visible part of the TreeviewField and, if part of the TreeviewField is scrolled out of view, it also includes that width (R)
Defined
TriggerNode
TreeNode
Specifies the node that was either collapsed, expanded, or has its label changed (R)
Defined
TypeFace
integer
Specifies the typeface for the text label (RW)
ButtonField
TypeFaceName
varchar(31)
Specifies the typeface name of any font installed on your system (RW)
ButtonField
TypeSize
smallint
Sets the size, in points, for the typeface (RW)
ButtonField
UpdateBias
smallint
Specifies a field's bias setting when the CurMode attribute for the frame is set to FM_UPDATE (RW)
FormField
User1Bias
smallint
Specifies a field's bias setting when the CurMode attribute for the frame is set to FM_USER1 (RW)
FormField
User2Bias
smallint
Specifies a field's bias setting when the CurMode attribute for the frame is set to FM_USER2 (RW)
FormField
User3Bias
smallint
Specifies a field's bias setting when the CurMode attribute for the frame is set to FM_USER3 (RW)
FormField
WidgetID
integer
This is not supported. Represents the field's handle for the highest-level Windows control for the field. (R)
ActiveField
Width
integer
Specifies the X extent of the “inner rectangle” of the field, excluding border lines or shadows (RW)
FormField
XAnchorPoint
integer
Use with YAnchorPoint to position an object by setting relevant anchor point values (RW)
FormField
XLeft
integer
Specifies the relative X coordinate of the left edge of a field's bounding rectangle (RW)
FormField
XRight
integer
Specifies the relative X coordinate of the right edge of a field's bounding rectangle (RW)
FormField
YAnchorPoint
integer
Use with XAnchorPoint to position an object by setting relevant anchor point values (RW)
FormField
YBottom
integer
Specifies the relative Y coordinate of the lower edge of a field's bounding rectangle (RW)
FormField
YTop
integer
Specifies the relative Y coordinate of the top edge of a field's bounding rectangle (RW)
FormField
 
TreeviewField Methods
Method
Return
Value
Description
Inherited From
CheckFailedMandatory
(
[setfocusonfailure = smallint])
ActiveField
Checks a mandatory field for entered values
ActiveField
DeclareData
(
[result = byref(variable)]
[,userclass =   byref(UserClassObject)])
integer
Declares a specified active field so that you can refer to it in a dynamic expression
ActiveField
Duplicate()
ToggleField
Makes a duplicate of the object, placing a reference to the new object in a reference variable
Object
EditLabel([node = TreeNode])
rc
Puts the specified node in edit mode. The TreeviewField's AllowLabelEdit attribute must be TRUE.
Defined
GetAttribute
(
attributename = byref(variable)
{,attributename = byref(variable)})
integer
Gets the values of any number of attributes for the object
Object
GetFieldValue
(value = byref(
variable))
integer
Gets the current value of a field
FieldObject
IsA
(class =
classname)
integer
Is TRUE if the object is of the same class as, or one of the subclasses of, the class specified by classname
Object
IsDescendantOf
(ancestor =
FieldObject)
smallint
Is TRUE if the field object is a descendant at any level of the specified ancestor
FieldObject
SetAttribute
(
attributename = value
{,attributename = value})
integer
Sets any number of attributes for the object
Object
SetFieldValue
(value =
value)
integer
Sets the value of a field
FieldObject
SetToDefault()
none
Sets the value of the field to its default value
ActiveField
UndeclareData()
integer
Dissociates the named active field from variables previously associated with the DeclareData method
ActiveField
UpdBackground()
none
Changes a field's background
FormField
UpdField
(
[clearhasdatachanged = integer])
none
Refreshes a displayed field
ActiveField
UpdValue()
integer
Loads the internal memory area that stores a field's value with the value contained with the visual representation of the value
FieldObject
WhichTableField()
TableField
Determines which table field contains the field that triggered this method
FieldObject