3. System Classes : ButtonField Class : FormField Class
 
Share this page                  
FormField Class
FormField 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)
Defined
AbsXRight
integer
Specifies a field's ending X coordinate, including the border and shadow, relative to the form (RW)
Defined
AbsYBottom
integer
Specifies a field's ending Y coordinate, including the border and shadow, relative to the form (RW)
Defined
AbsYTop
integer
Specifies a field's starting Y coordinate, including the border and shadow, relative to the form (RW)
Defined
AllBias
smallint
Specifies a field's bias setting for all modes of a frame (W)
Defined
AnchorPoint
integer
Specifies one of nine predetermined anchor points for a field (RW)
Defined
BgBitmap
BitmapObject
Specifies the background setting for a field when BgPattern is FP_BITMAP (RW)
Defined
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)
Defined
BgPattern
integer
Specifies the form's background pattern (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)
Defined
Cursor
CursorBitmap
Causes the mouse cursor to change to the cursor associated with the CursorBitmap when the mouse pointer is over the FormField object (RW)
Defined
DataType
varchar(65)
Specifies the data type of the field's variable (RW1)
FieldObject
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
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
FullName
varchar(256)
Contains the expanded name of variable (R)
FieldObject
Gravity
integer
Specifies the alignment of a field that is within a stack field cell, a matrix field cell, or a subform (RW)
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)
Defined
Height
integer
Specifies the Y extent of the “inner rectangle” of the field, excluding borders and shadows (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
IsCurField
smallint
Is TRUE when a field has the current input focus for the frame (RW)
Defined
IsNullable
smallint
Is TRUE if the variable is nullable (RW1)
FieldObject
IsReverse
smallint
Is TRUE if reverse is on for a field's background and foreground colors (RW)
Defined
IsSelected
smallint
Is TRUE if a field is selected (for fields with bias settings that are selectable); defaults to FALSE (RW)
Defined
LayerSequence
integer
Specifies a field's sequence number within the field layer (RW)
Defined
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)
Defined
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)
Defined
Name
varchar(32)
Contains the name of the field object (RW1)
FieldObject
OuterHeight
integer
Specifies the extent in Y direction of a field, including border lines and shadows (RW)
Defined
OuterWidth
integer
Specifies the extent in X direction of a field, including border lines and shadows (RW)
Defined
ParentField
CompositeField
Specifies the direct parent field for a field (RW)
Defined
QueryBias
smallint
Specifies a field's bias setting when the CurMode attribute for the frame is set to FM_QUERY (RW)
Defined
ReadBias
smallint
Specifies the bias setting for a field when the CurMode attribute for the frame is set to FM_READ (RW)
Defined
RequireRealField
smallint
Indicates if a field must be associated with a toolkit control or widget (RW)
Defined
Script
StringObject
Contains the 4GL script associated with the field (RW)
FieldObject
ToolTipText
varchar(100)
Specifies the text to be displayed when the mouse pointer rests on the FormField (RW)
Defined
UpdateBias
smallint
Specifies a field's bias setting when the CurMode attribute for the frame is set to FM_UPDATE (RW)
Defined
User1Bias
smallint
Specifies a field's bias setting when the CurMode attribute for the frame is set to FM_USER1 (RW)
Defined
User2Bias
smallint
Specifies a field's bias setting when the CurMode attribute for the frame is set to FM_USER2 (RW)
Defined
User3Bias
smallint
Specifies a field's bias setting when the CurMode attribute for the frame is set to FM_USER3 (RW)
Defined
Width
integer
Specifies the X extent of the “inner rectangle” of the field, excluding border lines or shadows (RW)
Defined
XAnchorPoint
integer
Use with YAnchorPoint to position an object by setting relevant anchor point values (RW)
Defined
XLeft
integer
Specifies the relative X coordinate of the left edge of a field's bounding rectangle (RW)
Defined
XRight
integer
Specifies the relative X coordinate of the right edge of a field's bounding rectangle (RW)
Defined
YAnchorPoint
integer
Use with XAnchorPoint to position an object by setting relevant anchor point values (RW)
Defined
YBottom
integer
Specifies the relative Y coordinate of the lower edge of a field's bounding rectangle (RW)
Defined
YTop
integer
Specifies the relative Y coordinate of the top edge of a field's bounding rectangle (RW)
Defined
 
FormField Methods
Method
Return
Value
Description
Inherited From
Duplicate()
FormField
Makes a duplicate of the object, placing a reference to the new object in a reference variable
Object
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
UpdBackground()
none
Changes a field's background
Defined
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